#include <RingerDiscriminatorWrapper.h>

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

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

Public Types
typedef std::vector< IRingerProcedureWrapper * >	WrapperCollection
	Collection type of Discriminators Wrappers. More...


typedef std::vector< std::vector< std::vector< procedure_t * > > >	DiscrDepProcCollection
	RingerProcedureWrapper for Discrimination procedures typedefs: More...

typedef std::vector< std::vector< Ringer::PreProcessing::Norm::ExtraPatternsNorm * > >	ExtraPatternsNormCollection
	Extra patterns normalization vector. More...

Public Member Functions
virtual const char *	name () const final override
	Returns this wrapper name. More...


	RingerProcedureWrapper (const DiscrDepProcCollection &discrDepCol)
	Ctors: More...

	RingerProcedureWrapper (const IPreProcWrapperCollection &ppCol, const DiscrDepProcCollection &discrDepCol)
	Build RProc Wrapper with all functionallities. More...


virtual void	execute (const DepVarStruct &depVar, const xAOD::CaloRings clrings, const TrackPatternsHolder trackPat, std::vector< float > &output) const override final
	Main methods: More...

input information to the
Apply discriminator to obtain its output representation This method will pass pre-processors (if any) and afterwards feed the classifier. This overload is only available if SegmentationType is set to NoSegmentation (there is no section/layer segmentation information available on this method).
virtual void	execute (const DepVarStruct &depVar, const std::vector< float > &input, std::vector< float > &output) const override final

Static Public Member Functions
static void	writeCol (const WrapperCollection &discrWrapperCol, const char *fileName)
	Write all wrappers on discrWrapperCol to TDirectory. More...

static void	read (WrapperCollection &discrWrapperCol, const char *fileName)
	Read all discriminator on file at the path and append them to IPreProcWrapperCollection. More...

Static Public Attributes
static constexpr const char *	wrapName = "RingerDiscriminatorWrapper"

Private Member Functions

void	checkPPWrapperCol () const
	Private methods. More...

void	checkExtraPatNorm () const
	Check if exra pattern is in good status (Throws otherwise) More...

void	checkDiscrCol () const
	Check if discriminators interface collection is in good status (Throws otherwise) More...

Private Attributes

const IPreProcWrapperCollection	m_ppWrapperCol
	Properties. More...

DiscrDepProcCollection	m_discrCol
	holden discriminator collection: More...

ExtraPatternsNormCollection	m_extraDescriptionNorms
	Hold the normalization to be used by each bin to the extra patterns. More...

ExtraDescriptionPatterns	m_extraDescriptionPatterns
	contains a pointer into the CaloRings configuration More...

procedure_t *	m_discr
	hold pointer to first collection position: More...

const xAOD::RingSetConf::RawConfCollection *	m_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 override final
	Get the holden CaloRings raw configuration collection. More...

virtual const Ringer::ExtraDescriptionPatterns &	getExtraDescriptionPatterns () const override final
	Get extra description patterns being used. More...

void	setExtraDescriptionPatterns (const Ringer::ExtraDescriptionPatterns &extraPat)
	Get extra description patterns being used. More...

ExtraPatternsNormCollection &	getExtraDescriptionNorms ()
	Get extra description patterns being used. More...

void	setExtraDescriptionNorms (const ExtraPatternsNormCollection &extraNorms)
	Get extra description patterns being used. More...

virtual SegmentationType	getSegType () const override final
	Get segmentation type for this pre-processor. More...

virtual bool	empty () const override
	Returns whether holden interface collection is empty. More...

virtual bool	hasPP () const override
	Returns whether it has pre-processing Collection Wrapper. More...

virtual void	setMsgStream (MsgStream *msg) const override
	Overloads the setMsgStream from RedirectMsgStream. More...

void	write (TDirectory baseDir, const char idxStr="") const override final
	Write collection to TDirectory. 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...

void	print (MSG::Level lvl=MSG::DEBUG) const override final
	Print wrapper content. More...

std::string	fullName () const override final
	Get full wrapper name. More...

static std::string	staticFullName ()
	Get full wrapper name, static method. More...

static RingerProcedureWrapper *	read (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, false, true, false >

Definition at line 155 of file RingerDiscriminatorWrapper.h.

Member Typedef Documentation

◆ DiscrDepProcCollection

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, false, true, false >::DiscrDepProcCollection

RingerProcedureWrapper for Discrimination procedures typedefs:

typedef to base wrapper

typedef to the Ringer Interface variable dependency collection

Collection Dimension: [segType][etBin][etaBin]:

Definition at line 188 of file RingerDiscriminatorWrapper.h.

◆ ExtraPatternsNormCollection

template<class procedure_t , int etaDependency, int etDependency, int segType>

typedef std::vector< std::vector< Ringer::PreProcessing::Norm::ExtraPatternsNorm* > > Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, false, true, false >::ExtraPatternsNormCollection

Extra patterns normalization vector.

Collection Dimension [etBin][etaBin]

Definition at line 197 of file RingerDiscriminatorWrapper.h.

◆ WrapperCollection

typedef std::vector< IRingerProcedureWrapper* > Ringer::IRingerProcedureWrapper< Discrimination::IDiscriminator >::WrapperCollection

inherited

Collection type of Discriminators Wrappers.

Definition at line 43 of file RingerDiscriminatorWrapper.h.

Constructor & Destructor Documentation

◆ RingerProcedureWrapper() [1/2]

template<class procedure_t , int etaDependency, int etDependency, int segType>

Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, false, true, false >::RingerProcedureWrapper ( const DiscrDepProcCollection & discrDepCol )

inline

Ctors:

Build RProc Wrapper with no pre-processor

Definition at line 205 of file RingerDiscriminatorWrapper.h.

                                                   :
       m_ppWrapperCol(IPreProcWrapperCollection(0)),
       m_discrCol(discrDepCol),
       m_discr(nullptr),
       m_rsRawConfCol(nullptr),
       m_nRings(0)
     {
       checkDiscrCol();
     }

◆ RingerProcedureWrapper() [2/2]

template<class procedure_t , int etaDependency, int etDependency, int segType>

Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, false, true, false >::RingerProcedureWrapper	(	const IPreProcWrapperCollection &	ppCol,
		const DiscrDepProcCollection &	discrDepCol
	)

inline

Build RProc Wrapper with all functionallities.

Definition at line 219 of file RingerDiscriminatorWrapper.h.

                                                   :
       m_ppWrapperCol(ppCol),
       m_discrCol(discrDepCol),
       m_discr(nullptr),
       m_rsRawConfCol(nullptr),
       m_nRings(0)
     {
       checkPPWrapperCol();
       checkDiscrCol();
     }

Member Function Documentation

◆ checkDiscrCol()

template<class procedure_t , int etaDependency, int etDependency, int segType>

void Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, false, true, false >::checkDiscrCol ( ) const

private

Check if discriminators interface collection is in good status (Throws otherwise)

◆ checkExtraPatNorm()

template<class procedure_t , int etaDependency, int etDependency, int segType>

void Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, false, true, false >::checkExtraPatNorm ( ) const

private

Check if exra pattern is in good status (Throws otherwise)

◆ checkPPWrapperCol()

template<class procedure_t , int etaDependency, int etDependency, int segType>

void Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, false, true, false >::checkPPWrapperCol ( ) const

private

Private methods.

Check if input PP Wrapper 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, false, true, false >::empty ( ) const

inlineoverridevirtual

Returns whether holden interface collection is empty.

Implements Ringer::IRingerProcedureWrapperBase.

Definition at line 335 of file RingerDiscriminatorWrapper.h.

335 { return m_discrCol.empty();}

◆ etaDep()

template<class procedure_t , int etaDependency, int etDependency, int segType>

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

inlinefinaloverridevirtual

Returns eta dependecy for this wrapper.

Implements Ringer::IRingerProcedureWrapperBase.

Definition at line 355 of file RingerDiscriminatorWrapper.h.

     {
       return static_cast<EtaDependency>(etaDependency);
     }

◆ etDep()

template<class procedure_t , int etaDependency, int etDependency, int segType>

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

inlinefinaloverridevirtual

Returns et dependecy for this wrapper.

Implements Ringer::IRingerProcedureWrapperBase.

Definition at line 363 of file RingerDiscriminatorWrapper.h.

     {
       return static_cast<EtDependency>(etDependency);
     }

◆ execute() [1/2]

template<class procedure_t , int etaDependency, int etDependency, int segType>

virtual void Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, false, true, false >::execute	(	const DepVarStruct &	depVar,
		const std::vector< float > &	input,
		std::vector< float > &	output
	)		const

finaloverridevirtual

Implements Ringer::IRingerProcedureWrapper< Discrimination::IDiscriminator >.

◆ execute() [2/2]

template<class procedure_t , int etaDependency, int etDependency, int segType>

virtual void Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, false, true, false >::execute	(	const DepVarStruct &	depVar,
		const xAOD::CaloRings *	clrings,
		const TrackPatternsHolder *	trackPat,
		std::vector< float > &	output
	)		const

finaloverridevirtual

Main methods:

Apply discriminator to obtain its output representation

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

Implements Ringer::IRingerProcedureWrapper< Discrimination::IDiscriminator >.

◆ fullName()

template<class procedure_t , int etaDependency, int etDependency, int segType>

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

finaloverridevirtual

Get full wrapper name.

Implements Ringer::IRingerProcedureWrapperBase.

◆ getExtraDescriptionNorms()

template<class procedure_t , int etaDependency, int etDependency, int segType>

ExtraPatternsNormCollection& Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, false, true, false >::getExtraDescriptionNorms ( )

inline

Get extra description patterns being used.

Definition at line 314 of file RingerDiscriminatorWrapper.h.

314 { return m_extraDescriptionNorms; }

◆ getExtraDescriptionPatterns()

template<class procedure_t , int etaDependency, int etDependency, int segType>

virtual const Ringer::ExtraDescriptionPatterns& Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, false, true, false >::getExtraDescriptionPatterns ( ) const

inlinefinaloverridevirtual

Get extra description patterns being used.

Implements Ringer::IRingerProcedureWrapper< Discrimination::IDiscriminator >.

Definition at line 298 of file RingerDiscriminatorWrapper.h.

     {
       return m_extraDescriptionPatterns;
     }

◆ getRawConfCol()

template<class procedure_t , int etaDependency, int etDependency, int segType>

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

inlinefinaloverridevirtual

Get the holden CaloRings raw configuration collection.

Implements Ringer::IRingerProcedureWrapper< Discrimination::IDiscriminator >.

Definition at line 288 of file RingerDiscriminatorWrapper.h.

     {
       crRawConfCol = m_rsRawConfCol;
     }

◆ getSegType()

template<class procedure_t , int etaDependency, int etDependency, int segType>

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

inlinefinaloverridevirtual

Get segmentation type for this pre-processor.

Implements Ringer::IRingerProcedureWrapper< Discrimination::IDiscriminator >.

Definition at line 327 of file RingerDiscriminatorWrapper.h.

     {
       return static_cast<SegmentationType>(segType);
     }

◆ hasPP()

template<class procedure_t , int etaDependency, int etDependency, int segType>

virtual bool Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, false, true, false >::hasPP ( ) const

inlineoverridevirtual

Returns whether it has pre-processing Collection Wrapper.

Implements Ringer::IRingerProcedureWrapper< Discrimination::IDiscriminator >.

Definition at line 340 of file RingerDiscriminatorWrapper.h.

340 { return !m_ppWrapperCol.empty();}

◆ name()

virtual const char* Ringer::IRingerProcedureWrapper< Discrimination::IDiscriminator >::name ( ) const

inlinefinaloverridevirtualinherited

Returns this wrapper name.

Implements Ringer::IRingerProcedureWrapperBase.

Definition at line 106 of file RingerDiscriminatorWrapper.h.

                                                     {
       return wrapName;
     }

◆ print()

template<class procedure_t , int etaDependency, int etDependency, int segType>

void Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, false, true, 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, false, true, false >::read	(	TDirectory *	configDir,
		unsigned	version
	)

static

Read collection from TDirectory.

◆ read() [2/2]

static void Ringer::IRingerProcedureWrapper< Discrimination::IDiscriminator >::read	(	WrapperCollection &	discrWrapperCol,
		const char *	fileName
	)

staticinherited

Read all discriminator on file at the path and append them to IPreProcWrapperCollection.

◆ releaseMemory()

template<class procedure_t , int etaDependency, int etDependency, int segType>

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

finaloverridevirtual

Release all holden pointer memory.

Implements Ringer::IRingerProcedureWrapperBase.

◆ setExtraDescriptionNorms()

template<class procedure_t , int etaDependency, int etDependency, int segType>

void Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, false, true, false >::setExtraDescriptionNorms ( const ExtraPatternsNormCollection & extraNorms )

inline

Get extra description patterns being used.

Definition at line 319 of file RingerDiscriminatorWrapper.h.

                                                                                   {
       m_extraDescriptionNorms = extraNorms;
       checkExtraPatNorm();
     }

◆ setExtraDescriptionPatterns()

template<class procedure_t , int etaDependency, int etDependency, int segType>

void Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, false, true, false >::setExtraDescriptionPatterns ( const Ringer::ExtraDescriptionPatterns & extraPat )

inline

Get extra description patterns being used.

Definition at line 306 of file RingerDiscriminatorWrapper.h.

     {
       m_extraDescriptionPatterns = extraPat;
     }

◆ setMsgStream()

template<class procedure_t , int etaDependency, int etDependency, int segType>

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

overridevirtual

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, false, true, false >::setRawConfCol ( const xAOD::RingSetConf::RawConfCollection * crRawConfCol )

inlinefinaloverridevirtual

Other utilities:

Set the holden CaloRings raw configuration collection.

Implements Ringer::IRingerProcedureWrapper< Discrimination::IDiscriminator >.

Definition at line 274 of file RingerDiscriminatorWrapper.h.

     {
       for ( auto &ppWrapper : m_ppWrapperCol ) {
         ppWrapper->setRawConfCol( crRawConfCol );
       }
       m_rsRawConfCol = crRawConfCol;
       m_nRings = xAOD::RingSetConf::totalNumberOfRings( *crRawConfCol );
     }

◆ staticFullName()

template<class procedure_t , int etaDependency, int etDependency, int segType>

static std::string Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, false, true, 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, false, true, false >::write	(	TDirectory *	baseDir,
		const char *	idxStr = `""`
	)		const

finaloverridevirtual

Write collection to TDirectory.

Implements Ringer::IRingerProcedureWrapperBase.

◆ writeCol()

static void Ringer::IRingerProcedureWrapper< Discrimination::IDiscriminator >::writeCol	(	const WrapperCollection &	discrWrapperCol,
		const char *	fileName
	)

staticinherited

Write all wrappers on discrWrapperCol to TDirectory.

Member Data Documentation

◆ m_discr

template<class procedure_t , int etaDependency, int etDependency, int segType>

procedure_t* Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, false, true, false >::m_discr

private

hold pointer to first collection position:

Definition at line 426 of file RingerDiscriminatorWrapper.h.

◆ m_discrCol

template<class procedure_t , int etaDependency, int etDependency, int segType>

DiscrDepProcCollection Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, false, true, false >::m_discrCol

private

holden discriminator collection:

Definition at line 420 of file RingerDiscriminatorWrapper.h.

◆ m_extraDescriptionNorms

template<class procedure_t , int etaDependency, int etDependency, int segType>

ExtraPatternsNormCollection Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, false, true, false >::m_extraDescriptionNorms

private

Hold the normalization to be used by each bin to the extra patterns.

Definition at line 422 of file RingerDiscriminatorWrapper.h.

◆ m_extraDescriptionPatterns

template<class procedure_t , int etaDependency, int etDependency, int segType>

ExtraDescriptionPatterns Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, false, true, false >::m_extraDescriptionPatterns

private

contains a pointer into the CaloRings configuration

Definition at line 424 of file RingerDiscriminatorWrapper.h.

◆ m_nRings

template<class procedure_t , int etaDependency, int etDependency, int segType>

unsigned Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, false, true, false >::m_nRings

private

contains the total number of rings in the vectorized representation

Definition at line 433 of file RingerDiscriminatorWrapper.h.

◆ m_ppWrapperCol

template<class procedure_t , int etaDependency, int etDependency, int segType>

const IPreProcWrapperCollection Ringer::RingerProcedureWrapper< procedure_t, etaDependency, etDependency, segType, false, true, false >::m_ppWrapperCol

private

Properties.

Discriminator preprocessing collection routines

Definition at line 418 of file RingerDiscriminatorWrapper.h.

◆ m_rsRawConfCol

template<class procedure_t , int etaDependency, int etDependency, int segType>

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

private

contains a pointer into the CaloRings configuration

Definition at line 430 of file RingerDiscriminatorWrapper.h.

◆ wrapName

constexpr const char* Ringer::IRingerProcedureWrapper< Discrimination::IDiscriminator >::wrapName = "RingerDiscriminatorWrapper"

staticconstexprinherited

Definition at line 110 of file RingerDiscriminatorWrapper.h.

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

RingerDiscriminatorWrapper.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

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

Member Typedef Documentation

◆ DiscrDepProcCollection

◆ ExtraPatternsNormCollection

◆ WrapperCollection

Constructor & Destructor Documentation

◆ RingerProcedureWrapper() [1/2]

◆ RingerProcedureWrapper() [2/2]

Member Function Documentation

◆ checkDiscrCol()

◆ checkExtraPatNorm()

◆ checkPPWrapperCol()

◆ empty()

◆ etaDep()

◆ etDep()

◆ execute() [1/2]

◆ execute() [2/2]

◆ fullName()

◆ getExtraDescriptionNorms()

◆ getExtraDescriptionPatterns()

◆ getRawConfCol()

◆ getSegType()

◆ hasPP()

◆ name()

◆ print()

◆ read() [1/2]

◆ read() [2/2]

◆ releaseMemory()

◆ setExtraDescriptionNorms()

◆ setExtraDescriptionPatterns()

◆ setMsgStream()

◆ setRawConfCol()

◆ staticFullName()

◆ write()

◆ writeCol()

Member Data Documentation

◆ m_discr

◆ m_discrCol

◆ m_extraDescriptionNorms

◆ m_extraDescriptionPatterns

◆ m_nRings

◆ m_ppWrapperCol

◆ m_rsRawConfCol

◆ wrapName

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