TTStubAssociator< T > Class Template Reference

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
	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
const EDProducer &	operator= (const EDProducer &)=delete

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::ESGetToken< TrackerGeometry, TrackerDigiGeometryRecord >	theTrackerGeometryToken_
edm::ESGetToken< TrackerTopology, TrackerTopologyRcd >	theTrackerTopologyToken_
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<>
using	CacheTypes = CacheContexts< T... >
using	GlobalCache = typename CacheTypes::GlobalCache
using	HasAbility = AbilityChecker< T... >
using	InputProcessBlockCache = typename CacheTypes::InputProcessBlockCache
using	LuminosityBlockCache = typename CacheTypes::LuminosityBlockCache
using	LuminosityBlockContext = LuminosityBlockContextT< LuminosityBlockCache, RunCache, GlobalCache >
using	LuminosityBlockSummaryCache = typename CacheTypes::LuminosityBlockSummaryCache
using	RunCache = typename CacheTypes::RunCache
using	RunContext = RunContextT< RunCache, GlobalCache >
using	RunSummaryCache = typename CacheTypes::RunSummaryCache

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 (tidy up: Ian Tomalin, 2020)

Definition at line 44 of file TTStubAssociator.h.

Constructor & Destructor Documentation

TTStubAssociator()

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 81 of file TTStubAssociator.h.

References deDxTools::esConsumes(), and edm::ParameterSet::getParameter().

                                                                    {
  ttStubsInputTags_ = iConfig.getParameter<std::vector<edm::InputTag> >("TTStubs");
  ttClusterTruthInputTags_ = iConfig.getParameter<std::vector<edm::InputTag> >("TTClusterTruth");

  for (const auto& iTag : ttClusterTruthInputTags_) {
    ttClusterTruthTokens_.push_back(consumes<TTClusterAssociationMap<T> >(iTag));
  }

  for (const auto& iTag : ttStubsInputTags_) {
    ttStubsTokens_.push_back(consumes<edmNew::DetSetVector<TTStub<T> > >(iTag));

    produces<TTStubAssociationMap<T> >(iTag.instance());
  }

  theTrackerGeometryToken_ = esConsumes();
  theTrackerTopologyToken_ = esConsumes();
}

~TTStubAssociator()

template<typename T >

TTStubAssociator< T >::~TTStubAssociator ( )

override

Destructor.

Definition at line 101 of file TTStubAssociator.h.

{}

Member Function Documentation

beginRun()

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 105 of file TTStubAssociator.h.

                                                                                 {
  edm::LogInfo("TTStubAssociator< ") << templateNameFinder<T>() << " > loaded.";
}

endRun()

template<typename T >

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

overrideprivate

End run.

Definition at line 112 of file TTStubAssociator.h.

{}

produce() [1/3]

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

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

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

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(), edm::EventSetup::getData(), mps_fire::i, iEvent, TrackerTopology::isLower(), dqmdumpme::k, edmNew::makeRefTo(), eostools::move(), AlCaHLTBitMon_ParallelJobs::p, jetUpdater_cfi::sort, 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 = &iSetup.getData(theTrackerGeometryToken_);
  const TrackerTopology* const tTopo = &iSetup.getData(theTrackerTopologyToken_);


  for (const auto& iTag : ttStubsTokens_) {
    auto associationMapForOutput = std::make_unique<TTStubAssociationMap<Ref_Phase2TrackerDigi_>>();

    edm::Handle<TTStubDetSetVec> ttStubHandle;
    iEvent.getByToken(iTag, ttStubHandle);

    edm::Handle<TTClusterAssociationMap<Ref_Phase2TrackerDigi_>> ttClusterAssociationMapHandle;
    iEvent.getByToken(ttClusterTruthTokens_.at(ncont1), ttClusterAssociationMapHandle);

    std::map<TTStubRef, TrackingParticlePtr> stubToTrackingParticleMap;
    std::map<TrackingParticlePtr, std::vector<TTStubRef>> trackingParticleToStubVectorMap;


    if (not ttStubHandle->empty()) {
      for (const auto& gd : theTrackerGeom->dets()) {
        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) {
          TTStubRef tempStubRef = edmNew::makeRefTo(ttStubHandle, contentIter);

          for (unsigned int ic = 0; ic < 2; ic++) {
            const std::vector<TrackingParticlePtr>& tempTPs =
                ttClusterAssociationMapHandle->findTrackingParticlePtrs(tempStubRef->clusterRef(ic));

            for (const TrackingParticlePtr& testTP : tempTPs) {
              if (testTP.isNull())
                continue;

              if (trackingParticleToStubVectorMap.find(testTP) == trackingParticleToStubVectorMap.end()) {
                std::vector<TTStubRef> stubVector;
                trackingParticleToStubVectorMap.emplace(testTP, stubVector);
              }
              trackingParticleToStubVectorMap.find(testTP)->second.push_back(tempStubRef);  
            }
          }

          if (ttClusterAssociationMapHandle->isUnknown(tempStubRef->clusterRef(0)) ||
              ttClusterAssociationMapHandle->isUnknown(tempStubRef->clusterRef(1))) {
            continue;
          } else {
            if (ttClusterAssociationMapHandle->isGenuine(tempStubRef->clusterRef(0)) &&
                ttClusterAssociationMapHandle->isGenuine(tempStubRef->clusterRef(1))) {
              if (ttClusterAssociationMapHandle->findTrackingParticlePtr(tempStubRef->clusterRef(0)).get() ==
                  ttClusterAssociationMapHandle->findTrackingParticlePtr(tempStubRef->clusterRef(1)).get()) {
                const TrackingParticlePtr& testTP =
                    ttClusterAssociationMapHandle->findTrackingParticlePtr(tempStubRef->clusterRef(0));

                stubToTrackingParticleMap.emplace(tempStubRef, testTP);

                continue;
              } else {
                continue;
              }
            }  
            else {
              TrackingParticle* prevTPAddress = nullptr;
              unsigned int whichTP = 0;

              const std::vector<TrackingParticlePtr>& trackingParticles0 =
                  ttClusterAssociationMapHandle->findTrackingParticlePtrs(tempStubRef->clusterRef(0));
              const std::vector<TrackingParticlePtr>& trackingParticles1 =
                  ttClusterAssociationMapHandle->findTrackingParticlePtrs(tempStubRef->clusterRef(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 {
                TrackingParticlePtr testTP = trackingParticles1.at(whichTP);

                stubToTrackingParticleMap.emplace(tempStubRef, testTP);

                continue;
              }  
            }    
          }      
        }
      }  
    }

    for (auto& p : trackingParticleToStubVectorMap) {
      std::vector<TTStubRef>& tempVector = p.second;

      std::sort(tempVector.begin(), tempVector.end());
      tempVector.erase(std::unique(tempVector.begin(), tempVector.end()), tempVector.end());
    }

    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;
  }  
}

produce() [2/3]

template<typename T >

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

overrideprivate

produce() [3/3]

template<>

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

private

Implement the producer.

Member Data Documentation

theTrackerGeometryToken_

template<typename T >

edm::ESGetToken<TrackerGeometry, TrackerDigiGeometryRecord> TTStubAssociator< T >::theTrackerGeometryToken_

private

Definition at line 62 of file TTStubAssociator.h.

theTrackerTopologyToken_

template<typename T >

edm::ESGetToken<TrackerTopology, TrackerTopologyRcd> TTStubAssociator< T >::theTrackerTopologyToken_

private

Definition at line 63 of file TTStubAssociator.h.

ttClusterTruthInputTags_

template<typename T >

std::vector<edm::InputTag> TTStubAssociator< T >::ttClusterTruthInputTags_

private

Definition at line 57 of file TTStubAssociator.h.

ttClusterTruthTokens_

template<typename T >

std::vector<edm::EDGetTokenT<TTClusterAssociationMap<T> > > TTStubAssociator< T >::ttClusterTruthTokens_

private

Definition at line 60 of file TTStubAssociator.h.

ttStubsInputTags_

template<typename T >

std::vector<edm::InputTag> TTStubAssociator< T >::ttStubsInputTags_

private

Data members.

Definition at line 56 of file TTStubAssociator.h.

ttStubsTokens_

template<typename T >

std::vector<edm::EDGetTokenT<edmNew::DetSetVector<TTStub<T> > > > TTStubAssociator< T >::ttStubsTokens_

private

Definition at line 59 of file TTStubAssociator.h.