Plugin to create the MC truth for TTStubs. More...

#include <TTStubAssociator.h>

Inheritance diagram for TTStubAssociator< T >:

Public Member Functions
	TTStubAssociator (const edm::ParameterSet &iConfig)
	Constructors. More...

	~TTStubAssociator () override
	Destructor. More...

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

Public Member Functions inherited from edm::stream::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)

virtual	~ProducerBase () noexcept(false)

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

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)

virtual	~EDConsumerBase () noexcept(false)

Private Member Functions
void	beginRun (const edm::Run &run, const edm::EventSetup &iSetup) override
	Mandatory methods. More...

void	endRun (const edm::Run &run, const edm::EventSetup &iSetup) override
	End run. More...

template<>
void	produce (edm::Event &iEvent, const edm::EventSetup &iSetup)

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

template<>
void	produce (edm::Event &iEvent, const edm::EventSetup &iSetup)
	Implement the producer. More...

Private Attributes
edm::ESHandle< TrackerGeometry >	theTrackerGeometry

edm::ESHandle< TrackerTopology >	theTrackerTopology

std::vector< edm::InputTag >	TTClusterTruthInputTags

std::vector< edm::EDGetTokenT< TTClusterAssociationMap< T > > >	TTClusterTruthTokens

std::vector< edm::InputTag >	TTStubsInputTags
	Data members. More...

std::vector< edm::EDGetTokenT< edmNew::DetSetVector< TTStub< T > > > >	TTStubsTokens

Additional Inherited Members
Public Types inherited from edm::stream::EDProducer<>
typedef CacheContexts< T... >	CacheTypes

typedef CacheTypes::GlobalCache	GlobalCache

typedef AbilityChecker< T... >	HasAbility

typedef CacheTypes::LuminosityBlockCache	LuminosityBlockCache

typedef LuminosityBlockContextT< LuminosityBlockCache, RunCache, GlobalCache >	LuminosityBlockContext

typedef CacheTypes::LuminosityBlockSummaryCache	LuminosityBlockSummaryCache

typedef CacheTypes::RunCache	RunCache

typedef RunContextT< RunCache, GlobalCache >	RunContext

typedef CacheTypes::RunSummaryCache	RunSummaryCache

Public Types inherited from edm::stream::EDProducerBase
typedef EDProducerAdaptorBase	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::stream::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 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

template<typename T>
class TTStubAssociator< T >

Plugin to create the MC truth for TTStubs.

After moving from SimDataFormats to DataFormats, the template structure of the class was maintained in order to accomodate any types other than PixelDigis in case there is such a need in the future.

Author: Nicola Pozzobon

Date: 2013, Jul 19

Definition at line 44 of file TTStubAssociator.h.

Constructor & Destructor Documentation

template<typename T >

TTStubAssociator< T >::TTStubAssociator ( const edm::ParameterSet & iConfig )

explicit

Constructors.

Close class.

NOTE since pattern hit correlation must be performed within a stacked module, one must store Clusters in a proper way, providing easy access to them in a detector/member-wise way

Implementation of methods

Here, in the header file, the methods which do not depend on the specific type <T> that can fit the template. Other methods, with type-specific features, are implemented in the source file.Constructors

Definition at line 82 of file TTStubAssociator.h.

References edm::EDConsumerBase::consumes(), edm::ParameterSet::getParameter(), TTStubAssociator< T >::TTClusterTruthInputTags, TTStubAssociator< T >::TTClusterTruthTokens, TTStubAssociator< T >::TTStubsInputTags, and TTStubAssociator< T >::TTStubsTokens.

 {
   TTStubsInputTags = iConfig.getParameter< std::vector< edm::InputTag > >( "TTStubs" );
   TTClusterTruthInputTags = iConfig.getParameter< std::vector< edm::InputTag > >( "TTClusterTruth" );
 
 
   for ( auto iTag =  TTClusterTruthInputTags.begin(); iTag!=  TTClusterTruthInputTags.end(); iTag++ )
   {
     TTClusterTruthTokens.push_back(consumes< TTClusterAssociationMap< T > >(*iTag));
   }
 
   for ( auto iTag =  TTStubsInputTags.begin(); iTag!=  TTStubsInputTags.end(); iTag++ )
   {
     TTStubsTokens.push_back(consumes< edmNew::DetSetVector< TTStub< T > > >(*iTag));
 
     produces< TTStubAssociationMap< T > >( (*iTag).instance() );
   }
 }

template<typename T >

TTStubAssociator< T >::~TTStubAssociator ( )

override

Destructor.

Definition at line 103 of file TTStubAssociator.h.

103 {}

Member Function Documentation

template<typename T >

void TTStubAssociator< T >::beginRun	(	const edm::Run &	run,
		const edm::EventSetup &	iSetup
	)

overrideprivate

Mandatory methods.

Begin run.

Print some information when loaded

Definition at line 107 of file TTStubAssociator.h.

References edm::EventSetup::get(), TTStubAssociator< T >::theTrackerGeometry, and TTStubAssociator< T >::theTrackerTopology.

 {
   edm::LogInfo("TTStubAssociator< ") << templateNameFinder< T >() << " > loaded.";
 
   iSetup.get<TrackerTopologyRcd>().get(theTrackerTopology);
   iSetup.get<TrackerDigiGeometryRecord>().get(theTrackerGeometry);
 }

template<typename T >

void TTStubAssociator< T >::endRun	(	const edm::Run &	run,
		const edm::EventSetup &	iSetup
	)

overrideprivate

End run.

Definition at line 118 of file TTStubAssociator.h.

References iEvent, and TTStubAssociator< T >::produce().

118 {}

template<>

void TTStubAssociator< Ref_Phase2TrackerDigi_ >::produce	(	edm::Event &	iEvent,
		const edm::EventSetup &	iSetup
	)

private

Here, in the source file, the methods which do depend on the specific type <T> that can fit the template.

Author: Nicola Pozzobon

Date: 2013, Jul 19Implement the producer

Exit if real data

Exit if the vectors are uncorrectly dimensioned

Loop over the InputTags to handle multiple collections

Prepare output

Get the Stubs already stored away

Get the Cluster MC truth

Prepare the necessary maps

Loop over the input Stubs

Get the DetSets of the Clusters

Make the reference to be put in the map

Get the two clusters

Fill the inclusive map which is careless of the stub classification

Prepare the maps wrt TrackingParticle

Fill the auxiliary map

GENUINE for clusters means not combinatoric and not unknown: same MC truth content MUST be found in both clusters composing the stub

If at least one cluster is unknown, it means either unknown, either combinatoric Do nothing, and go to the next Stub

Here both are clusters are genuine/combinatoric If both clusters have some known SimTrack content they must be compared to each other

If both clusters are genuine, they must be associated to the same TrackingParticle in order to return a genuine stub. Period. Note we can perform safely this comparison because, if both clusters are genuine, their TrackingParticle shall NEVER be NULL

Two genuine clusters with same SimTrack content mean genuine

Fill the map: by construction, this will always be the first time the stub is inserted into the map: no need for "find"

At this point, go to the next Stub

It means combinatoric

End of two genuine clusters

Here, at least one cluster is combinatoric

Skip NULL pointers

Same SimTrack is present in both clusters

If two different SimTracks are found in both clusters, then the stub is for sure combinatoric

End of double loop over SimTracks of both clusters

If two different SimTracks are found in both clusters, go to the next stub

No SimTracks were found to be in both clusters

Only one SimTrack was found to be present in both clusters even if one of the clusters (or both) are combinatoric: this means there is only one track that participates in both clusters, hence the stub is genuine

Fill the map: by construction, this will always be the first time the stub is inserted into the map: no need for "find"

At this point, go to the next Stub

End of one single SimTrack in both clusters

End of "at least one cluster is combinatoric"

End of "both clusters are known, somehow..."

End of loop over Stubs

Clean the only map that needs cleaning Prepare the output map wrt TrackingParticle

Get the vector of references to TTStub

Sort and remove duplicates

Put the vector in the output map

Also, create the pointer to the TTClusterAssociationMap

Put the maps in the association object

Put output in the event

End of loop over InputTags

Definition at line 14 of file TTStubAssociator.cc.

References edmNew::DetSet< T >::begin(), TrackerGeometry::dets(), edmNew::DetSet< T >::end(), PhysicsTools::escape(), edm::Event::getByToken(), mps_fire::i, TrackerTopology::isLower(), edm::Ptr< T >::isNull(), edm::EventBase::isRealData(), gen::k, edmNew::makeRefTo(), eostools::move(), edm::Event::put(), TrackerTopology::stack(), DetId::subdetId(), StripSubdetector::TID, StripSubdetector::TOB, and tier0::unique().

 {
   if ( iEvent.isRealData() )
     return;
 
   if ( TTClusterTruthInputTags.size() != TTStubsInputTags.size() )
   {
     edm::LogError("TTStubAsso ") << "E R R O R! the InputTag vectors have different size!";
     return;
   }
 
   int ncont1=0;
 
   const TrackerGeometry* const theTrackerGeom = theTrackerGeometry.product();
   const TrackerTopology* const tTopo          = theTrackerTopology.product();
 
 
   for ( auto iTag =  TTStubsTokens.begin(); iTag!=  TTStubsTokens.end(); iTag++ )
   {
     auto associationMapForOutput      = std::make_unique<TTStubAssociationMap<Ref_Phase2TrackerDigi_>>();
 
     edm::Handle< edmNew::DetSetVector< TTStub< Ref_Phase2TrackerDigi_ > > > TTStubHandle;
     iEvent.getByToken( *iTag, TTStubHandle );
 
     edm::Handle< TTClusterAssociationMap< Ref_Phase2TrackerDigi_ > > TTClusterAssociationMapHandle;
     iEvent.getByToken( TTClusterTruthTokens.at(ncont1), TTClusterAssociationMapHandle );
 
     std::map< edm::Ref< edmNew::DetSetVector< TTStub< Ref_Phase2TrackerDigi_ > >, TTStub< Ref_Phase2TrackerDigi_ > >, edm::Ptr< TrackingParticle > >                stubToTrackingParticleMap;
     std::map< edm::Ptr< TrackingParticle >, std::vector< edm::Ref< edmNew::DetSetVector< TTStub< Ref_Phase2TrackerDigi_ > >, TTStub< Ref_Phase2TrackerDigi_ > > > > trackingParticleToStubVectorMap;
     stubToTrackingParticleMap.clear();
     trackingParticleToStubVectorMap.clear();
 
 
     if ( !TTStubHandle->empty() )
     {
     for (auto gd=theTrackerGeom->dets().begin(); gd != theTrackerGeom->dets().end(); gd++) 
     {
       DetId detid = (*gd)->geographicalId();
       if(detid.subdetId()!=StripSubdetector::TOB && detid.subdetId()!=StripSubdetector::TID ) continue; // only run on OT
 
       if(!tTopo->isLower(detid) ) continue; // loop on the stacks: choose the lower arbitrarily
 
       DetId stackDetid = tTopo->stack(detid); // Stub module detid
 
       if (TTStubHandle->find( stackDetid ) == TTStubHandle->end() ) continue;
 
       edmNew::DetSet< TTStub< Ref_Phase2TrackerDigi_ > > stubs = (*TTStubHandle)[ stackDetid ];
 
       for ( auto contentIter = stubs.begin();contentIter != stubs.end();++contentIter ) 
       {
         edm::Ref< edmNew::DetSetVector< TTStub< Ref_Phase2TrackerDigi_ > >, TTStub< Ref_Phase2TrackerDigi_ > > tempStubRef = edmNew::makeRefTo( TTStubHandle, contentIter );
 
     //        std::vector< edm::Ref< edmNew::DetSetVector< TTCluster< Ref_Phase2TrackerDigi_ > >, TTCluster< Ref_Phase2TrackerDigi_ > > > theseClusters = tempStubRef->getClusterRefs();
 
         for ( unsigned int ic = 0; ic < 2; ic++ )
         {
           std::vector< edm::Ptr< TrackingParticle > > tempTPs = TTClusterAssociationMapHandle->findTrackingParticlePtrs( tempStubRef->getClusterRef(ic) );
 
           for ( unsigned int itp = 0; itp < tempTPs.size(); itp++ )
           {
             edm::Ptr< TrackingParticle > testTP = tempTPs.at(itp);
 
             if ( testTP.isNull() )
               continue;
 
             if ( trackingParticleToStubVectorMap.find( testTP ) == trackingParticleToStubVectorMap.end() )
             {
               std::vector< edm::Ref< edmNew::DetSetVector< TTStub< Ref_Phase2TrackerDigi_ > >, TTStub< Ref_Phase2TrackerDigi_ > > > stubVector;
               stubVector.clear();
               trackingParticleToStubVectorMap.insert( std::make_pair( testTP, stubVector ) );
             }
             trackingParticleToStubVectorMap.find( testTP )->second.push_back( tempStubRef ); 
           }
         }
 
         if ( TTClusterAssociationMapHandle->isUnknown( tempStubRef->getClusterRef(0) ) ||
              TTClusterAssociationMapHandle->isUnknown( tempStubRef->getClusterRef(1) ) )
         {
           continue;
         }
         else
         {
           if ( TTClusterAssociationMapHandle->isGenuine( tempStubRef->getClusterRef(0) ) &&
                TTClusterAssociationMapHandle->isGenuine( tempStubRef->getClusterRef(1) ) )
           {
             if ( TTClusterAssociationMapHandle->findTrackingParticlePtr( tempStubRef->getClusterRef(0) ).get() ==
                  TTClusterAssociationMapHandle->findTrackingParticlePtr( tempStubRef->getClusterRef(1) ).get() )
             {
               edm::Ptr< TrackingParticle > testTP = TTClusterAssociationMapHandle->findTrackingParticlePtr( tempStubRef->getClusterRef(0) );
 
               stubToTrackingParticleMap.insert( std::make_pair( tempStubRef, testTP ) );
 
               continue;
             }
             else
             {
               continue;
             }
           } 
           else
           {
             TrackingParticle* prevTPAddress = nullptr;
             unsigned int whichTP = 0;
 
             std::vector< edm::Ptr< TrackingParticle > > trackingParticles0 = TTClusterAssociationMapHandle->findTrackingParticlePtrs( tempStubRef->getClusterRef(0) );
             std::vector< edm::Ptr< TrackingParticle > > trackingParticles1 = TTClusterAssociationMapHandle->findTrackingParticlePtrs( tempStubRef->getClusterRef(1) );
 
             bool escape = false;
 
             for ( unsigned int i = 0; i < trackingParticles0.size() && !escape; i++ )
             {
               if ( trackingParticles0.at(i).isNull() )
                 continue;
 
               for ( unsigned int k = 0; k < trackingParticles1.size() && !escape; k++ )
               {
                 if ( trackingParticles1.at(k).isNull() )
                   continue;
 
                 if ( trackingParticles0.at(i).get() == trackingParticles1.at(k).get() )
                 {
                   if ( prevTPAddress == nullptr )
                   {
                     prevTPAddress = const_cast< TrackingParticle* >(trackingParticles1.at(k).get());
                     whichTP = k;
                   }
 
                   if ( prevTPAddress != const_cast< TrackingParticle* >(trackingParticles1.at(k).get()) )
                   {
                     escape = true;
                     continue;
                   }
                 }
               }
             } 
 
             if ( escape )
               continue;
 
             if ( prevTPAddress == nullptr )
             {
               continue;
             }
             else
             {
               edm::Ptr< TrackingParticle > testTP = trackingParticles1.at(whichTP);
 
               stubToTrackingParticleMap.insert( std::make_pair( tempStubRef, testTP ) );
 
               continue;
             } 
           } 
         } 
       }
     } 
       
   }
 
     typename std::map< edm::Ptr< TrackingParticle >, std::vector< edm::Ref< edmNew::DetSetVector< TTStub< Ref_Phase2TrackerDigi_ > >, TTStub< Ref_Phase2TrackerDigi_ > > > >::iterator iterMapToClean;
     for ( iterMapToClean = trackingParticleToStubVectorMap.begin();
           iterMapToClean != trackingParticleToStubVectorMap.end();
           ++iterMapToClean )
     {
       std::vector< edm::Ref< edmNew::DetSetVector< TTStub< Ref_Phase2TrackerDigi_ > >, TTStub< Ref_Phase2TrackerDigi_ > > > tempVector = iterMapToClean->second;
 
       std::sort( tempVector.begin(), tempVector.end() );
       tempVector.erase( std::unique( tempVector.begin(), tempVector.end() ), tempVector.end() );
 
       iterMapToClean->second = tempVector;
     }
 
     edm::RefProd< TTClusterAssociationMap< Ref_Phase2TrackerDigi_ > > theCluAssoMap( TTClusterAssociationMapHandle ); 
 
     associationMapForOutput->setTTStubToTrackingParticleMap( stubToTrackingParticleMap );
     associationMapForOutput->setTrackingParticleToTTStubsMap( trackingParticleToStubVectorMap );
     associationMapForOutput->setTTClusterAssociationMap( theCluAssoMap );
 
     iEvent.put( std::move(associationMapForOutput), TTStubsInputTags.at(ncont1).instance() );
 
     ++ncont1;
   } 
 }