InDet::TruthClusterizationFactory Class Reference

#include <TruthClusterizationFactory.h>

Inheritance diagram for InDet::TruthClusterizationFactory:

Collaboration diagram for InDet::TruthClusterizationFactory:

Public Member Functions
	TruthClusterizationFactory (const std::string &name, const std::string &n, const IInterface *p)
	~TruthClusterizationFactory ()=default
virtual StatusCode	initialize ()
virtual StatusCode	finalize ()
std::vector< double >	estimateNumberOfParticles (const InDet::PixelCluster &pCluster) const
std::vector< Amg::Vector2D >	estimatePositions (const InDet::PixelCluster &) const
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	AlgTool interface methods.

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Protected Attributes
ServiceHandle< IAthRNGSvc >	m_rndmSvc {this, "RndmSvc", "AthRNGSvc", "Random Number Service used in TruthClusterizationFactory"}
Gaudi::Property< std::string >	m_rndmEngineName {this, "RndmEngine", "TruthClustering", "Random Engine Name"}
ATHRNG::RNGWrapper *	m_rndmEngine {nullptr}
Gaudi::Property< bool >	m_discardPUHits {this, "discardPUHits", true, "Discard PU hits for NN emulation"}
Gaudi::Property< float >	m_truthClusterSplittingEff {this, "truthClusterSplittingEff", 0.9, "Cluster splitting effeciency"}

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
SG::ReadHandleKey< InDetSimDataCollection >	m_simDataCollectionName {this, "InputSDOMap", "PixelSDO_Map", "sim data collection name"}
	IncidentSvc to catch begining of event and end of event.
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default).
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default).
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 49 of file TruthClusterizationFactory.h.

Member Typedef Documentation

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 376 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

TruthClusterizationFactory()

InDet::TruthClusterizationFactory::TruthClusterizationFactory	(	const std::string &	name,
		const std::string &	n,
		const IInterface *	p )

Definition at line 37 of file TruthClusterizationFactory.cxx.

                                                                                                 :
    AthAlgTool(name, n, p)
  {
    declareInterface<TruthClusterizationFactory>(this);
  } 

~TruthClusterizationFactory()

InDet::TruthClusterizationFactory::~TruthClusterizationFactory ( )

default

Member Function Documentation

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & hndl, const SG::VarHandleKeyType &  )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

estimateNumberOfParticles()

std::vector< double > InDet::TruthClusterizationFactory::estimateNumberOfParticles

(

const InDet::PixelCluster &

pCluster

)

const

Definition at line 69 of file TruthClusterizationFactory.cxx.

  {
    const EventContext& ctx = Gaudi::Hive::currentContext();
    if (ctx.evt() != m_rndmEngine->evtSeeded(ctx)) {
       ATHRNG::RNGWrapper* wrapper ATLAS_THREAD_SAFE = m_rndmEngine;
       wrapper->setSeed (this->name(), ctx);
    }
    CLHEP::HepRandomEngine* engine = m_rndmEngine->getEngine (ctx);
    
    std::vector<double> probabilities(3,0.);
    const auto &rdos = pCluster.rdoList();
    unsigned int nPartContributing = 0;
    if (m_discardPUHits) {
      // Initialize set for a list of distinct uniqueIDs for the cluster
      std::set<int> uniqueIDs;
      SG::ReadHandle<InDetSimDataCollection> pixSdoColl(m_simDataCollectionName);
      //Loop over all elements (pixels/strips) in the cluster
      if(pixSdoColl.isValid()){
        for (auto rdoIter :  rdos){
          const auto & simDataIter = pixSdoColl->find(rdoIter);
          if (simDataIter != pixSdoColl->end()){
            // get the SimData and count the individual contributions
            const auto & simData = (simDataIter->second);
            for( const auto& deposit : simData.getdeposits() ){
              //If deposit exists
              if (!deposit.first){ATH_MSG_DEBUG("No deposits found"); continue;}
              // This should only be used for samples without pile-up
              if (deposit.first.eventIndex() != 0) continue;
              uniqueIDs.insert(deposit.first.id());
            }
          }
        }
      }
      //uniqueIDs lists the unique truth particles contributing to the
      //cluster
      nPartContributing = uniqueIDs.size();
    }
    else {
      //Initialize set for a list of distinct uniqueIDs for the cluster
      //- if we are taking into account pile-up, then we need
      //GenEvent::event_number() + GenParticle::id() to uniquely
      //idenftify a GenParticle from a group of GenEvents.
      std::set< std::pair<HepMcParticleLink::index_type, int> > uniqueIDs;
      SG::ReadHandle<InDetSimDataCollection> pixSdoColl(m_simDataCollectionName);
      //Loop over all elements (pixels/strips) in the cluster
      if(pixSdoColl.isValid()){
        for (auto rdoIter :  rdos){
          auto simDataIter = pixSdoColl->find(rdoIter);
          if (simDataIter != pixSdoColl->end()){
            // get the SimData and count the individual contributions
            const auto & simData = (simDataIter->second);
            for( const auto& deposit : simData.getdeposits() ){
              //If deposit exists
              if (!deposit.first){ATH_MSG_DEBUG("No deposits found"); continue;}
              // This should only be used for samples with pile-up
              uniqueIDs.insert(std::make_pair(deposit.first.eventIndex(), deposit.first.id()));
            }
          }
        }
      }
      //uniqueIDs lists the unique truth particles contributing to the
      //cluster
      nPartContributing = uniqueIDs.size();
    }
    ATH_MSG_VERBOSE("n Part Contributing: " << nPartContributing);
    ATH_MSG_VERBOSE("Smearing TruthClusterizationFactory probability output for TIDE studies");
    //If only 1 truth particles found
    //For pure PU case nPartContributing=0, assume that there is a single particle contributing as well
    if (nPartContributing<=1) {
      //NN will always return 100% chance of there being only 1 particle
      probabilities[0] = 1.0;
    }
    //If two unique truth particles found in cluster
    else if (nPartContributing==2) {
      //90% chance NN returns high probability of there being 2 particles
      if (CLHEP::RandFlat::shoot( engine, 0, 1 ) < m_truthClusterSplittingEff) probabilities[1] = 1.0;
      //Other 10% NN returns high probability of there being 1 particle
      else probabilities[0] = 1.0;
    }
    //If greater than 2 unique truth particles in cluster
    else if (nPartContributing>2) {
      //90% chance NN returns high probability of there being >2 particles
      if (CLHEP::RandFlat::shoot( engine, 0, 1 ) < m_truthClusterSplittingEff) probabilities[2] = 1.0;
      //Other 10% NN returns high probability of there being 1 particle
      else probabilities[0] = 1.0;
    }
    
    return probabilities;
 
  }

estimatePositions()

std::vector< Amg::Vector2D > InDet::TruthClusterizationFactory::estimatePositions

(

const InDet::PixelCluster &

)

const

Definition at line 160 of file TruthClusterizationFactory.cxx.

  { 
    ATH_MSG_ERROR("TruthClusterizationFactory::estimatePositions called for ITk ambiguity setup, should never happen! Digital clustering should be run for positions & errors.");
    return std::vector<Amg::Vector2D>(2,Amg::Vector2D (2,0.));
  }

evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

finalize()

virtual StatusCode InDet::TruthClusterizationFactory::finalize ( )

inlinevirtual

Definition at line 61 of file TruthClusterizationFactory.h.

{ return StatusCode::SUCCESS; };

initialize()

StatusCode InDet::TruthClusterizationFactory::initialize ( )

virtual

Definition at line 44 of file TruthClusterizationFactory.cxx.

                                                    {
 
    ATH_MSG_DEBUG(m_truthClusterSplittingEff);
 
    // random svc
    CHECK(m_rndmSvc.retrieve());
  
    // get the random stream
    ATH_MSG_DEBUG ( "Getting random number engine : <" << m_rndmEngineName << ">" );
    m_rndmEngine = m_rndmSvc->getEngine(this, m_rndmEngineName);
    if (!m_rndmEngine) {
      ATH_MSG_ERROR("Could not find RndmEngine : " << m_rndmEngineName);
      return StatusCode::FAILURE;
    }
    else {
      ATH_MSG_DEBUG("Found RndmEngine : " << m_rndmEngineName);
    }
 
    ATH_CHECK( m_simDataCollectionName.initialize() );
 
    return StatusCode::SUCCESS;
  }

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

interfaceID()

const InterfaceID & InDet::TruthClusterizationFactory::interfaceID ( )

inlinestatic

AlgTool interface methods.

Definition at line 54 of file TruthClusterizationFactory.h.

{ return IID_TruthClusterizationFactory; };

msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 368 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 352 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, and AthCheckedComponent<::AthAlgTool >.

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 298 of file AthCommonDataStore.h.

                                               {
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default).

Definition at line 381 of file AthCommonDataStore.h.

m_discardPUHits

Gaudi::Property<bool> InDet::TruthClusterizationFactory::m_discardPUHits {this, "discardPUHits", true, "Discard PU hits for NN emulation"}

protected

Definition at line 75 of file TruthClusterizationFactory.h.

{this, "discardPUHits", true, "Discard PU hits for NN emulation"};

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default).

Definition at line 378 of file AthCommonDataStore.h.

m_rndmEngine

ATHRNG::RNGWrapper* InDet::TruthClusterizationFactory::m_rndmEngine {nullptr}

protected

Definition at line 74 of file TruthClusterizationFactory.h.

{nullptr};

m_rndmEngineName

Gaudi::Property<std::string> InDet::TruthClusterizationFactory::m_rndmEngineName {this, "RndmEngine", "TruthClustering", "Random Engine Name"}

protected

Definition at line 73 of file TruthClusterizationFactory.h.

{this, "RndmEngine", "TruthClustering", "Random Engine Name"};

m_rndmSvc

ServiceHandle<IAthRNGSvc> InDet::TruthClusterizationFactory::m_rndmSvc {this, "RndmSvc", "AthRNGSvc", "Random Number Service used in TruthClusterizationFactory"}

protected

Definition at line 72 of file TruthClusterizationFactory.h.

{this, "RndmSvc", "AthRNGSvc", "Random Number Service used in TruthClusterizationFactory"};

m_simDataCollectionName

SG::ReadHandleKey<InDetSimDataCollection> InDet::TruthClusterizationFactory::m_simDataCollectionName {this, "InputSDOMap", "PixelSDO_Map", "sim data collection name"}

private

IncidentSvc to catch begining of event and end of event.

Definition at line 69 of file TruthClusterizationFactory.h.

{this, "InputSDOMap", "PixelSDO_Map", "sim data collection name"};

m_truthClusterSplittingEff

Gaudi::Property<float> InDet::TruthClusterizationFactory::m_truthClusterSplittingEff {this, "truthClusterSplittingEff", 0.9, "Cluster splitting effeciency"}

protected

Definition at line 76 of file TruthClusterizationFactory.h.

{this, "truthClusterSplittingEff", 0.9, "Cluster splitting effeciency"};

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 387 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 386 of file AthCommonDataStore.h.

---

The documentation for this class was generated from the following files:

• TruthClusterizationFactory.h
• TruthClusterizationFactory.cxx