ATLAS Offline Software
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
Ringer::IRingerProcedureWrapper< PreProcessing::IPreProcessor > Class Referenceabstract

#include <RingerPreProcessorWrapper.h>

Inheritance diagram for Ringer::IRingerProcedureWrapper< PreProcessing::IPreProcessor >:
Collaboration diagram for Ringer::IRingerProcedureWrapper< PreProcessing::IPreProcessor >:

Public Types

typedef std::vector< IRingerProcedureWrapper * > WrapperCollection
 Collection type of PreProcessor Wrappers. More...
 

Public Member Functions

virtual void applyPreProcessing (const DepVarStruct &depVar, const xAOD::CaloRings *clrings, const TrackPatternsHolder *trackPat, std::vector< float > &transformVec) const =0
 Apply PP to transform input space into a new representation. More...
 
virtual void setRawConfCol (const xAOD::RingSetConf::RawConfCollection *crRawConfCol)=0
 Set the holden CaloRings raw configuration collection. More...
 
virtual void getRawConfCol (const xAOD::RingSetConf::RawConfCollection *&crRawConfCol) const =0
 Get the holden CaloRings raw configuration collection. More...
 
virtual SegmentationType getSegType () const =0
 Get segmentation type for this pre-processing. More...
 
virtual void applyPreProcessing (const DepVarStruct &depVar, std::vector< float > &transformVec) const =0
 Apply PP to transform input space into a new representation. More...
 
virtual const char * name () const final override
 Returns this wrapper name. More...
 
virtual ~IRingerProcedureWrapper ()
 Ensure virtual destructor. More...
 
virtual bool empty () const =0
 Returns whether holden interface collection is empty. More...
 
virtual void write (TDirectory *baseDir, const char *idxStr="") const =0
 Write collection to TDirectory. More...
 
virtual EtaDependency etaDep () const =0
 Returns eta dependecy for this wrapper. More...
 
virtual EtDependency etDep () const =0
 Returns et dependecy for this wrapper. More...
 
virtual void releaseMemory ()=0
 Release all pointed memory holden by wrapper. More...
 
virtual std::string fullName () const =0
 Get full wrapper name. More...
 
virtual void print (MSG::Level lvl=MSG::DEBUG) const =0
 Print wrapper content. 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"
 

Protected Member Functions

 IRingerProcedureWrapper ()
 

Detailed Description

Definition at line 27 of file RingerPreProcessorWrapper.h.

Member Typedef Documentation

◆ WrapperCollection

Collection type of PreProcessor Wrappers.

Definition at line 35 of file RingerPreProcessorWrapper.h.

Constructor & Destructor Documentation

◆ ~IRingerProcedureWrapper()

Ensure virtual destructor.

Definition at line 104 of file RingerPreProcessorWrapper.h.

104 {;}

◆ IRingerProcedureWrapper()

Definition at line 107 of file RingerPreProcessorWrapper.h.

107 {;}

Member Function Documentation

◆ applyPreProcessing() [1/2]

virtual void Ringer::IRingerProcedureWrapper< PreProcessing::IPreProcessor >::applyPreProcessing ( const DepVarStruct depVar,
const xAOD::CaloRings clrings,
const TrackPatternsHolder *  trackPat,
std::vector< float > &  transformVec 
) const
pure virtual

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.

Implemented in Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, true, false, false >.

◆ applyPreProcessing() [2/2]

virtual void Ringer::IRingerProcedureWrapper< PreProcessing::IPreProcessor >::applyPreProcessing ( const DepVarStruct depVar,
std::vector< float > &  transformVec 
) const
pure virtual

Apply PP to transform input space into a new representation.

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

Implemented in Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, true, false, false >.

◆ empty()

virtual bool Ringer::IRingerProcedureWrapperBase::empty ( ) const
pure virtualinherited

◆ etaDep()

virtual EtaDependency Ringer::IRingerProcedureWrapperBase::etaDep ( ) const
pure virtualinherited

◆ etDep()

virtual EtDependency Ringer::IRingerProcedureWrapperBase::etDep ( ) const
pure virtualinherited

◆ fullName()

virtual std::string Ringer::IRingerProcedureWrapperBase::fullName ( ) const
pure virtualinherited

◆ getRawConfCol()

virtual void Ringer::IRingerProcedureWrapper< PreProcessing::IPreProcessor >::getRawConfCol ( const xAOD::RingSetConf::RawConfCollection *&  crRawConfCol) const
pure virtual

◆ getSegType()

virtual SegmentationType Ringer::IRingerProcedureWrapper< PreProcessing::IPreProcessor >::getSegType ( ) const
pure virtual

◆ name()

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

Returns this wrapper name.

Implements Ringer::IRingerProcedureWrapperBase.

Definition at line 83 of file RingerPreProcessorWrapper.h.

83  {
84  return wrapName;
85  }

◆ print()

virtual void Ringer::IRingerProcedureWrapperBase::print ( MSG::Level  lvl = MSG::DEBUG) const
pure virtualinherited

◆ read()

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

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

◆ releaseMemory()

virtual void Ringer::IRingerProcedureWrapperBase::releaseMemory ( )
pure virtualinherited

◆ setRawConfCol()

virtual void Ringer::IRingerProcedureWrapper< PreProcessing::IPreProcessor >::setRawConfCol ( const xAOD::RingSetConf::RawConfCollection crRawConfCol)
pure virtual

◆ write()

virtual void Ringer::IRingerProcedureWrapperBase::write ( TDirectory *  baseDir,
const char *  idxStr = "" 
) const
pure virtualinherited

◆ writeCol()

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

Write all wrappers on ppWrapperCol to TDirectory.

Member Data Documentation

◆ wrapName

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

Definition at line 101 of file RingerPreProcessorWrapper.h.


The documentation for this class was generated from the following file:
Ringer::IRingerProcedureWrapper< PreProcessing::IPreProcessor >::wrapName
static constexpr const char * wrapName
Definition: RingerPreProcessorWrapper.h:101