GenParticleProducer Class Reference

Inheritance diagram for GenParticleProducer:

Public Member Functions
bool	convertParticle (reco::GenParticle &cand, const HepMC::GenParticle *part, const IDto3Charge &id2Charge) const
bool	fillDaughters (reco::GenParticleCollection &cand, const HepMC::GenParticle *part, reco::GenParticleRefProd const &ref, size_t index, std::unordered_map< int, size_t > &barcodes) const
bool	fillIndices (const HepMC::GenEvent *mc, std::vector< const HepMC::GenParticle * > &particles, std::vector< int > &barCodeVector, int offset, std::unordered_map< int, size_t > &barcodes) const
	GenParticleProducer (const edm::ParameterSet &)
	constructor More...
std::shared_ptr< IDto3Charge >	globalBeginRun (const edm::Run &, const edm::EventSetup &) const override
void	globalEndRun (edm::Run const &, edm::EventSetup const &) const override
void	produce (edm::StreamID, edm::Event &e, const edm::EventSetup &) const override
	process one event More...
	~GenParticleProducer () override
	destructor More...
Public Member Functions inherited from edm::global::EDProducer< edm::RunCache< IDto3Charge > >
	EDProducer ()=default
bool	hasAbilityToProduceInLumis () const final
bool	hasAbilityToProduceInRuns () const final
bool	wantsGlobalLuminosityBlocks () const final
bool	wantsGlobalRuns () const final
bool	wantsStreamLuminosityBlocks () const final
bool	wantsStreamRuns () const final
Public Member Functions inherited from edm::global::EDProducerBase
	EDProducerBase ()
ModuleDescription const &	moduleDescription () const
	~EDProducerBase () override
Public Member Functions inherited from edm::ProducerBase
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)
std::vector< edm::ProductResolverIndex > const &	indiciesForPutProducts (BranchType iBranchType) const
	ProducerBase ()
std::vector< edm::ProductResolverIndex > const &	putTokenIndexToProductResolverIndex () const
void	registerProducts (ProducerBase *, ProductRegistry *, ModuleDescription const &)
std::function< void(BranchDescription const &)>	registrationCallback () const
	used by the fwk to register list of products More...
void	resolvePutIndicies (BranchType iBranchType, ModuleToResolverIndicies const &iIndicies, std::string const &moduleLabel)
	~ProducerBase () noexcept(false) override
Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfo >	consumesInfo () const
void	convertCurrentProcessAlias (std::string const &processName)
	Convert "@currentProcess" in InputTag process names to the actual current process name. More...
	EDConsumerBase ()
	EDConsumerBase (EDConsumerBase const &)=delete
	EDConsumerBase (EDConsumerBase &&)=default
ESProxyIndex const *	esGetTokenIndices (edm::Transition iTrans) const
ProductResolverIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const
void	itemsMayGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const
void	itemsToGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const
std::vector< ProductResolverIndexAndSkipBit > const &	itemsToGetFrom (BranchType iType) const
void	labelsForToken (EDGetToken iToken, Labels &oLabels) const
void	modulesWhoseProductsAreConsumed (std::vector< ModuleDescription const * > &modules, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const
EDConsumerBase const &	operator= (EDConsumerBase const &)=delete
EDConsumerBase &	operator= (EDConsumerBase &&)=default
bool	registeredToConsume (ProductResolverIndex, bool, BranchType) const
bool	registeredToConsumeMany (TypeID const &, BranchType) const
ProductResolverIndexAndSkipBit	uncheckedIndexFrom (EDGetToken) const
void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)
void	updateLookup (eventsetup::ESRecordsToProxyIndices const &)
virtual	~EDConsumerBase () noexcept(false)

Private Attributes
bool	abortOnUnknownPDGCode_
	unknown code treatment flag More...
bool	doSubEvent_
	input & output modes More...
MCTruthHelper< HepMC::GenParticle >	mcTruthHelper_
MCTruthHelper< reco::GenParticle >	mcTruthHelperGenParts_
edm::EDGetTokenT< CrossingFrame< edm::HepMCProduct > >	mixToken_
bool	saveBarCodes_
	save bar-codes More...
edm::EDGetTokenT< edm::HepMCProduct >	srcToken_
	source collection name More...
bool	useCF_
std::vector< edm::EDGetTokenT< edm::HepMCProduct > >	vectorSrcTokens_

Additional Inherited Members
Public Types inherited from edm::global::EDProducerBase
typedef EDProducerBase	ModuleType
Public Types inherited from edm::ProducerBase
using	ModuleToResolverIndicies = std::unordered_multimap< std::string, std::tuple< edm::TypeID const *, const char *, edm::ProductResolverIndex >>
typedef ProductRegistryHelper::TypeLabelList	TypeLabelList
Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels
Static Public Member Functions inherited from edm::global::EDProducerBase
static const std::string &	baseType ()
static void	fillDescriptions (ConfigurationDescriptions &descriptions)
static void	prevalidate (ConfigurationDescriptions &descriptions)
Protected Member Functions inherited from edm::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)
EDGetToken	consumes (const TypeToGet &id, edm::InputTag const &tag)
template<BranchType B>
EDGetToken	consumes (TypeToGet const &id, edm::InputTag const &tag)
ConsumesCollector	consumesCollector ()
	Use a ConsumesCollector to gather consumes information from helper functions. More...
template<typename ProductType , BranchType B = InEvent>
void	consumesMany ()
void	consumesMany (const TypeToGet &id)
template<BranchType B>
void	consumesMany (const TypeToGet &id)
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes ()
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag const &tag)
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	mayConsume (edm::InputTag const &tag)
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)
template<BranchType B>
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

Detailed Description

Definition at line 79 of file GenParticleProducer.cc.

Constructor & Destructor Documentation

GenParticleProducer::GenParticleProducer

(

const edm::ParameterSet &

cfg

)

constructor

Definition at line 138 of file GenParticleProducer.cc.

References egammaCTFFinalFitWithMaterial_cff::alias, edm::ParameterSet::getParameter(), mixToken_, saveBarCodes_, srcToken_, AlCaHLTBitMon_QueryRunRegistry::string, and useCF_.

                                                                   :
  abortOnUnknownPDGCode_( cfg.getUntrackedParameter<bool>( "abortOnUnknownPDGCode", true ) ),
  saveBarCodes_( cfg.getUntrackedParameter<bool>( "saveBarCodes", false ) ),
  doSubEvent_(cfg.getUntrackedParameter<bool>( "doSubEvent", false )),
  useCF_(cfg.getUntrackedParameter<bool>( "useCrossingFrame", false ))
{
  produces<GenParticleCollection>();
  produces<math::XYZPointF>("xyz0");
  produces<float>("t0");
  if( saveBarCodes_ ) {
    std::string alias( cfg.getParameter<std::string>( "@module_label" ) );
    produces<vector<int> >().setBranchAlias( alias + "BarCodes" );
  }

  if(useCF_) mixToken_ = mayConsume<CrossingFrame<HepMCProduct> >(InputTag(cfg.getParameter<std::string>( "mix" ),"generatorSmeared"));
  else srcToken_ = mayConsume<HepMCProduct>(cfg.getParameter<InputTag>( "src" ));
}

GenParticleProducer::~GenParticleProducer ( )

override

destructor

Definition at line 156 of file GenParticleProducer.cc.

                                          {
}

Member Function Documentation

bool GenParticleProducer::convertParticle	(	reco::GenParticle &	cand,
		const HepMC::GenParticle *	part,
		const IDto3Charge &	id2Charge
	)		const

Definition at line 297 of file GenParticleProducer.cc.

References MCTruthHelper< P >::fillGenStatusFlags(), mcTruthHelper_, mmToCm, p4, common_cff::pdgId, reco::GenParticle::setCollisionId(), reco::LeafCandidate::setP4(), reco::LeafCandidate::setPdgId(), reco::LeafCandidate::setStatus(), reco::LeafCandidate::setThreeCharge(), reco::LeafCandidate::setVertex(), reco::GenParticle::statusFlags(), findQualityFiles::v, and badGlobalMuonTaggersAOD_cff::vtx.

Referenced by produce().

                                                                                                                                  {
   Candidate::LorentzVector p4( part->momentum() );
   int pdgId = part->pdg_id();
   cand.setThreeCharge( id2Charge.chargeTimesThree( pdgId ) );
   cand.setPdgId( pdgId );
   cand.setStatus( part->status() );
   cand.setP4( p4 );
   cand.setCollisionId(0);
   const GenVertex * v = part->production_vertex();
   if ( v != nullptr ) {
      ThreeVector vtx = v->point3d();
      Candidate::Point vertex( vtx.x() * mmToCm, vtx.y() * mmToCm, vtx.z() * mmToCm );
      cand.setVertex( vertex );
   } else {
      cand.setVertex( Candidate::Point( 0, 0, 0 ) );
   }
   mcTruthHelper_.fillGenStatusFlags(*part, cand.statusFlags());
   return true;
}

bool GenParticleProducer::fillDaughters	(	reco::GenParticleCollection &	cand,
		const HepMC::GenParticle *	part,
		reco::GenParticleRefProd const &	ref,
		size_t	index,
		std::unordered_map< int, size_t > &	barcodes
	)		const

Definition at line 317 of file GenParticleProducer.cc.

References GenParticle::GenParticle, funct::m, and edm::second().

Referenced by produce().

                                                                                                                                                                                                       {

   const GenVertex * productionVertex = part->production_vertex();
   size_t numberOfMothers = productionVertex->particles_in_size();
   if ( numberOfMothers > 0 ) {
      GenVertex::particles_in_const_iterator motherIt = productionVertex->particles_in_const_begin();
      for( ; motherIt != productionVertex->particles_in_const_end(); motherIt++) {
     const HepMC::GenParticle * mother = * motherIt;
     size_t m = barcodes.find( mother->barcode() )->second;
     cands[ m ].addDaughter( GenParticleRef( ref, index ) );
     cands[ index ].addMother( GenParticleRef( ref, m ) );
      }
   }

   return true;
}

bool GenParticleProducer::fillIndices	(	const HepMC::GenEvent *	mc,
		std::vector< const HepMC::GenParticle * > &	particles,
		std::vector< int > &	barCodeVector,
		int	offset,
		std::unordered_map< int, size_t > &	barcodes
	)		const

Definition at line 334 of file GenParticleProducer.cc.

References begin, DEFINE_FWK_MODULE, end, GenParticle::GenParticle, training_settings::idx, PFRecoTauDiscriminationByIsolation_cfi::offset, and AlCaHLTBitMon_ParallelJobs::p.

Referenced by produce().

                                                                                                                                                                                                 {
   size_t idx = offset;
   HepMC::GenEvent::particle_const_iterator begin = mc->particles_begin(), end = mc->particles_end();
   for( HepMC::GenEvent::particle_const_iterator p = begin; p != end; ++ p ) {
      const HepMC::GenParticle * particle = * p;
      size_t barCode_this_event = particle->barcode();
      size_t barCode = barCode_this_event + offset;
      if( barcodes.find(barCode) != barcodes.end() )
     throw cms::Exception( "WrongReference" )
        << "barcodes are duplicated! " << endl;
      particles[idx] = particle;
      barCodeVector[idx] = barCode;
      barcodes.insert( make_pair(barCode_this_event, idx ++) );
   }
      return true;
}

std::shared_ptr< IDto3Charge > GenParticleProducer::globalBeginRun ( const edm::Run &  , const edm::EventSetup &  es  ) const

override

Definition at line 159 of file GenParticleProducer.cc.

References abortOnUnknownPDGCode_, and edm::EventSetup::getData().

                                                                                                    {
  ESHandle<HepPDT::ParticleDataTable> pdt;
  es.getData( pdt );
  return std::make_shared<IDto3Charge>(*pdt, abortOnUnknownPDGCode_);
}

void GenParticleProducer::globalEndRun ( edm::Run const &  , edm::EventSetup const &    ) const

inlineoverride

Definition at line 89 of file GenParticleProducer.cc.

References GenParticle::GenParticle, CaloTowersParam_cfi::mc, PFRecoTauDiscriminationByIsolation_cfi::offset, and HadronAndPartonSelector_cfi::particles.

{};

void GenParticleProducer::produce ( edm::StreamID  , edm::Event &  e, const edm::EventSetup &  es  ) const

override

process one event

fill indices

Definition at line 165 of file GenParticleProducer.cc.

References egammaForCoreTracking_cff::cands, convertParticle(), edmIntegrityCheck::d, doSubEvent_, Exception, f, fillDaughters(), fillIndices(), GenParticle::GenParticle, edm::Event::getByToken(), edm::HepMCProduct::GetEvent(), MixCollection< T >::getObject(), edm::Event::getRefBeforePut(), edm::Event::getRun(), mps_fire::i, edm::RefProd< C >::id(), edm::Run::index(), edm::errors::InvalidReference, LogDebug, CaloTowersParam_cfi::mc, mixToken_, mmToCm, mmToNs, eostools::move(), PFRecoTauDiscriminationByIsolation_cfi::offset, HadronAndPartonSelector_cfi::particles, position, edm::Handle< T >::product(), edm::Event::put(), reco::CompositeRefCandidateT< D >::resetDaughters(), saveBarCodes_, MixCollection< T >::size(), findQualityFiles::size, srcToken_, and useCF_.

                                                                                    {

   std::unordered_map<int, size_t> barcodes;

   size_t totalSize = 0;
   const GenEvent * mc = nullptr;
   MixCollection<HepMCProduct>* cfhepmcprod = nullptr;
   size_t npiles = 1;

   if(useCF_){
      Handle<CrossingFrame<HepMCProduct> > cf;
      evt.getByToken(mixToken_,cf);
      cfhepmcprod = new MixCollection<HepMCProduct>(cf.product());
      npiles = cfhepmcprod->size();
      LogDebug("GenParticleProducer")<<"npiles : "<<npiles<<endl;
      for(unsigned int icf = 0; icf < npiles; ++icf){
     LogDebug("GenParticleProducer")<<"subSize : "<<cfhepmcprod->getObject(icf).GetEvent()->particles_size()<<endl;
     totalSize += cfhepmcprod->getObject(icf).GetEvent()->particles_size();
      }
      LogDebug("GenParticleProducer")<<"totalSize : "<<totalSize<<endl;
   }else{
      Handle<HepMCProduct> mcp;
      evt.getByToken( srcToken_, mcp );
      mc = mcp->GetEvent();
      if( mc == nullptr )
     throw edm::Exception( edm::errors::InvalidReference )
        << "HepMC has null pointer to GenEvent" << endl;
      totalSize  = mc->particles_size();
   }

   // initialise containers
   const size_t size = totalSize;
  vector<const HepMC::GenParticle *> particles( size );
  auto candsPtr = std::make_unique<GenParticleCollection>(size);
  auto barCodeVector = std::make_unique<vector<int>>(size);
  std::unique_ptr<math::XYZPointF> xyz0Ptr(new math::XYZPointF(0.,0.,0.));
  std::unique_ptr<float> t0Ptr(new float(0.f));
  reco::GenParticleRefProd ref = evt.getRefBeforePut<GenParticleCollection>();
  GenParticleCollection & cands = * candsPtr;
  size_t offset = 0;
  size_t suboffset = 0;

  IDto3Charge const& id2Charge = *runCache(evt.getRun().index());
  if(doSubEvent_ || useCF_){
     for(size_t ipile = 0; ipile < npiles; ++ipile){
    LogDebug("GenParticleProducer")<<"mixed object ipile : "<<ipile<<endl;
    barcodes.clear();
    if(useCF_) mc = cfhepmcprod->getObject(ipile).GetEvent();

    //Look whether heavy ion/signal event
    bool isHI = false;
    const HepMC::HeavyIon * hi = mc->heavy_ion();
    if(hi && hi->Ncoll_hard() > 1) isHI = true;
    size_t num_particles = mc->particles_size();
    LogDebug("GenParticleProducer")<<"num_particles : "<<num_particles<<endl;
        if (ipile == 0) {
            auto origin = (*mc->vertices_begin())->position();
            xyz0Ptr->SetXYZ(origin.x() * mmToCm, origin.y() * mmToCm, origin.z() * mmToCm);
            *t0Ptr = origin.t() * mmToNs;
        }
    fillIndices(mc, particles, *barCodeVector, offset,barcodes);
    // fill output collection and save association
    for( size_t ipar = offset; ipar < offset + num_particles; ++ ipar ) {
       const HepMC::GenParticle * part = particles[ ipar ];
       reco::GenParticle & cand = cands[ ipar ];
       // convert HepMC::GenParticle to new reco::GenParticle
       convertParticle(cand, part,id2Charge);
       cand.resetDaughters( ref.id() );
    }

    for( size_t d = offset; d < offset + num_particles; ++ d ) {
       const HepMC::GenParticle * part = particles[ d ];
       const GenVertex * productionVertex = part->production_vertex();
       int sub_id = 0;
       if ( productionVertex != nullptr ) {
          sub_id = productionVertex->id();
          if(!isHI) sub_id = 0;
          // search barcode map and attach daughters
          fillDaughters(cands,part,ref,d,barcodes);
       }else{
          const GenVertex * endVertex = part->end_vertex();
          if(endVertex != nullptr) sub_id = endVertex->id();
          else throw cms::Exception( "SubEventID" )<<"SubEvent not determined. Particle has no production and no end vertex!"<<endl;
       }
       if(sub_id < 0) sub_id = 0;
       int new_id = sub_id + suboffset;
       GenParticleRef dref( ref, d );
       cands[d].setCollisionId(new_id); // For new GenParticle
       LogDebug("VertexId")<<"SubEvent offset 3 : "<<suboffset;
    }
    int nsub = -2;
    if(isHI){
       nsub = hi->Ncoll_hard()+1;
       suboffset += nsub;
    }else{
       suboffset += 1;
    }
    offset += num_particles;
     }
  }else{
     auto origin = (*mc->vertices_begin())->position();
     xyz0Ptr->SetXYZ(origin.x() * mmToCm, origin.y() * mmToCm, origin.z() * mmToCm);
     *t0Ptr = origin.t() * mmToNs;
     fillIndices(mc, particles, *barCodeVector, 0,barcodes);

     // fill output collection and save association
     for( size_t i = 0; i < particles.size(); ++ i ) {
    const HepMC::GenParticle * part = particles[ i ];
    reco::GenParticle & cand = cands[ i ];
    // convert HepMC::GenParticle to new reco::GenParticle
    convertParticle(cand, part,id2Charge);
    cand.resetDaughters( ref.id() );
     }

     // fill references to daughters
     for( size_t d = 0; d < cands.size(); ++ d ) {
    const HepMC::GenParticle * part = particles[ d ];
    const GenVertex * productionVertex = part->production_vertex();
    // search barcode map and attach daughters
    if ( productionVertex != nullptr ) fillDaughters(cands,part,ref,d,barcodes);
    cands[d].setCollisionId(0);
     }
  }
  
  evt.put(std::move(candsPtr));
  if(saveBarCodes_) evt.put(std::move(barCodeVector));
  if(cfhepmcprod) delete cfhepmcprod;
  evt.put(std::move(xyz0Ptr),"xyz0");
  evt.put(std::move(t0Ptr),"t0");
}

Member Data Documentation

bool GenParticleProducer::abortOnUnknownPDGCode_

private

unknown code treatment flag

Definition at line 102 of file GenParticleProducer.cc.

Referenced by globalBeginRun().

bool GenParticleProducer::doSubEvent_

private

input & output modes

Definition at line 107 of file GenParticleProducer.cc.

Referenced by produce().

MCTruthHelper<HepMC::GenParticle> GenParticleProducer::mcTruthHelper_

private

Definition at line 110 of file GenParticleProducer.cc.

Referenced by convertParticle().

MCTruthHelper<reco::GenParticle> GenParticleProducer::mcTruthHelperGenParts_

private

Definition at line 111 of file GenParticleProducer.cc.

edm::EDGetTokenT<CrossingFrame<edm::HepMCProduct> > GenParticleProducer::mixToken_

private

Definition at line 99 of file GenParticleProducer.cc.

Referenced by GenParticleProducer(), and produce().

bool GenParticleProducer::saveBarCodes_

private

save bar-codes

Definition at line 104 of file GenParticleProducer.cc.

Referenced by GenParticleProducer(), and produce().

edm::EDGetTokenT<edm::HepMCProduct> GenParticleProducer::srcToken_

private

source collection name

Definition at line 97 of file GenParticleProducer.cc.

Referenced by GenParticleProducer(), and produce().

bool GenParticleProducer::useCF_

private

Definition at line 108 of file GenParticleProducer.cc.

Referenced by GenParticleProducer(), and produce().

std::vector<edm::EDGetTokenT<edm::HepMCProduct> > GenParticleProducer::vectorSrcTokens_

private

Definition at line 98 of file GenParticleProducer.cc.