#include <RingerDiscriminatorWrapper.h>

Inheritance diagram for Ringer::IRingerProcedureWrapper< Discrimination::IDiscriminator >:

Collaboration diagram for Ringer::IRingerProcedureWrapper< Discrimination::IDiscriminator >:

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

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

virtual bool	hasPP () const =0
	Returns whether it has Pre-Processing Collection Wrapper. 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...


virtual void	execute (const DepVarStruct &depVar, const xAOD::CaloRings clrings, const TrackPatternsHolder trackPat, std::vector< float > &output) const =0
	Main methods: 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 const Ringer::ExtraDescriptionPatterns &	getExtraDescriptionPatterns () const =0
	Get extra description patterns being used. 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 =0

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"

Protected Member Functions
	IRingerProcedureWrapper ()

Detailed Description

Definition at line 35 of file RingerDiscriminatorWrapper.h.

Member Typedef Documentation

◆ WrapperCollection

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

Collection type of Discriminators Wrappers.

Definition at line 43 of file RingerDiscriminatorWrapper.h.

Constructor & Destructor Documentation

◆ IRingerProcedureWrapper()

Ringer::IRingerProcedureWrapper< Discrimination::IDiscriminator >::IRingerProcedureWrapper ( )

inlineprotected

Definition at line 132 of file RingerDiscriminatorWrapper.h.

132 {;}

Member Function Documentation

◆ empty()

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

pure virtualinherited

Returns whether holden interface collection is empty.

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

◆ etaDep()

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

pure virtualinherited

Returns eta dependecy for this wrapper.

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

◆ etDep()

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

pure virtualinherited

Returns et dependecy for this wrapper.

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

◆ execute() [1/2]

virtual void Ringer::IRingerProcedureWrapper< Discrimination::IDiscriminator >::execute	(	const DepVarStruct &	depVar,
		const std::vector< float > &	input,
		std::vector< float > &	output
	)		const

pure virtual

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

◆ execute() [2/2]

virtual void Ringer::IRingerProcedureWrapper< Discrimination::IDiscriminator >::execute	(	const DepVarStruct &	depVar,
		const xAOD::CaloRings *	clrings,
		const TrackPatternsHolder *	trackPat,
		std::vector< float > &	output
	)		const

pure virtual

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.

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

◆ fullName()

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

pure virtualinherited

Get full wrapper name.

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

◆ getExtraDescriptionPatterns()

virtual const Ringer::ExtraDescriptionPatterns& Ringer::IRingerProcedureWrapper< Discrimination::IDiscriminator >::getExtraDescriptionPatterns ( ) const

pure virtual

Get extra description patterns being used.

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

◆ getRawConfCol()

virtual void Ringer::IRingerProcedureWrapper< Discrimination::IDiscriminator >::getRawConfCol ( const xAOD::RingSetConf::RawConfCollection *& crRawConfCol ) const

pure virtual

Get the holden CaloRings raw configuration collection.

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

◆ getSegType()

virtual SegmentationType Ringer::IRingerProcedureWrapper< Discrimination::IDiscriminator >::getSegType ( ) const

pure virtual

Get segmentation type for this pre-processing.

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

◆ hasPP()

virtual bool Ringer::IRingerProcedureWrapper< Discrimination::IDiscriminator >::hasPP ( ) const

pure virtual

Returns whether it has Pre-Processing Collection Wrapper.

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

◆ name()

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

inlinefinaloverridevirtual

Returns this wrapper name.

Implements Ringer::IRingerProcedureWrapperBase.

Definition at line 106 of file RingerDiscriminatorWrapper.h.

                                                     {
       return wrapName;
     }

◆ print()

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

pure virtualinherited

Print wrapper content.

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

◆ read()

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

static

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

◆ releaseMemory()

virtual void Ringer::IRingerProcedureWrapperBase::releaseMemory ( )

pure virtualinherited

Release all pointed memory holden by wrapper.

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

◆ setRawConfCol()

virtual void Ringer::IRingerProcedureWrapper< Discrimination::IDiscriminator >::setRawConfCol ( const xAOD::RingSetConf::RawConfCollection * crRawConfCol )

pure virtual

Set the holden CaloRings raw configuration collection.

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

◆ write()

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

pure virtualinherited

Write collection to TDirectory.

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

◆ writeCol()

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

static

Write all wrappers on discrWrapperCol to TDirectory.

Member Data Documentation

◆ wrapName

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

staticconstexpr

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

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ WrapperCollection

Constructor & Destructor Documentation

◆ IRingerProcedureWrapper()

Member Function Documentation

◆ empty()

◆ etaDep()

◆ etDep()

◆ execute() [1/2]

◆ execute() [2/2]

◆ fullName()

◆ getExtraDescriptionPatterns()

◆ getRawConfCol()

◆ getSegType()

◆ hasPP()

◆ name()

◆ print()

◆ read()

◆ releaseMemory()

◆ setRawConfCol()

◆ write()

◆ writeCol()

Member Data Documentation

◆ wrapName