Normalize data to have zero mean and unitary standard deviation. More...

#include <Normalizations.h>

Inheritance diagram for Ringer::PreProcessing::Norm::SpherizationVarDep:

Collaboration diagram for Ringer::PreProcessing::Norm::SpherizationVarDep:

Public Member Functions
	SpherizationVarDep ()

	SpherizationVarDep (const std::vector< float > &dataMean, const std::vector< float > &dataStd)

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

virtual void	execute (std::vector< float > &inputSpace) const final override

Static Public Member Functions
static IPreProcessorVarDep *	read (TDirectory *)

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

static SpherizationVarDep *	read (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}

std::vector< float >	m_deslocation
	The training sample data mean. More...

std::vector< float >	m_normInv
	The inverse of the training sample data standard deviation. More...

size_t	m_dim
	Input dimension (transient variable) More...

Detailed Description

Normalize data to have zero mean and unitary standard deviation.

Definition at line 435 of file Normalizations.h.

Constructor & Destructor Documentation

◆ SpherizationVarDep() [1/2]

Ringer::PreProcessing::Norm::SpherizationVarDep::SpherizationVarDep ( )

inline

Definition at line 444 of file Normalizations.h.

444 {;}

◆ SpherizationVarDep() [2/2]

Ringer::PreProcessing::Norm::SpherizationVarDep::SpherizationVarDep	(	const std::vector< float > &	dataMean,
		const std::vector< float > &	dataStd
	)

inline

Definition at line 446 of file Normalizations.h.

448 :

449 Spherization(dataMean,dataStd){;}

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() [1/2]

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.

◆ execute() [2/2]

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

finaloverridevirtualinherited

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< SpherizationVarDep >::name

inherited

Retrieve name for this RingerIOVarDepObj.

◆ read() [1/3]

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

inlinestaticinherited

Definition at line 277 of file IRingerProcedure.h.

277 { return nullptr;}

◆ read() [2/3]

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

staticinherited

Read Ringer procedure from configuration dir.

◆ read() [3/3]

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() [1/2]

void Ringer::RingerIOVarDepObj< SpherizationVarDep >::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_deslocation

std::vector<float> Ringer::PreProcessing::Norm::Spherization::m_deslocation

privateinherited

The training sample data mean.

Definition at line 192 of file Normalizations.h.

◆ m_dim

size_t Ringer::PreProcessing::Norm::Spherization::m_dim

privateinherited

Input dimension (transient variable)

Definition at line 196 of file Normalizations.h.

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

std::vector<float> Ringer::PreProcessing::Norm::Spherization::m_normInv

privateinherited

The inverse of the training sample data standard deviation.

Definition at line 194 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 Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SpherizationVarDep() [1/2]

◆ SpherizationVarDep() [2/2]

Member Function Documentation

◆ etaDep()

◆ etaMax()

◆ etaMin()

◆ etDep()

◆ etMax()

◆ etMin()

◆ execute() [1/2]

◆ execute() [2/2]

◆ isWithinEtaRange()

◆ isWithinEtRange()

◆ isWithinRange()

◆ name()

◆ read() [1/3]

◆ read() [2/3]

◆ read() [3/3]

◆ setEtaDep()

◆ setEtaEtDep()

◆ setEtDep()

◆ type()

◆ write() [1/2]

◆ write() [2/2]

◆ writeDepInfo()

Member Data Documentation

◆ m_deslocation

◆ m_dim

◆ m_etaDependency

◆ m_etaMax

◆ m_etaMin

◆ m_etDependency

◆ m_etMax

◆ m_etMin

◆ m_normInv