JiveXML::SiSpacePointRetriever Class Reference

Retrieves all InDet::SpacePoint data for Pixel and SCT. More...

#include <SiSpacePointRetriever.h>

Inheritance diagram for JiveXML::SiSpacePointRetriever:

Collaboration diagram for JiveXML::SiSpacePointRetriever:

Public Member Functions
	SiSpacePointRetriever (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Constructor.
virtual StatusCode	retrieve (ToolHandle< IFormatTool > &FormatTool)
	Retrieve all the data.
virtual std::string	dataTypeName () const
	Return the name of the data type.
virtual StatusCode	initialize ()
	Only retrieve geo tool in initialize.
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 ()
	Return the interface identifier.

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.

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
const ToolHandle< IInDetGeoModelTool >	m_geo {this,"GeoModelTool","JiveXML::InDetGeoModelTool/InDetGeoModelTool",""}
	A tool handle to the geo model tool.
SG::ReadHandleKey< SpacePointContainer >	m_PixelSPContainerName
	StoreGate key for Pixel space points.
SG::ReadHandleKey< SpacePointContainer >	m_SCTSPContainerName
	StoreGate key for SCT space points.
bool	m_usePixelTruthMap = false
	StoreGate key for pixel PRD_MultiTruth.
SG::ReadHandleKey< PRD_MultiTruthCollection >	m_PixelPRDTruthName
bool	m_useSCTTruthMap = false
	StoreGate key for SCT PRD_MultiTruth.
SG::ReadHandleKey< PRD_MultiTruthCollection >	m_SCTPRDTruthName
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

Retrieves all InDet::SpacePoint data for Pixel and SCT.

• Properties

  • PixelSpacePoints = 'PixelSpacePoints':
  • SCT_SpacePoints = 'SCTSpacePoints':
  • PRD_TruthPixel = 'PRD_MultiTruthPixel': m_PixelPRDTruthName;
  • PRD_TruthSCT = 'PRD_MultiTruthSCT':

• Retrieved Data
  • x,y,z: coordinates of the spacePoint
  • clusters: identifier of first (and second for SCT) associated cluster
  • phiModule,etaModule: \(\eta\) and \(\phi\) of module in detector coordinates
  • numBarcodes: number of truth particles associated with this SpacePoint
  • barcodes: barcodes of associated truth particles

Definition at line 35 of file SiSpacePointRetriever.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

SiSpacePointRetriever()

JiveXML::SiSpacePointRetriever::SiSpacePointRetriever	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Standard Constructor.

This is the standard AthAlgTool constructor.

Parameters

type	AlgTool type name
name	AlgTool instance name
parent	AlgTools parent owning this tool

Definition at line 30 of file SiSpacePointRetriever.cxx.

                                                                                                                  :
    AthAlgTool(type,name,parent)
  {
 
    //Declare the interface
    declareInterface<IDataRetriever>(this);
    
    //And the properties
    declareProperty("PixelSpacePoints"     , m_PixelSPContainerName = std::string("PixelSpacePoints"));
    declareProperty("SCTSpacePoints"       , m_SCTSPContainerName = std::string("SCT_SpacePoints"));
    declareProperty("PRD_TruthPixel"       , m_PixelPRDTruthName = std::string("PRD_MultiTruthPixel")); 
    declareProperty("PRD_TruthSCT"         , m_SCTPRDTruthName = std::string("PRD_MultiTruthSCT"));   
  }

Member Function Documentation

dataTypeName()

virtual std::string JiveXML::SiSpacePointRetriever::dataTypeName ( ) const

inlinevirtual

Return the name of the data type.

Implements JiveXML::IDataRetriever.

Definition at line 47 of file SiSpacePointRetriever.h.

{ return "S3D"; };

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

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

initialize()

StatusCode JiveXML::SiSpacePointRetriever::initialize ( )

virtual

Only retrieve geo tool in initialize.

Definition at line 261 of file SiSpacePointRetriever.cxx.

                                               {
    // Read Handle Key
    ATH_CHECK(m_PixelSPContainerName.initialize());
    ATH_CHECK(m_SCTSPContainerName.initialize());
    m_usePixelTruthMap = !m_PixelPRDTruthName.key().empty();
    ATH_CHECK(m_PixelPRDTruthName.initialize(m_usePixelTruthMap));
    m_useSCTTruthMap = !m_SCTPRDTruthName.key().empty();
    ATH_CHECK(m_SCTPRDTruthName.initialize(m_useSCTTruthMap));
 
    return m_geo.retrieve();
  }

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 & JiveXML::IDataRetriever::interfaceID ( )

inlinestaticinherited

Return the interface identifier.

Definition at line 40 of file IDataRetriever.h.

{ return IID_IDataRetriever; }

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 380 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 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

retrieve()

StatusCode JiveXML::SiSpacePointRetriever::retrieve ( ToolHandle< IFormatTool > & FormatTool )

virtual

Retrieve all the data.

Implementation of DataRetriever interface.

Parameters

FormatTool

the tool that will create formated output from the DataMap

Try to retrieve all the relevant collections

Now make a list of SpacePoint - PRDTruth collection pairs to run over

Found out how much space we will need

Declare all the data we want to retrieve

Now fill in all the data

Implements JiveXML::IDataRetriever.

Definition at line 109 of file SiSpacePointRetriever.cxx.

                                                                                {
 
    //be verbose
    ATH_MSG_DEBUG( "Retrieving " << dataTypeName() ); 
   
 
    SG::ReadHandle<SpacePointContainer> PixelSPContainer(m_PixelSPContainerName);
    if ( not PixelSPContainer.isValid() )
      ATH_MSG_WARNING( "Unable to retrieve SpacePoint container with name " << m_PixelSPContainerName.key() );
 
    SG::ReadHandle<PRD_MultiTruthCollection> PixelPRDTruthColl;
    if (m_usePixelTruthMap) {
      PixelPRDTruthColl = SG::makeHandle(m_PixelPRDTruthName);
      if ( not PixelPRDTruthColl.isValid() )
        ATH_MSG_WARNING( "Unable to retrieve PRD_MultiTruth collection with name " << m_PixelPRDTruthName.key() );
    }
 
    SG::ReadHandle<SpacePointContainer> SCTSPContainer(m_SCTSPContainerName);
    if ( not SCTSPContainer.isValid() )
      ATH_MSG_WARNING( "Unable to retrieve SpacePoint container with name " << m_SCTSPContainerName.key() );
 
    SG::ReadHandle<PRD_MultiTruthCollection> SCTPRDTruthColl;
    if (m_useSCTTruthMap) {
      SCTPRDTruthColl = SG::makeHandle(m_SCTPRDTruthName);
      if ( not SCTPRDTruthColl.isValid() )        
        ATH_MSG_WARNING( "Unable to retrieve PRD_MultiTruth collection with name " << m_SCTPRDTruthName.key() );
    }

    using SpacePointTruthPair = std::pair<const SpacePointContainer *, const PRD_MultiTruthCollection *>;
    std::vector<SpacePointTruthPair> SpacePointTruthPairList;
 
    //Add Pixel if there is a collection
    if (PixelSPContainer.isValid())
      SpacePointTruthPairList.emplace_back(PixelSPContainer.cptr(), m_usePixelTruthMap ? PixelPRDTruthColl.cptr() : nullptr);
    
    //Add SCT if there is a collection
    if (SCTSPContainer.isValid())
      SpacePointTruthPairList.emplace_back(SCTSPContainer.cptr(), m_useSCTTruthMap ? SCTPRDTruthColl.cptr() : nullptr);
    
    int NSpacePoints = 0;
    //Loop over all SpacePoint - PRDTruth pairs
    for (const auto &SPTruthPair : SpacePointTruthPairList) {
 
      //Add up the size of the SpacePoint collections in the container
      for (const auto SpacePoint : *(SPTruthPair.first))
        NSpacePoints += SpacePoint->size();
    }
 
    ATH_MSG_DEBUG(  "Counted  " << NSpacePoints << " in total" );

    DataVect x; x.reserve(NSpacePoints);
    DataVect y; y.reserve(NSpacePoints);
    DataVect z; z.reserve(NSpacePoints);
    DataVect clusters; clusters.reserve(NSpacePoints*2);
    DataVect phiModule; phiModule.reserve(NSpacePoints);
    DataVect etaModule; etaModule.reserve(NSpacePoints);
    DataVect numBarcodes; numBarcodes.reserve(NSpacePoints);
    DataVect barcodes; barcodes.reserve(NSpacePoints); // Usually less then one per space point

 
    //Loop over all SpacePoint - PRDTruth pairs
    for (const auto &SPTruthPair : SpacePointTruthPairList) {
 
      // Loop over SpacePoint Collections in the SpacePoint container
      for (const auto SpacePointColl : *(SPTruthPair.first)){
 
        //Loop over SpacePoints themselves
        for (const auto SpacePoint : *SpacePointColl) {
          
          //Get the position of the space point
            Amg::Vector3D point = SpacePoint->globalPosition();
          
          //Store position in units of centimeters
          x.push_back(DataType(point.x() * CLHEP::mm/CLHEP::cm));
          y.push_back(DataType(point.y() * CLHEP::mm/CLHEP::cm));
          z.push_back(DataType(point.z() * CLHEP::mm/CLHEP::cm));
          
          //Get the cluster list for the Space point (first and second)
          const std::pair<const Trk::PrepRawData*, const Trk::PrepRawData*> clusterList = SpacePoint->clusterList();
 
          //Get the identifiers of the first and second cluster 
          Identifier idFirst = clusterList.first->identify();
          Identifier idSecond = (clusterList.second != NULL) ? clusterList.second->identify() : Identifier();
 
          //Get phi and eta of the module in detector coordinates of the first cluster
          if (clusterList.first->type(Trk::PrepRawDataType::SCT_Cluster)) {
                phiModule.push_back(DataType(m_geo->SCTIDHelper()->phi_module(idFirst)));
                etaModule.push_back(DataType(m_geo->SCTIDHelper()->eta_module(idFirst)));
          }
          else {
             phiModule.push_back(DataType(m_geo->PixelIDHelper()->phi_module(idFirst)));
             etaModule.push_back(DataType(m_geo->PixelIDHelper()->eta_module(idFirst)));
          }
 
          // Store the cluster(s) identifier (pair)
          clusters.push_back(DataType(idFirst.get_compact()));   
          clusters.push_back((idSecond.is_valid()) ? DataType(idSecond.get_compact()) : DataType(-1));
 
          //Stop here if there is no truth
          const PRD_MultiTruthCollection* PRDTruthColl = SPTruthPair.second;
          if ( PRDTruthColl == nullptr ) continue ;
 
          // Finally get barcodes of associated truth particles
          numBarcodes.push_back(SiSpacePointRetrieverHelpers::getTruthBarcodes(idFirst, idSecond, PRDTruthColl, barcodes));
 
          ATH_MSG_VERBOSE( "Found " << numBarcodes.back() << " common barcodes, now " 
                                                      << barcodes.size() << " in total" );
 
        } // loop over SpacePoint collection
      } // loop over SpacePoint container
    } //loop over SpacePoint - TruthMap collection pairs
 
    //Now put together the DataMap
    DataMap dataMap;
    const auto sz = x.size();
    dataMap["x"] = std::move(x);
    dataMap["y"] = std::move(y);
    dataMap["z"] = std::move(z);
    dataMap["clusters multiple=\"2\""] = std::move(clusters);
    dataMap["phiModule"] = std::move(phiModule);
    dataMap["etaModule"] = std::move(etaModule);
 
    //Only store truth associations if we retrieved them
    if ( numBarcodes.size() > 0 ){
      //Add barcodes counter
      dataMap["numBarcodes"] = numBarcodes;
      // Compute the "multiple" and put the barcodes vector in the map.
      std::string bctag = "barcodes multiple=\""+DataType(barcodes.size()/double(numBarcodes.size())).toString()+"\"";
      dataMap[bctag] = std::move(barcodes);
    }
 
    ATH_MSG_DEBUG( dataTypeName() << ": "<< sz );
 
     //forward data to formating tool and return
    return FormatTool->AddToEvent(dataTypeName(), "", &dataMap);
  }

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 >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

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 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    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 393 of file AthCommonDataStore.h.

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_geo

const ToolHandle<IInDetGeoModelTool> JiveXML::SiSpacePointRetriever::m_geo {this,"GeoModelTool","JiveXML::InDetGeoModelTool/InDetGeoModelTool",""}

private

A tool handle to the geo model tool.

Definition at line 55 of file SiSpacePointRetriever.h.

{this,"GeoModelTool","JiveXML::InDetGeoModelTool/InDetGeoModelTool",""};

m_PixelPRDTruthName

SG::ReadHandleKey<PRD_MultiTruthCollection> JiveXML::SiSpacePointRetriever::m_PixelPRDTruthName

private

Definition at line 66 of file SiSpacePointRetriever.h.

m_PixelSPContainerName

SG::ReadHandleKey<SpacePointContainer> JiveXML::SiSpacePointRetriever::m_PixelSPContainerName

private

StoreGate key for Pixel space points.

Definition at line 59 of file SiSpacePointRetriever.h.

m_SCTPRDTruthName

SG::ReadHandleKey<PRD_MultiTruthCollection> JiveXML::SiSpacePointRetriever::m_SCTPRDTruthName

private

Definition at line 70 of file SiSpacePointRetriever.h.

m_SCTSPContainerName

SG::ReadHandleKey<SpacePointContainer> JiveXML::SiSpacePointRetriever::m_SCTSPContainerName

private

StoreGate key for SCT space points.

Definition at line 62 of file SiSpacePointRetriever.h.

m_usePixelTruthMap

bool JiveXML::SiSpacePointRetriever::m_usePixelTruthMap = false

private

StoreGate key for pixel PRD_MultiTruth.

Definition at line 65 of file SiSpacePointRetriever.h.

m_useSCTTruthMap

bool JiveXML::SiSpacePointRetriever::m_useSCTTruthMap = false

private

StoreGate key for SCT PRD_MultiTruth.

Definition at line 69 of file SiSpacePointRetriever.h.

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

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

• SiSpacePointRetriever.h
• SiSpacePointRetriever.cxx