Ringer::PreProcessing::IPreProcessorVarDep Class Reference

PreProcessor interface to be used by Ringer Wrapper. More...

#include <IRingerProcedure.h>

Inherits Ringer::VariableDependency, and Ringer::PreProcessing::IPreProcessor.

Inherited by Ringer::PreProcessing::Norm::ConstantValueVarDep [virtual], Ringer::PreProcessing::Norm::ExtraPatternsNormVarDep [virtual], Ringer::PreProcessing::Norm::MevToGevVarDep [virtual], Ringer::PreProcessing::Norm::MinMaxVarDep [virtual], Ringer::PreProcessing::Norm::Norm1VarDep [virtual], Ringer::PreProcessing::Norm::Norm2VarDep [virtual], Ringer::PreProcessing::Norm::SequentialVarDep [virtual], Ringer::PreProcessing::Norm::SpherizationVarDep [virtual], and Ringer::PreProcessing::Norm::SqrtVarDep [virtual].

Collaboration diagram for Ringer::PreProcessing::IPreProcessorVarDep:

Public Member Functions
bool	isWithinRange (const DepVarStruct &depVar) const
	Check if depVar is within this procedure range. More...
bool	isWithinEtaRange (const float eta) const
	Check if eta is within this procedure range. More...
EtaDependency	etaDep () const
	Returns whether it is et dependent. More...
float	etaMin () const
	Get eta min. More...
float	etaMax () const
	Get eta max. More...
float	etMin () const
	Get et min. More...
float	etMax () const
	Get et max. More...
void	setEtaDep (const float etaMin, const float etaMax)
	Set this procedure to be eta dependent: More...
bool	isWithinEtRange (const float et) const
	Check if et is within this procedure et range. More...
EtDependency	etDep () const
	Returns whether it is et dependent. More...
void	setEtDep (const float etMin, const float etMax)
	Set this procedure to be et dependent. More...
void	setEtaEtDep (const float etaMin, const float etaMax, const float etMin, const float etMax)
	Set this procedure to be et dependent. More...
std::string	type () const
	Return this variable dependency string. More...
void	writeDepInfo (TDirectory *configDir) const
	Write variable dependency to directory. More...
virtual void	write (TDirectory *configDir, const char *idxStr="") const =0
	Write Ringer procedure to configuration directory. More...

Static Public Member Functions
static IPreProcessorVarDep *	read (TDirectory *)
static void	read (VariableDependency *varDep, TDirectory *configDir, unsigned writtenVersion)
	Read variable dependency from directory. More...

Private Attributes
EtaDependency	m_etaDependency {EtaDependency::EtaIndependent}
	Whether there is eta dependency. More...
EtDependency	m_etDependency {EtDependency::EtIndependent}
	Whether there is et dependency. More...
float	m_etaMin {0}
	Eta bounded region where RingerProcedure may be applied. More...
float	m_etaMax {0}
float	m_etMin {0}
	Et bounded region where RingerProcedure may be applied. More...
float	m_etMax {0}

Detailed Description

PreProcessor interface to be used by Ringer Wrapper.

Definition at line 267 of file IRingerProcedure.h.

Member Function Documentation

etaDep()

EtaDependency Ringer::VariableDependency::etaDep ( ) const

inherited

Returns whether it is et dependent.

etaMax()

float Ringer::VariableDependency::etaMax ( ) const

inherited

Get eta max.

etaMin()

float Ringer::VariableDependency::etaMin ( ) const

inherited

Get eta min.

etDep()

EtDependency Ringer::VariableDependency::etDep ( ) const

inherited

Returns whether it is et dependent.

etMax()

float Ringer::VariableDependency::etMax ( ) const

inherited

Get et max.

etMin()

float Ringer::VariableDependency::etMin ( ) const

inherited

Get et min.

execute()

virtual void Ringer::PreProcessing::IPreProcessor::execute ( std::vector< float > &  inputSpace ) const

pure virtualinherited

Implemented in Ringer::PreProcessing::Norm::ExtraPatternsNorm, Ringer::PreProcessing::Norm::MinMax, Ringer::PreProcessing::Norm::Spherization, Ringer::PreProcessing::Norm::Sequential, Ringer::PreProcessing::Norm::ConstantValue, Ringer::PreProcessing::Norm::Sqrt, Ringer::PreProcessing::Norm::Norm2, and Ringer::PreProcessing::Norm::Norm1.

isWithinEtaRange()

bool Ringer::VariableDependency::isWithinEtaRange ( const float  eta ) const

inherited

Check if eta is within this procedure range.

isWithinEtRange()

bool Ringer::VariableDependency::isWithinEtRange ( const float  et ) const

inherited

Check if et is within this procedure et range.

isWithinRange()

bool Ringer::VariableDependency::isWithinRange ( const DepVarStruct &  depVar ) const

inherited

Check if depVar is within this procedure range.

read() [1/2]

static IPreProcessorVarDep* Ringer::PreProcessing::IPreProcessorVarDep::read ( TDirectory *  )

inlinestatic

Definition at line 277 of file IRingerProcedure.h.

{ return nullptr;}

read() [2/2]

static void Ringer::VariableDependency::read ( VariableDependency *  varDep, TDirectory *  configDir, unsigned  writtenVersion  )

staticinherited

Read variable dependency from directory.

setEtaDep()

void Ringer::VariableDependency::setEtaDep ( const float  etaMin, const float  etaMax  )

inherited

Set this procedure to be eta dependent:

setEtaEtDep()

void Ringer::VariableDependency::setEtaEtDep ( const float  etaMin, const float  etaMax, const float  etMin, const float  etMax  )

inherited

Set this procedure to be et dependent.

setEtDep()

void Ringer::VariableDependency::setEtDep ( const float  etMin, const float  etMax  )

inherited

Set this procedure to be et dependent.

type()

std::string Ringer::VariableDependency::type ( ) const

inherited

Return this variable dependency string.

This is not a virtual method.

write()

virtual void Ringer::IRingerProcedure::write ( TDirectory *  configDir, const char *  idxStr = ""  ) const

pure virtualinherited

Write Ringer procedure to configuration directory.

writeDepInfo()

void Ringer::VariableDependency::writeDepInfo ( TDirectory *  configDir ) const

inherited

Write variable dependency to directory.

This is not a virtual method.

Member Data Documentation

m_etaDependency

EtaDependency Ringer::VariableDependency::m_etaDependency {EtaDependency::EtaIndependent}

privateinherited

Whether there is eta dependency.

Definition at line 225 of file VariableDependency.h.

m_etaMax

float Ringer::VariableDependency::m_etaMax {0}

privateinherited

Definition at line 230 of file VariableDependency.h.

m_etaMin

float Ringer::VariableDependency::m_etaMin {0}

privateinherited

Eta bounded region where RingerProcedure may be applied.

Definition at line 230 of file VariableDependency.h.

m_etDependency

EtDependency Ringer::VariableDependency::m_etDependency {EtDependency::EtIndependent}

privateinherited

Whether there is et dependency.

Definition at line 227 of file VariableDependency.h.

m_etMax

float Ringer::VariableDependency::m_etMax {0}

privateinherited

Definition at line 233 of file VariableDependency.h.

m_etMin

float Ringer::VariableDependency::m_etMin {0}

privateinherited

Et bounded region where RingerProcedure may be applied.

Definition at line 233 of file VariableDependency.h.

---

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

• IRingerProcedure.h