ATLAS Offline Software
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, true, false, false > Class Template Reference

#include <RingerPreProcessorWrapper.h>

Inheritance diagram for Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, true, false, false >:
Collaboration diagram for Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, true, false, false >:

Public Types

typedef std::vector< IRingerProcedureWrapper * > WrapperCollection
 Collection type of PreProcessor Wrappers. More...
 
typedef std::vector< std::vector< std::vector< procedure_t * > > > PPDepProcCollection
 RingerProcedureWrapper for Threshold procedures typedefs: More...
 

Public Member Functions

virtual const char * name () const final override
 Returns this wrapper name. More...
 
 RingerProcedureWrapper (const PPDepProcCollection &ppDepCol)
 Ctors: More...
 
virtual void applyPreProcessing (const DepVarStruct &depVar, const xAOD::CaloRings *clrings, const TrackPatternsHolder *trackPat, std::vector< float > &transformVec) const final override
 Main Methods: More...
 
virtual void applyPreProcessing (const DepVarStruct &depVar, std::vector< float > &transformVec) const final override
 Apply PP to transform input space into a new representation. More...
 

Static Public Member Functions

static void writeCol (const WrapperCollection &ppWrapperCol, TDirectory *configDir)
 Write all wrappers on ppWrapperCol to TDirectory. More...
 
static void read (WrapperCollection &ppWrapperCol, TDirectory *configDir, unsigned version)
 Read all pre-processing on configDir and append them to IPreProcWrapperCollection. More...
 

Static Public Attributes

static constexpr const char * wrapName = "RingerPreProcessorWrapper"
 

Private Member Functions

void checkPPCol ()
 Private Methods: More...
 

Private Attributes

PPDepProcCollection m_ppCol
 Private Properties: More...
 
procedure_t * m_pp
 Hold pointer to the first position on the collection. More...
 
const xAOD::RingSetConf::RawConfCollectionm_rsRawConfCol
 contains a pointer into the CaloRings configuration: More...
 
unsigned m_nRings
 contains the total number of rings in the vectorized representation More...
 
virtual void setRawConfCol (const xAOD::RingSetConf::RawConfCollection *crRawConfCol) final override
 Other utilities. More...
 
virtual void getRawConfCol (const xAOD::RingSetConf::RawConfCollection *&crRawConfCol) const final override
 Get the holden CaloRings raw configuration collection. More...
 
virtual SegmentationType getSegType () const final override
 Get segmentation type for this pre-processor. More...
 
virtual bool empty () const final override
 Returns whether holden interface collection is empty. More...
 
EtaDependency etaDep () const override final
 Returns eta dependecy for this wrapper. More...
 
EtDependency etDep () const override final
 Returns et dependecy for this wrapper. More...
 
void releaseMemory () override final
 Release all holden pointer memory. More...
 
virtual void setMsgStream (MsgStream *msg) const override final
 Overloads the setMsgStream from RedirectMsgStream. More...
 
std::string fullName () const override final
 Get full wrapper name. More...
 
void print (MSG::Level lvl=MSG::DEBUG) const override final
 Print wrapper content. More...
 
void write (TDirectory *baseDir, const char *idxStr="") const override final
 Write collection to TDirectory. More...
 
static std::string staticFullName ()
 Get full wrapper name, static method. More...
 
static RingerProcedureWrapperread (TDirectory *configDir, unsigned version)
 Read collection from TDirectory. More...
 

Detailed Description

template<class procedure_t, int etaDependency, int etDependency, int segType>
class Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, true, false, false >

Definition at line 128 of file RingerPreProcessorWrapper.h.

Member Typedef Documentation

◆ PPDepProcCollection

template<class procedure_t , int etaDependency, int etDependency, int segType>
typedef std::vector< std::vector < std::vector < procedure_t* > > > Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, true, false, false >::PPDepProcCollection

RingerProcedureWrapper for Threshold procedures typedefs:

typedef to the Ringer Interface variable dependency collection

Vector Dimension: [segType][etBin][etaBin]:

Definition at line 153 of file RingerPreProcessorWrapper.h.

◆ WrapperCollection

Collection type of PreProcessor Wrappers.

Definition at line 35 of file RingerPreProcessorWrapper.h.

Constructor & Destructor Documentation

◆ RingerProcedureWrapper()

template<class procedure_t , int etaDependency, int etDependency, int segType>
Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, true, false, false >::RingerProcedureWrapper ( const PPDepProcCollection ppDepCol)
inline

Ctors:

Build RProc Wrapper

Definition at line 161 of file RingerPreProcessorWrapper.h.

162  :
163  m_ppCol(ppDepCol),
164  m_pp(nullptr),
165  m_rsRawConfCol(nullptr),
166  m_nRings(0)
167  {
168  checkPPCol();
169  m_pp = m_ppCol[0][0][0];
170  }

Member Function Documentation

◆ applyPreProcessing() [1/2]

template<class procedure_t , int etaDependency, int etDependency, int segType>
virtual void Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, true, false, false >::applyPreProcessing ( const DepVarStruct depVar,
const xAOD::CaloRings clrings,
const TrackPatternsHolder *  trackPat,
std::vector< float > &  transformVec 
) const
finaloverridevirtual

Main Methods:

Apply PP to transform input space into a new representation

This method will pass the information within xAOD::CaloRings and xAOD::TrackParticle to the pre-processors. If any pointer if set to null, then it won't pass this information. Make sure to feed pre-processors with the same information it was adjusted to work with.

Implements Ringer::IRingerProcedureWrapper< PreProcessing::IPreProcessor >.

◆ applyPreProcessing() [2/2]

template<class procedure_t , int etaDependency, int etDependency, int segType>
virtual void Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, true, false, false >::applyPreProcessing ( const DepVarStruct depVar,
std::vector< float > &  transformVec 
) const
finaloverridevirtual

Apply PP to transform input space into a new representation.

This method directly uses transformVec as input and transforms it into the new representation.

Implements Ringer::IRingerProcedureWrapper< PreProcessing::IPreProcessor >.

◆ checkPPCol()

template<class procedure_t , int etaDependency, int etDependency, int segType>
void Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, true, false, false >::checkPPCol ( )
private

Private Methods:

Check if pre-processing interface collection is in good status (Throws otherwise)

◆ empty()

template<class procedure_t , int etaDependency, int etDependency, int segType>
virtual bool Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, true, false, false >::empty ( ) const
inlinefinaloverridevirtual

Returns whether holden interface collection is empty.

Implements Ringer::IRingerProcedureWrapperBase.

Definition at line 237 of file RingerPreProcessorWrapper.h.

238  {
239  return m_ppCol.empty();
240  }

◆ etaDep()

template<class procedure_t , int etaDependency, int etDependency, int segType>
EtaDependency Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, true, false, false >::etaDep ( ) const
inlinefinaloverridevirtual

Returns eta dependecy for this wrapper.

Implements Ringer::IRingerProcedureWrapperBase.

Definition at line 245 of file RingerPreProcessorWrapper.h.

246  {
247  return static_cast<EtaDependency>(etaDependency);
248  }

◆ etDep()

template<class procedure_t , int etaDependency, int etDependency, int segType>
EtDependency Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, true, false, false >::etDep ( ) const
inlinefinaloverridevirtual

Returns et dependecy for this wrapper.

Implements Ringer::IRingerProcedureWrapperBase.

Definition at line 253 of file RingerPreProcessorWrapper.h.

254  {
255  return static_cast<EtDependency>(etDependency);
256  }

◆ fullName()

template<class procedure_t , int etaDependency, int etDependency, int segType>
std::string Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, true, false, false >::fullName ( ) const
finaloverridevirtual

Get full wrapper name.

Implements Ringer::IRingerProcedureWrapperBase.

◆ getRawConfCol()

template<class procedure_t , int etaDependency, int etDependency, int segType>
virtual void Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, true, false, false >::getRawConfCol ( const xAOD::RingSetConf::RawConfCollection *&  crRawConfCol) const
inlinefinaloverridevirtual

Get the holden CaloRings raw configuration collection.

Implements Ringer::IRingerProcedureWrapper< PreProcessing::IPreProcessor >.

Definition at line 219 of file RingerPreProcessorWrapper.h.

221  {
222  crRawConfCol = m_rsRawConfCol;
223  }

◆ getSegType()

template<class procedure_t , int etaDependency, int etDependency, int segType>
virtual SegmentationType Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, true, false, false >::getSegType ( ) const
inlinefinaloverridevirtual

Get segmentation type for this pre-processor.

Implements Ringer::IRingerProcedureWrapper< PreProcessing::IPreProcessor >.

Definition at line 229 of file RingerPreProcessorWrapper.h.

230  {
231  return static_cast<SegmentationType>(segType);
232  }

◆ name()

virtual const char* Ringer::IRingerProcedureWrapper< PreProcessing::IPreProcessor >::name ( ) const
inlinefinaloverridevirtualinherited

Returns this wrapper name.

Implements Ringer::IRingerProcedureWrapperBase.

Definition at line 83 of file RingerPreProcessorWrapper.h.

83  {
84  return wrapName;
85  }

◆ print()

template<class procedure_t , int etaDependency, int etDependency, int segType>
void Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, true, false, false >::print ( MSG::Level  lvl = MSG::DEBUG) const
finaloverridevirtual

Print wrapper content.

Implements Ringer::IRingerProcedureWrapperBase.

◆ read() [1/2]

template<class procedure_t , int etaDependency, int etDependency, int segType>
static RingerProcedureWrapper* Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, true, false, false >::read ( TDirectory *  configDir,
unsigned  version 
)
static

Read collection from TDirectory.

◆ read() [2/2]

static void Ringer::IRingerProcedureWrapper< PreProcessing::IPreProcessor >::read ( WrapperCollection ppWrapperCol,
TDirectory *  configDir,
unsigned  version 
)
staticinherited

Read all pre-processing on configDir and append them to IPreProcWrapperCollection.

◆ releaseMemory()

template<class procedure_t , int etaDependency, int etDependency, int segType>
void Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, true, false, false >::releaseMemory ( )
finaloverridevirtual

Release all holden pointer memory.

Implements Ringer::IRingerProcedureWrapperBase.

◆ setMsgStream()

template<class procedure_t , int etaDependency, int etDependency, int segType>
virtual void Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, true, false, false >::setMsgStream ( MsgStream *  msg) const
finaloverridevirtual

Overloads the setMsgStream from RedirectMsgStream.

◆ setRawConfCol()

template<class procedure_t , int etaDependency, int etDependency, int segType>
virtual void Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, true, false, false >::setRawConfCol ( const xAOD::RingSetConf::RawConfCollection crRawConfCol)
inlinefinaloverridevirtual

Other utilities.

Set the holden CaloRings raw configuration collection.

Implements Ringer::IRingerProcedureWrapper< PreProcessing::IPreProcessor >.

Definition at line 209 of file RingerPreProcessorWrapper.h.

211  {
212  m_rsRawConfCol = crRawConfCol;
214  }

◆ staticFullName()

template<class procedure_t , int etaDependency, int etDependency, int segType>
static std::string Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, true, false, false >::staticFullName ( )
static

Get full wrapper name, static method.

◆ write()

template<class procedure_t , int etaDependency, int etDependency, int segType>
void Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, true, false, false >::write ( TDirectory *  baseDir,
const char *  idxStr = "" 
) const
finaloverridevirtual

Write collection to TDirectory.

Implements Ringer::IRingerProcedureWrapperBase.

◆ writeCol()

static void Ringer::IRingerProcedureWrapper< PreProcessing::IPreProcessor >::writeCol ( const WrapperCollection ppWrapperCol,
TDirectory *  configDir 
)
staticinherited

Write all wrappers on ppWrapperCol to TDirectory.

Member Data Documentation

◆ m_nRings

template<class procedure_t , int etaDependency, int etDependency, int segType>
unsigned Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, true, false, false >::m_nRings
private

contains the total number of rings in the vectorized representation

Definition at line 318 of file RingerPreProcessorWrapper.h.

◆ m_pp

template<class procedure_t , int etaDependency, int etDependency, int segType>
procedure_t* Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, true, false, false >::m_pp
private

Hold pointer to the first position on the collection.

Definition at line 311 of file RingerPreProcessorWrapper.h.

◆ m_ppCol

template<class procedure_t , int etaDependency, int etDependency, int segType>
PPDepProcCollection Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, true, false, false >::m_ppCol
private

Private Properties:

holden pre-processing collection:

Definition at line 309 of file RingerPreProcessorWrapper.h.

◆ m_rsRawConfCol

template<class procedure_t , int etaDependency, int etDependency, int segType>
const xAOD::RingSetConf::RawConfCollection* Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, true, false, false >::m_rsRawConfCol
private

contains a pointer into the CaloRings configuration:

Definition at line 315 of file RingerPreProcessorWrapper.h.

◆ wrapName

constexpr const char* Ringer::IRingerProcedureWrapper< PreProcessing::IPreProcessor >::wrapName = "RingerPreProcessorWrapper"
staticconstexprinherited

Definition at line 101 of file RingerPreProcessorWrapper.h.


The documentation for this class was generated from the following file:
Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, true, false, false >::m_nRings
unsigned m_nRings
contains the total number of rings in the vectorized representation
Definition: RingerPreProcessorWrapper.h:318
Ringer::IRingerProcedureWrapper< PreProcessing::IPreProcessor >::wrapName
static constexpr const char * wrapName
Definition: RingerPreProcessorWrapper.h:101
Ringer::SegmentationType
SegmentationType
the possible procedure longitudinal segmentation types.
Definition: RingerSelectorToolsEnums.h:64
Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, true, false, false >::checkPPCol
void checkPPCol()
Private Methods:
Ringer::EtDependency
EtDependency
Specify et position dependency.
Definition: RingerSelectorToolsEnums.h:95
Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, true, false, false >::m_ppCol
PPDepProcCollection m_ppCol
Private Properties:
Definition: RingerPreProcessorWrapper.h:309
Ringer::EtaDependency
EtaDependency
Specify eta position dependency.
Definition: RingerSelectorToolsEnums.h:81
Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, true, false, false >::m_pp
procedure_t * m_pp
Hold pointer to the first position on the collection.
Definition: RingerPreProcessorWrapper.h:311
Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, true, false, false >::m_rsRawConfCol
const xAOD::RingSetConf::RawConfCollection * m_rsRawConfCol
contains a pointer into the CaloRings configuration:
Definition: RingerPreProcessorWrapper.h:315
xAOD::RingSetConf_v1::totalNumberOfRings
static unsigned totalNumberOfRings(const RawConfCollection &clRingsConf)
Get the totalNumber of Rings contained in this configuration:
Definition: RingSetConf_v1.cxx:227