#include <SimTracker/TrackAssociatorProducers/plugins/QuickTrackAssociatorByHitsProducer.cc>

Inheritance diagram for QuickTrackAssociatorByHitsProducer:

Public Member Functions
	QuickTrackAssociatorByHitsProducer (const edm::ParameterSet &)

	~QuickTrackAssociatorByHitsProducer () override

Public Member Functions inherited from edm::global::EDProducer<>
	EDProducer ()=default

	EDProducer (const EDProducer &)=delete

bool	hasAbilityToProduceInBeginLumis () const final

bool	hasAbilityToProduceInBeginProcessBlocks () const final

bool	hasAbilityToProduceInBeginRuns () const final

bool	hasAbilityToProduceInEndLumis () const final

bool	hasAbilityToProduceInEndProcessBlocks () const final

bool	hasAbilityToProduceInEndRuns () const final

EDProducer &	operator= (const EDProducer &)=delete

bool	wantsGlobalLuminosityBlocks () const final

bool	wantsGlobalRuns () const final

bool	wantsInputProcessBlocks () const final

bool	wantsProcessBlocks () 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

std::vector< bool > const &	recordProvenanceList () 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)

TypeLabelList const &	typeLabelList () const
	used by the fwk to register the list of products of this module More...

	~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 &&)=default

	EDConsumerBase (EDConsumerBase const &)=delete

ESProxyIndex const *	esGetTokenIndices (edm::Transition iTrans) const

std::vector< ESProxyIndex > const &	esGetTokenIndicesVector (edm::Transition iTrans) const

std::vector< ESRecordIndex > const &	esGetTokenRecordIndicesVector (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::array< std::vector< ModuleDescription const * > , NumBranchTypes > &modulesAll, std::vector< ModuleProcessName > &modulesInPreviousProcesses, ProductRegistry const &preg, std::map< std::string, ModuleDescription const > const &labelsToDesc, std::string const &processName) const

EDConsumerBase &	operator= (EDConsumerBase &&)=default

EDConsumerBase const &	operator= (EDConsumerBase const &)=delete

bool	registeredToConsume (ProductResolverIndex, bool, BranchType) const

bool	registeredToConsumeMany (TypeID const &, BranchType) const

void	selectInputProcessBlocks (ProductRegistry const &productRegistry, ProcessBlockHelperBase const &processBlockHelperBase)

ProductResolverIndexAndSkipBit	uncheckedIndexFrom (EDGetToken) const

void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)

void	updateLookup (eventsetup::ESRecordsToProxyIndices const &)

virtual	~EDConsumerBase () noexcept(false)

Static Public Member Functions
static void	fillDescriptions (edm::ConfigurationDescriptions &descriptions)

Static Public Member Functions inherited from edm::global::EDProducerBase
static const std::string &	baseType ()

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &descriptions)

Private Member Functions
void	beginJob () override

void	endJob () override

edm::ParameterSet	makeHitAssociatorParameters (const edm::ParameterSet &)

void	produce (edm::StreamID, edm::Event &, const edm::EventSetup &) const override

Private Attributes
bool	absoluteNumberOfHits_

edm::EDGetTokenT< ClusterTPAssociation >	cluster2TPToken_

double	cutRecoToSim_

double	pixelHitWeight_

double	puritySimToReco_

double	qualitySimToReco_

QuickTrackAssociatorByHitsImpl::SimToRecoDenomType	simToRecoDenominator_

bool	threeHitTracksAreSpecial_

TrackerHitAssociator::Config	trackerHitAssociatorConfig_

bool	useClusterTPAssociation_

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

Protected Member Functions inherited from edm::ProducerBase
template<class ProductType >
BranchAliasSetterT< ProductType >	produces ()
	declare what type of product will make and with which optional label More...

template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType >	produces ()

template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType >	produces ()

BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)

template<BranchType B>
BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)

template<Transition B>
BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)

template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType >	produces (std::string instanceName)

template<class ProductType >
BranchAliasSetterT< ProductType >	produces (std::string instanceName)

template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType >	produces (std::string instanceName)

ProducesCollector	producesCollector ()

Protected Member Functions inherited from edm::EDConsumerBase
EDGetToken	consumes (const TypeToGet &id, edm::InputTag const &tag)

template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)

template<BranchType B = InEvent>
EDConsumerBaseAdaptor< B >	consumes (edm::InputTag tag) noexcept

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<Transition Tr = Transition::Event>
constexpr auto	esConsumes () noexcept

template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag const &tag)

template<Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag tag) noexcept

template<Transition Tr = Transition::Event>
ESGetTokenGeneric	esConsumes (eventsetup::EventSetupRecordKey const &iRecord, eventsetup::DataKey const &iKey)
	Used with EventSetupRecord::doGet. More...

EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

template<BranchType B>
EDGetToken	mayConsume (const TypeToGet &id, edm::InputTag const &tag)

template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	mayConsume (edm::InputTag const &tag)

Detailed Description

Description: [one line class summary]

Implementation: [Notes on implementation]

Definition at line 41 of file QuickTrackAssociatorByHitsProducer.cc.

Constructor & Destructor Documentation

◆ QuickTrackAssociatorByHitsProducer()

QuickTrackAssociatorByHitsProducer::QuickTrackAssociatorByHitsProducer ( const edm::ParameterSet & iConfig )

explicit

Definition at line 78 of file QuickTrackAssociatorByHitsProducer.cc.

     : qualitySimToReco_(iConfig.getParameter<double>("Quality_SimToReco")),
       puritySimToReco_(iConfig.getParameter<double>("Purity_SimToReco")),
       pixelHitWeight_(iConfig.getParameter<double>("PixelHitWeight")),
       cutRecoToSim_(iConfig.getParameter<double>("Cut_RecoToSim")),
       threeHitTracksAreSpecial_(iConfig.getParameter<bool>("ThreeHitTracksAreSpecial")),
       useClusterTPAssociation_(iConfig.getParameter<bool>("useClusterTPAssociation")),
       absoluteNumberOfHits_(iConfig.getParameter<bool>("AbsoluteNumberOfHits")) {
   //
   // Check whether the denominator when working out the percentage of shared hits should
   // be the number of simulated hits or the number of reconstructed hits.
   //
   std::string denominatorString = iConfig.getParameter<std::string>("SimToRecoDenominator");
   if (denominatorString == "sim")
     simToRecoDenominator_ = QuickTrackAssociatorByHitsImpl::denomsim;
   else if (denominatorString == "reco")
     simToRecoDenominator_ = QuickTrackAssociatorByHitsImpl::denomreco;
   else
     throw cms::Exception("QuickTrackAssociatorByHitsImpl") << "SimToRecoDenominator not specified as sim or reco";
  
   //
   // Do some checks on whether UseGrouped or UseSplitting have been set. They're not used
   // unlike the standard TrackAssociatorByHits so show a warning.
   //
   bool useGrouped, useSplitting;
   if (iConfig.exists("UseGrouped"))
     useGrouped = iConfig.getParameter<bool>("UseGrouped");
   else
     useGrouped = true;
  
   if (iConfig.exists("UseSplitting"))
     useSplitting = iConfig.getParameter<bool>("UseSplitting");
   else
     useSplitting = true;
  
   // This associator works as though both UseGrouped and UseSplitting were set to true, so show a
   // warning if this isn't the case.
   if (!(useGrouped && useSplitting)) {
     LogDebug("QuickTrackAssociatorByHitsImpl")
         << "UseGrouped and/or UseSplitting has been set to false, but this associator ignores that setting.";
   }
  
   //register your products
   produces<reco::TrackToTrackingParticleAssociator>();
  
   if (useClusterTPAssociation_) {
     cluster2TPToken_ = consumes<ClusterTPAssociation>(iConfig.getParameter<edm::InputTag>("cluster2TPSrc"));
   } else {
     trackerHitAssociatorConfig_ =
         TrackerHitAssociator::Config(makeHitAssociatorParameters(iConfig), consumesCollector());
   }
 }

References cluster2TPToken_, helper::Config, edm::EDConsumerBase::consumesCollector(), QuickTrackAssociatorByHitsImpl::denomreco, QuickTrackAssociatorByHitsImpl::denomsim, Exception, edm::ParameterSet::exists(), edm::ParameterSet::getParameter(), LogDebug, makeHitAssociatorParameters(), simToRecoDenominator_, AlCaHLTBitMon_QueryRunRegistry::string, trackerHitAssociatorConfig_, and useClusterTPAssociation_.

◆ ~QuickTrackAssociatorByHitsProducer()

QuickTrackAssociatorByHitsProducer::~QuickTrackAssociatorByHitsProducer ( )

override

Definition at line 131 of file QuickTrackAssociatorByHitsProducer.cc.

                                                                         {
   // do anything here that needs to be done at desctruction time
   // (e.g. close files, deallocate resources etc.)
 }

Member Function Documentation

◆ beginJob()

void QuickTrackAssociatorByHitsProducer::beginJob ( void )

overrideprivatevirtual

Reimplemented from edm::global::EDProducerBase.

Definition at line 192 of file QuickTrackAssociatorByHitsProducer.cc.

192 {}

◆ endJob()

void QuickTrackAssociatorByHitsProducer::endJob ( void )

overrideprivatevirtual

Reimplemented from edm::global::EDProducerBase.

Definition at line 195 of file QuickTrackAssociatorByHitsProducer.cc.

195 {}

◆ fillDescriptions()

void QuickTrackAssociatorByHitsProducer::fillDescriptions ( edm::ConfigurationDescriptions & descriptions )

static

Definition at line 198 of file QuickTrackAssociatorByHitsProducer.cc.

                                                                                                     {
   //The following says we do not know what parameters are allowed so do no validation
   // Please change this to state exactly what you do use, even if it is no parameters
   edm::ParameterSetDescription desc;
   desc.setUnknown();
   descriptions.addDefault(desc);
 }

References edm::ConfigurationDescriptions::addDefault(), and submitPVResolutionJobs::desc.

◆ makeHitAssociatorParameters()

edm::ParameterSet QuickTrackAssociatorByHitsProducer::makeHitAssociatorParameters ( const edm::ParameterSet & iConfig )

private

Definition at line 141 of file QuickTrackAssociatorByHitsProducer.cc.

                                                                                                               {
   edm::ParameterSet hitAssociatorParameters;
   hitAssociatorParameters.addParameter<bool>("associatePixel", iConfig.getParameter<bool>("associatePixel"));
   hitAssociatorParameters.addParameter<bool>("associateStrip", iConfig.getParameter<bool>("associateStrip"));
   // This is the important one, it stops the hit associator searching through the list of sim hits.
   // I only want to use the hit associator methods that work on the hit IDs (i.e. the uint32_t trackId
   // and the EncodedEventId eventId) so I'm not interested in matching that to the PSimHit objects.
   hitAssociatorParameters.addParameter<bool>("associateRecoTracks", true);
   // add these new ones to allow redirection of inputs:
   hitAssociatorParameters.addParameter<edm::InputTag>("pixelSimLinkSrc",
                                                       iConfig.getParameter<edm::InputTag>("pixelSimLinkSrc"));
   hitAssociatorParameters.addParameter<edm::InputTag>("stripSimLinkSrc",
                                                       iConfig.getParameter<edm::InputTag>("stripSimLinkSrc"));
  
   return hitAssociatorParameters;
 }

References edm::ParameterSet::addParameter(), and edm::ParameterSet::getParameter().

Referenced by QuickTrackAssociatorByHitsProducer().

◆ produce()

void QuickTrackAssociatorByHitsProducer::produce	(	edm::StreamID	,
		edm::Event &	iEvent,
		const edm::EventSetup &	iSetup
	)		const

overrideprivatevirtual

Implements edm::global::EDProducerBase.

Definition at line 159 of file QuickTrackAssociatorByHitsProducer.cc.

                                                                                     {
   using namespace edm;
  
   const ClusterTPAssociation* clusterAssoc = nullptr;
   std::unique_ptr<TrackerHitAssociator> trackAssoc;
   if (useClusterTPAssociation_) {
     edm::Handle<ClusterTPAssociation> clusterAssocHandle;
     iEvent.getByToken(cluster2TPToken_, clusterAssocHandle);
     clusterAssoc = clusterAssocHandle.product();
   } else {
     // If control got this far then either useClusterTPAssociation_ was false or getting the cluster
     // to TrackingParticle association from the event failed. Either way I need to create a hit associator.
     trackAssoc = std::make_unique<TrackerHitAssociator>(iEvent, trackerHitAssociatorConfig_);
   }
  
   auto impl = std::make_unique<QuickTrackAssociatorByHitsImpl>(iEvent.productGetter(),
                                                                std::move(trackAssoc),
                                                                clusterAssoc,
                                                                absoluteNumberOfHits_,
                                                                qualitySimToReco_,
                                                                puritySimToReco_,
                                                                pixelHitWeight_,
                                                                cutRecoToSim_,
                                                                threeHitTracksAreSpecial_,
                                                                simToRecoDenominator_);
  
   auto toPut = std::make_unique<reco::TrackToTrackingParticleAssociator>(std::move(impl));
   iEvent.put(std::move(toPut));
 }