Special case for the extra patterns normalization. More...

#include <Normalizations.h>

Inheritance diagram for Ringer::PreProcessing::Norm::ExtraPatternsNorm:

Collaboration diagram for Ringer::PreProcessing::Norm::ExtraPatternsNorm:

Public Member Functions
	ExtraPatternsNorm (const float etMin=0., const float etMax=1., const float etaMin=0., const float etaMax=1., const float pileupEstimationMax=1.)

ExtraPatternsNorm &	setEtNormParams (float min, float max)
	Set eta normalization params. More...

ExtraPatternsNorm &	setEtaNormParams (float min, float max)
	Set eta normalization params. More...

ExtraPatternsNorm &	setPileupEstimationParams (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...

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

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

Static Public Member Functions
static ExtraPatternsNorm *	read (TDirectory *configDir)
	Read Ringer procedure from configuration dir. More...

static void	read (VariableDependency varDep, TDirectory configDir, unsigned writtenVersion)
	Read variable dependency from directory. More...

Private Member Functions
virtual void	execute (std::vector< float > &inputSpace) const final override
	This normalization does not applies to the input space, but rather to special components of the input space. More...

Private Attributes
float	m_etMin
	Min and Max et normalization factors. More...

float	m_etMax

float	m_etaMin
	Min and Max eta normalization factors. More...

float	m_etaMax

float	m_pileupEstimationMax
	Min and Max eta normalization factors. More...

EtaDependency	m_etaDependency {EtaDependency::EtaIndependent}
	Whether there is eta dependency. More...

EtDependency	m_etDependency {EtDependency::EtIndependent}
	Whether there is et dependency. More...

Detailed Description

Special case for the extra patterns normalization.

Definition at line 236 of file Normalizations.h.

Constructor & Destructor Documentation

◆ ExtraPatternsNorm()

Ringer::PreProcessing::Norm::ExtraPatternsNorm::ExtraPatternsNorm	(	const float	etMin = `0.`,
		const float	etMax = `1.`,
		const float	etaMin = `0.`,
		const float	etaMax = `1.`,
		const float	pileupEstimationMax = `1.`
	)

inline

Definition at line 245 of file Normalizations.h.

                                                              :
                      m_etMin{etMin}, m_etMax{etMax},
                      m_etaMin{etaMin}, m_etaMax{etaMax},
                      m_pileupEstimationMax{pileupEstimationMax}
                      {;}

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::Norm::ExtraPatternsNorm::execute ( std::vector< float > & inputSpace ) const

finaloverrideprivatevirtual

This normalization does not applies to the input space, but rather to special components of the input space.

Implements Ringer::PreProcessing::IPreProcessor.

◆ 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()

std::string Ringer::RingerIOVarDepObj< ExtraPatternsNorm >::name

inherited

Retrieve name for this RingerIOVarDepObj.

◆ normEt()

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

Retrieve normalized et.

◆ normEta()

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

Retrieve normalized eta.

◆ normPileupEstimation()

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

Retrieve normalized pile-up estimation.

◆ read() [1/2]

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

staticinherited

Read Ringer procedure from configuration dir.

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

◆ setEtaNormParams()

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

inline

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
	)

inline

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 )

inline

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/2]

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

inherited

Write Ringer procedure to configuration directory.

◆ write() [2/2]

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::PreProcessing::Norm::ExtraPatternsNorm::m_etaMax

private

Definition at line 288 of file Normalizations.h.

◆ m_etaMin

float Ringer::PreProcessing::Norm::ExtraPatternsNorm::m_etaMin

private

Min and Max eta normalization factors.

Definition at line 288 of file Normalizations.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::PreProcessing::Norm::ExtraPatternsNorm::m_etMax

private

Definition at line 286 of file Normalizations.h.

◆ m_etMin

float Ringer::PreProcessing::Norm::ExtraPatternsNorm::m_etMin

private

Min and Max et normalization factors.

Definition at line 286 of file Normalizations.h.

◆ m_pileupEstimationMax

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

private

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:

Normalizations.h

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ExtraPatternsNorm()

Member Function Documentation

◆ etaDep()

◆ etaMax()

◆ etaMin()

◆ etDep()

◆ etMax()

◆ etMin()

◆ execute()

◆ isWithinEtaRange()

◆ isWithinEtRange()

◆ isWithinRange()

◆ name()

◆ normEt()

◆ normEta()

◆ normPileupEstimation()

◆ read() [1/2]

◆ read() [2/2]

◆ setEtaDep()

◆ setEtaEtDep()

◆ setEtaNormParams()

◆ setEtDep()

◆ setEtNormParams()

◆ setPileupEstimationParams()

◆ type()

◆ write() [1/2]

◆ write() [2/2]

◆ writeDepInfo()

Member Data Documentation

◆ m_etaDependency

◆ m_etaMax

◆ m_etaMin

◆ m_etDependency

◆ m_etMax

◆ m_etMin

◆ m_pileupEstimationMax