ATLAS Offline Software
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
Ringer::PreProcessing::Norm::ExtraPatternsNormVarDep Class Referenceabstract

Normalize data to be bounded within [-1,1] range. More...

#include <Normalizations.h>

Inheritance diagram for Ringer::PreProcessing::Norm::ExtraPatternsNormVarDep:
Collaboration diagram for Ringer::PreProcessing::Norm::ExtraPatternsNormVarDep:

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...
 
std::string name () const
 Retrieve name for this RingerIOVarDepObj. More...
 
void write (TDirectory *baseDir, const char *idxStr="") const
 Write Ringer procedure to configuration directory. More...
 
ExtraPatternsNormsetEtNormParams (float min, float max)
 Set eta normalization params. More...
 
ExtraPatternsNormsetEtaNormParams (float min, float max)
 Set eta normalization params. More...
 
ExtraPatternsNormsetPileupEstimationParams (float max)
 Set eta normalization params. More...
 
float normEta (float eta) const
 Retrieve normalized eta. More...
 
float normEt (float et) const
 Retrieve normalized et. More...
 
float normPileupEstimation (float pileupEstimation) const
 Retrieve normalized pile-up estimation. More...
 
void write (TDirectory *baseDir, const char *idxStr="") const
 Write Ringer procedure to configuration directory. More...
 
std::string name () const
 Retrieve name for this RingerIOVarDepObj. More...
 

Static Public Member Functions

static IPreProcessorVarDepread (TDirectory *)
 
static void read (VariableDependency *varDep, TDirectory *configDir, unsigned writtenVersion)
 Read variable dependency from directory. More...
 
static ExtraPatternsNormVarDepread (TDirectory *configDir)
 Read Ringer procedure from configuration dir. More...
 
static ExtraPatternsNormread (TDirectory *configDir)
 Read Ringer procedure from configuration dir. 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}
 
float m_pileupEstimationMax
 Min and Max eta normalization factors. More...
 

Detailed Description

Normalize data to be bounded within [-1,1] range.

Definition at line 480 of file Normalizations.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

◆ 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.

◆ name() [1/2]

std::string Ringer::RingerIOVarDepObj< ExtraPatternsNormVarDep >::name
inherited

Retrieve name for this RingerIOVarDepObj.

◆ name() [2/2]

std::string Ringer::RingerIOVarDepObj< ExtraPatternsNorm >::name ( ) const
inherited

Retrieve name for this RingerIOVarDepObj.

◆ normEt()

float Ringer::PreProcessing::Norm::ExtraPatternsNorm::normEt ( float  et) const
inherited

Retrieve normalized et.

◆ normEta()

float Ringer::PreProcessing::Norm::ExtraPatternsNorm::normEta ( float  eta) const
inherited

Retrieve normalized eta.

◆ normPileupEstimation()

float Ringer::PreProcessing::Norm::ExtraPatternsNorm::normPileupEstimation ( float  pileupEstimation) const
inherited

Retrieve normalized pile-up estimation.

◆ read() [1/4]

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

Definition at line 277 of file IRingerProcedure.h.

277 { return nullptr;}

◆ read() [2/4]

static ExtraPatternsNormVarDep * Ringer::RingerIOVarDepObj< ExtraPatternsNormVarDep >::read ( TDirectory *  configDir)
staticinherited

Read Ringer procedure from configuration dir.

◆ read() [3/4]

static ExtraPatternsNorm * Ringer::RingerIOVarDepObj< ExtraPatternsNorm >::read ( TDirectory *  configDir)
staticinherited

Read Ringer procedure from configuration dir.

◆ read() [4/4]

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.

◆ setEtaNormParams()

ExtraPatternsNorm& Ringer::PreProcessing::Norm::ExtraPatternsNorm::setEtaNormParams ( float  min,
float  max 
)
inlineinherited

Set eta normalization params.

Definition at line 261 of file Normalizations.h.

261 { m_etaMin = min; m_etaMax = max; return *this; }

◆ setEtDep()

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

Set this procedure to be et dependent.

◆ setEtNormParams()

ExtraPatternsNorm& Ringer::PreProcessing::Norm::ExtraPatternsNorm::setEtNormParams ( float  min,
float  max 
)
inlineinherited

Set eta normalization params.

Definition at line 256 of file Normalizations.h.

256 { m_etMin = min; m_etMax = max; return *this; }

◆ setPileupEstimationParams()

ExtraPatternsNorm& Ringer::PreProcessing::Norm::ExtraPatternsNorm::setPileupEstimationParams ( float  max)
inlineinherited

Set eta normalization params.

Definition at line 266 of file Normalizations.h.

266 { m_pileupEstimationMax = max; return *this; }

◆ type()

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

Return this variable dependency string.

This is not a virtual method.

◆ write() [1/3]

void Ringer::RingerIOVarDepObj< ExtraPatternsNorm >::write ( TDirectory *  baseDir,
const char *  idxStr = "" 
) const
inherited

Write Ringer procedure to configuration directory.

◆ write() [2/3]

void Ringer::RingerIOVarDepObj< ExtraPatternsNormVarDep >::write ( TDirectory *  baseDir,
const char *  idxStr = "" 
) const
inherited

Write Ringer procedure to configuration directory.

◆ write() [3/3]

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.

◆ m_pileupEstimationMax

float Ringer::PreProcessing::Norm::ExtraPatternsNorm::m_pileupEstimationMax
privateinherited

Min and Max eta normalization factors.

Definition at line 290 of file Normalizations.h.


The documentation for this class was generated from the following file:
max
#define max(a, b)
Definition: cfImp.cxx:41
Ringer::PreProcessing::Norm::ExtraPatternsNorm::m_etaMin
float m_etaMin
Min and Max eta normalization factors.
Definition: Normalizations.h:288
Ringer::PreProcessing::Norm::ExtraPatternsNorm::m_pileupEstimationMax
float m_pileupEstimationMax
Min and Max eta normalization factors.
Definition: Normalizations.h:290
Ringer::PreProcessing::Norm::ExtraPatternsNorm::m_etaMax
float m_etaMax
Definition: Normalizations.h:288
Ringer::PreProcessing::Norm::ExtraPatternsNorm::m_etMin
float m_etMin
Min and Max et normalization factors.
Definition: Normalizations.h:286
min
#define min(a, b)
Definition: cfImp.cxx:40
Ringer::PreProcessing::Norm::ExtraPatternsNorm::m_etMax
float m_etMax
Definition: Normalizations.h:286