Ringer::VariableDependency Class Reference

Check if depVar is within this procedure range. More...

#include <VariableDependency.h>

Inherited by Ringer::RingerIOVarDepObj< ConstantValueVarDep > [virtual], Ringer::RingerIOVarDepObj< ExtraPatternsNorm > [virtual], Ringer::RingerIOVarDepObj< ExtraPatternsNormVarDep > [virtual], Ringer::RingerIOVarDepObj< MevToGevVarDep > [virtual], Ringer::RingerIOVarDepObj< MinMaxVarDep > [virtual], Ringer::RingerIOVarDepObj< Norm1VarDep > [virtual], Ringer::RingerIOVarDepObj< Norm2VarDep > [virtual], Ringer::RingerIOVarDepObj< SequentialVarDep > [virtual], Ringer::RingerIOVarDepObj< SpherizationVarDep > [virtual], Ringer::RingerIOVarDepObj< SqrtVarDep > [virtual], Ringer::Discrimination::IDiscriminatorVarDep [virtual], Ringer::Discrimination::IThresholdVarDep [virtual], Ringer::PreProcessing::IPreProcessorVarDep [virtual], and Ringer::RingerIOVarDepObj< CRTP > [virtual].

Collaboration diagram for Ringer::VariableDependency:

Public Member Functions
	VariableDependency ()=default
	Ctor for independent.
	VariableDependency (const float etaMin, const float etaMax, EtaDependency etaDependency)
	Ctor for eta dependent case.
	VariableDependency (const float etMin, const float etMax, EtDependency etDependency)
	Ctor for et dependent case.
	VariableDependency (const float etaMin, const float etaMax, const float etMin, const float etMax)
	Ctor for et/eta dependent case.
bool	isWithinRange (const DepVarStruct &depVar) const
	Check if depVar is within this procedure range.
bool	isWithinEtaRange (const float eta) const
	Check if eta is within this procedure range.
EtaDependency	etaDep () const
	Returns whether it is et dependent.
float	etaMin () const
	Get eta min.
float	etaMax () const
	Get eta max.
float	etMin () const
	Get et min.
float	etMax () const
	Get et max.
void	setEtaDep (const float etaMin, const float etaMax)
	Set this procedure to be eta dependent:
bool	isWithinEtRange (const float et) const
	Check if et is within this procedure et range.
EtDependency	etDep () const
	Returns whether it is et dependent.
void	setEtDep (const float etMin, const float etMax)
	Set this procedure to be et dependent.
void	setEtaEtDep (const float etaMin, const float etaMax, const float etMin, const float etMax)
	Set this procedure to be et dependent.
std::string	type () const
	Return this variable dependency string.
void	writeDepInfo (TDirectory *configDir) const
	Write variable dependency to directory.
virtual	~VariableDependency ()
	Ensure virtual destruction (needed if creating dictionary from this class)

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

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

Detailed Description

Check if depVar is within this procedure range.

Check if eta is within this procedure eta range Set this procedure to be eta dependent: Check if et is within this procedure et range Set this procedure to be et dependent: Set this procedure to be et, eta dependent:

Interface for possible Eta and Et variable dependency.

Definition at line 88 of file VariableDependency.h.

Constructor & Destructor Documentation

VariableDependency() [1/4]

Ringer::VariableDependency::VariableDependency ( )

default

Ctor for independent.

VariableDependency() [2/4]

Ringer::VariableDependency::VariableDependency ( const float etaMin, const float etaMax, EtaDependency etaDependency )

inline

Ctor for eta dependent case.

Definition at line 100 of file VariableDependency.h.

      : m_etaDependency(etaDependency),
        m_etaMin(etaMin),
        m_etaMax(etaMax)
        {}

VariableDependency() [3/4]

Ringer::VariableDependency::VariableDependency ( const float etMin, const float etMax, EtDependency etDependency )

inline

Ctor for et dependent case.

Definition at line 110 of file VariableDependency.h.

      : m_etDependency(etDependency),
        m_etMin(etMin),
        m_etMax(etMax)
        {}

VariableDependency() [4/4]

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

inline

Ctor for et/eta dependent case.

Definition at line 120 of file VariableDependency.h.

      : m_etaMin(etaMin),
        m_etaMax(etaMax),
        m_etMin(etMin),
        m_etMax(etMax)
        {}

~VariableDependency()

virtual Ringer::VariableDependency::~VariableDependency ( )

inlinevirtual

Ensure virtual destruction (needed if creating dictionary from this class)

Definition at line 220 of file VariableDependency.h.

{;}

Member Function Documentation

etaDep()

EtaDependency Ringer::VariableDependency::etaDep

(

)

const

Returns whether it is et dependent.

etaMax()

float Ringer::VariableDependency::etaMax

(

)

const

Get eta max.

etaMin()

float Ringer::VariableDependency::etaMin

(

)

const

Get eta min.

etDep()

EtDependency Ringer::VariableDependency::etDep

(

)

const

Returns whether it is et dependent.

etMax()

float Ringer::VariableDependency::etMax

(

)

const

Get et max.

etMin()

float Ringer::VariableDependency::etMin

(

)

const

Get et min.

isWithinEtaRange()

bool Ringer::VariableDependency::isWithinEtaRange

(

const float

eta

)

const

Check if eta is within this procedure range.

isWithinEtRange()

bool Ringer::VariableDependency::isWithinEtRange

(

const float

et

)

const

Check if et is within this procedure et range.

isWithinRange()

bool Ringer::VariableDependency::isWithinRange

(

const DepVarStruct &

depVar

)

const

Check if depVar is within this procedure range.

read()

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

static

Read variable dependency from directory.

setEtaDep()

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

Set this procedure to be eta dependent:

setEtaEtDep()

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

Set this procedure to be et dependent.

setEtDep()

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

Set this procedure to be et dependent.

type()

std::string Ringer::VariableDependency::type

(

)

const

Return this variable dependency string.

This is not a virtual method.

writeDepInfo()

void Ringer::VariableDependency::writeDepInfo

(

TDirectory *

configDir

)

const

Write variable dependency to directory.

This is not a virtual method.

Member Data Documentation

m_etaDependency

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

private

Whether there is eta dependency.

Definition at line 225 of file VariableDependency.h.

{EtaDependency::EtaIndependent};

m_etaMax

float Ringer::VariableDependency::m_etaMax {0}

private

Definition at line 230 of file VariableDependency.h.

{0}, m_etaMax{0};

m_etaMin

float Ringer::VariableDependency::m_etaMin {0}

private

Eta bounded region where RingerProcedure may be applied.

Definition at line 230 of file VariableDependency.h.

{0}, m_etaMax{0};

m_etDependency

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

private

Whether there is et dependency.

Definition at line 227 of file VariableDependency.h.

{EtDependency::EtIndependent};

m_etMax

float Ringer::VariableDependency::m_etMax {0}

private

Definition at line 233 of file VariableDependency.h.

{0}, m_etMax{0};

m_etMin

float Ringer::VariableDependency::m_etMin {0}

private

Et bounded region where RingerProcedure may be applied.

Definition at line 233 of file VariableDependency.h.

{0}, m_etMax{0};

---

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

• VariableDependency.h