Data object for SCT_ConditionsParameterTool and SCT_ConditionsParameterCondAlg. More...

#include <SCT_CondParameterData.h>

Collaboration diagram for SCT_CondParameterData:

Public Types
enum	ParameterIndex { AVG_THRESHOLD, N_PARAMETERS, INVALID_PARAMETER }
	Parameters. More...

Public Member Functions
	SCT_CondParameterData ()
	Constructor. More...

virtual	~SCT_CondParameterData ()=default
	Destructor. More...

float	getValue (const IdentifierHash &idHash, const SCT_CondParameterData::ParameterIndex iparam) const
	Get the indicated value for a module identifier hash. More...

void	getValues (std::vector< float > &userVector, const SCT_CondParameterData::ParameterIndex iparam) const
	Fill a user-provided vector with the values. More...

void	setValue (const IdentifierHash &idHash, const SCT_CondParameterData::ParameterIndex iparam, const float value)
	Get the indicated value for a module identifier hash. More...

bool	insert (const IdentifierHash &idHash, const SCT_CondParameterData::ParameterIndex iparam, const float value)
	Extended methods for data structure insertion. More...

float	max (const SCT_CondParameterData::ParameterIndex iparam) const
	Get maximum value. More...

float	min (const SCT_CondParameterData::ParameterIndex iparam) const
	Get minimum value. More...

float	avg (const SCT_CondParameterData::ParameterIndex iparam) const
	Get average value. More...

float	sd (const SCT_CondParameterData::ParameterIndex iparam) const
	Get standard deviation. More...

unsigned int	n (const SCT_CondParameterData::ParameterIndex iparam) const
	Get the number of values. More...

void	clear ()
	Clear all data members. More...

Static Public Member Functions
static bool	isValid (const float parameterValue, const SCT_CondParameterData::ParameterIndex iparam)
	Is a given value within acceptable limits? More...

static float	invalid (const unsigned int iparam)
	What is the default error value for this parameter? More...

Private Attributes
std::array< std::array< float, N_PARAMETERS >, SCT_ConditionsData::NUMBER_OF_WAFERS >	m_values {}

float	m_min [N_PARAMETERS] {}

float	m_max [N_PARAMETERS] {}

unsigned int	m_n [N_PARAMETERS] {}

float	m_sum [N_PARAMETERS] {}

float	m_sumsq [N_PARAMETERS] {}

Detailed Description

Data object for SCT_ConditionsParameterTool and SCT_ConditionsParameterCondAlg.

Definition at line 32 of file SCT_CondParameterData.h.

Member Enumeration Documentation

◆ ParameterIndex

enum SCT_CondParameterData::ParameterIndex

Parameters.

Enumerator
AVG_THRESHOLD
N_PARAMETERS
INVALID_PARAMETER

Definition at line 35 of file SCT_CondParameterData.h.

35 {AVG_THRESHOLD, N_PARAMETERS, INVALID_PARAMETER};

Constructor & Destructor Documentation

◆ SCT_CondParameterData()

SCT_CondParameterData::SCT_CondParameterData ( )

Constructor.

Definition at line 11 of file SCT_CondParameterData.cxx.

                                              {
   clear();
 }

◆ ~SCT_CondParameterData()

virtual SCT_CondParameterData::~SCT_CondParameterData ( )

virtualdefault

Destructor.

Member Function Documentation

◆ avg()

float SCT_CondParameterData::avg ( const SCT_CondParameterData::ParameterIndex iparam ) const

Get average value.

Definition at line 78 of file SCT_CondParameterData.cxx.

                                                                                        {
   return (m_n[iparam]!=0)?(m_sum[iparam]/m_n[iparam]):(std::numeric_limits<float>::quiet_NaN());
 }

◆ clear()

void SCT_CondParameterData::clear ( )

Clear all data members.

Definition at line 94 of file SCT_CondParameterData.cxx.

                                   {
   std::array<float, N_PARAMETERS> init{};
   for (unsigned int i{0}; i!=N_PARAMETERS; ++i) {
     m_min[i] = std::numeric_limits<float>::max();
     m_max[i] = std::numeric_limits<float>::min();
     m_n[i] = 0;
     m_sum[i] = 0.0;
     m_sumsq[i] = 0.0;
     init[i] = invalid(i);
   }
   
   //initialize array
   m_values.fill(init);
 }

◆ getValue()

float SCT_CondParameterData::getValue	(	const IdentifierHash &	idHash,
		const SCT_CondParameterData::ParameterIndex	iparam
	)		const

Get the indicated value for a module identifier hash.

Definition at line 16 of file SCT_CondParameterData.cxx.

                                                                                                                           {
   return m_values[idHash][iparam];
 }

◆ getValues()

void SCT_CondParameterData::getValues	(	std::vector< float > &	userVector,
		const SCT_CondParameterData::ParameterIndex	iparam
	)		const

Fill a user-provided vector with the values.

Definition at line 21 of file SCT_CondParameterData.cxx.

                                                                                                                           {
   for (unsigned int i{0}; i!=m_values.size(); ++i) {
     userVector.push_back(m_values[i][iparam]);
   }
 }

◆ insert()

bool SCT_CondParameterData::insert	(	const IdentifierHash &	idHash,
		const SCT_CondParameterData::ParameterIndex	iparam,
		const float	value
	)

Extended methods for data structure insertion.

Definition at line 39 of file SCT_CondParameterData.cxx.

                                                                                                                                        {
   // theValue must be valid
   if (not isValid(theValue, iparam)) return false;
   std::array<float,N_PARAMETERS>& paramArray = m_values[idHash];
   // initial value should be invalid, only insert if this is the case
   if (not isValid(paramArray[iparam], iparam)) {
     paramArray[iparam] = theValue;
     return true;
   } else {
     return false; 
   }
 }

◆ invalid()

float SCT_CondParameterData::invalid ( const unsigned int iparam )

static

What is the default error value for this parameter?

Definition at line 59 of file SCT_CondParameterData.cxx.

                                                               {
   float result{0.0};
   if (iparam==AVG_THRESHOLD) {
     result=std::numeric_limits<float>::quiet_NaN();
   }
   return result;
 }

◆ isValid()

bool SCT_CondParameterData::isValid	(	const float	parameterValue,
		const SCT_CondParameterData::ParameterIndex	iparam
	)

static

Is a given value within acceptable limits?

Definition at line 53 of file SCT_CondParameterData.cxx.

                                                                                                                 {
   // Second condition is to check if it is nan.
   return !(iparam==AVG_THRESHOLD and (parameterValue!=parameterValue));
 }

◆ max()

float SCT_CondParameterData::max ( const SCT_CondParameterData::ParameterIndex iparam ) const

Get maximum value.

Definition at line 68 of file SCT_CondParameterData.cxx.

                                                                                        {
   return m_max[iparam];
 }

◆ min()

float SCT_CondParameterData::min ( const SCT_CondParameterData::ParameterIndex iparam ) const

Get minimum value.

Definition at line 73 of file SCT_CondParameterData.cxx.

                                                                                        {
   return m_min[iparam];
 }

◆ n()

unsigned int SCT_CondParameterData::n ( const SCT_CondParameterData::ParameterIndex iparam ) const

Get the number of values.

Definition at line 89 of file SCT_CondParameterData.cxx.

                                                                                             {
   return m_n[iparam];
 }

◆ sd()

float SCT_CondParameterData::sd ( const SCT_CondParameterData::ParameterIndex iparam ) const

Get standard deviation.

Definition at line 83 of file SCT_CondParameterData.cxx.

                                                                                       {
   float mu{m_sum[iparam]/m_n[iparam]};
   return std::sqrt((m_sumsq[iparam]/m_n[iparam]) - mu*mu);
 }

◆ setValue()

void SCT_CondParameterData::setValue	(	const IdentifierHash &	idHash,
		const SCT_CondParameterData::ParameterIndex	iparam,
		const float	value
	)

Get the indicated value for a module identifier hash.

Definition at line 28 of file SCT_CondParameterData.cxx.

                                                                                                                                       {
   if (insert(idHash, iparam, value)) {
     m_n[iparam]++;
     m_sum[iparam] += value;
     m_sumsq[iparam] += value*value;
     m_min[iparam] = std::min(m_min[iparam], value);
     m_max[iparam] = std::max(m_max[iparam], value);
   }
 }

Member Data Documentation

◆ m_max

float SCT_CondParameterData::m_max[N_PARAMETERS] {}

private

Definition at line 74 of file SCT_CondParameterData.h.

◆ m_min

float SCT_CondParameterData::m_min[N_PARAMETERS] {}

private

Definition at line 73 of file SCT_CondParameterData.h.

◆ m_n

unsigned int SCT_CondParameterData::m_n[N_PARAMETERS] {}

private

Definition at line 75 of file SCT_CondParameterData.h.

◆ m_sum

float SCT_CondParameterData::m_sum[N_PARAMETERS] {}

private

Definition at line 76 of file SCT_CondParameterData.h.

◆ m_sumsq

float SCT_CondParameterData::m_sumsq[N_PARAMETERS] {}

private

Definition at line 77 of file SCT_CondParameterData.h.

◆ m_values

std::array<std::array<float, N_PARAMETERS>, SCT_ConditionsData::NUMBER_OF_WAFERS> SCT_CondParameterData::m_values {}

private

Definition at line 71 of file SCT_CondParameterData.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ ParameterIndex

Constructor & Destructor Documentation

◆ SCT_CondParameterData()

◆ ~SCT_CondParameterData()

Member Function Documentation

◆ avg()

◆ clear()

◆ getValue()

◆ getValues()

◆ insert()

◆ invalid()

◆ isValid()

◆ max()

◆ min()

◆ n()

◆ sd()

◆ setValue()

Member Data Documentation

◆ m_max

◆ m_min

◆ m_n

◆ m_sum

◆ m_sumsq

◆ m_values