#include <SCT_ConditionsParameterTool.h>

Inheritance diagram for SCT_ConditionsParameterTool:

Collaboration diagram for SCT_ConditionsParameterTool:

Public Member Functions
	SCT_ConditionsParameterTool (const std::string &type, const std::string &name, const IInterface *parent)
	Constructor necessary for Svc factory. More...

virtual	~SCT_ConditionsParameterTool ()=default
	(virtual) Destructor does nothing More...

virtual StatusCode	initialize () override

virtual StatusCode	finalize () override

virtual bool	available (const SCT_CondParameterData::ParameterIndex iparam, const EventContext &ctx) const override
	Is the required parameter available? More...

virtual bool	available (const SCT_CondParameterData::ParameterIndex iparam) const override

virtual float	value (const IdentifierHash &idHash, const SCT_CondParameterData::ParameterIndex iparam, const EventContext &ctx) const override
	Give the indicated value for a module identifier hash. More...

virtual float	value (const IdentifierHash &idHash, const SCT_CondParameterData::ParameterIndex iparam) const override

virtual float	validity (const IdentifierHash &idHash, const SCT_CondParameterData::ParameterIndex iparam, const EventContext &ctx) const override
	Measure of how many valid values went to calculate it. Should be 1 but if, say, 3 chip values were valid out of 6, it could be less (0.5 in this case) More...

virtual float	validity (const IdentifierHash &idHash, const SCT_CondParameterData::ParameterIndex iparam) const override

virtual bool	isValid (const float parameterValue, const SCT_CondParameterData::ParameterIndex iparam, const EventContext &ctx) const override
	Is a given value within acceptable limits? More...

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

virtual float	invalid (const unsigned int iparam, const EventContext &ctx) const override
	What is the default error value for this parameter? More...

virtual float	invalid (const unsigned int iparam) const override

virtual float	max (const SCT_CondParameterData::ParameterIndex iparam, const EventContext &ctx) const override
	Maximum value read in from the database. More...

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

virtual float	min (const SCT_CondParameterData::ParameterIndex iparam, const EventContext &ctx) const override
	Minimum value read in from the database. More...

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

virtual float	avg (const SCT_CondParameterData::ParameterIndex iparam, const EventContext &ctx) const override
	Average value. More...

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

virtual float	sd (const SCT_CondParameterData::ParameterIndex iparam, const EventContext &ctx) const override
	Standard deviation. More...

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

virtual unsigned int	n (const SCT_CondParameterData::ParameterIndex iparam, const EventContext &ctx) const override
	Number of values read in. More...

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

virtual void	getValues (std::vector< float > &userVector, const SCT_CondParameterData::ParameterIndex iparam, const EventContext &ctx) const override
	Fill a user-provided vector with the values (hopefully won't be needed?) More...

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

virtual bool	filled (const EventContext &ctx) const override
	Report whether the structure was filled. More...

virtual bool	filled () const override

Private Member Functions
const SCT_CondParameterData *	getCondData (const EventContext &ctx) const

Private Attributes
SG::ReadCondHandleKey< SCT_CondParameterData >	m_condKey {this, "CondKey", "SCT_CondParameterData", "SCT parameters"}

Detailed Description

Class to give a numerical value from conditions for each detector element (module side)

Definition at line 29 of file SCT_ConditionsParameterTool.h.

Constructor & Destructor Documentation

◆ SCT_ConditionsParameterTool()

SCT_ConditionsParameterTool::SCT_ConditionsParameterTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent
	)

Constructor necessary for Svc factory.

Definition at line 15 of file SCT_ConditionsParameterTool.cxx.

                                                                                                                                :
   base_class(type, name, parent) {
 }

◆ ~SCT_ConditionsParameterTool()

virtual SCT_ConditionsParameterTool::~SCT_ConditionsParameterTool ( )

virtualdefault

(virtual) Destructor does nothing

Member Function Documentation

◆ available() [1/2]

bool SCT_ConditionsParameterTool::available ( const SCT_CondParameterData::ParameterIndex iparam ) const

overridevirtual

Definition at line 40 of file SCT_ConditionsParameterTool.cxx.

                                                                                              {
   const EventContext& ctx{Gaudi::Hive::currentContext()};
   return available(iparam, ctx);
 }

◆ available() [2/2]

bool SCT_ConditionsParameterTool::available	(	const SCT_CondParameterData::ParameterIndex	iparam,
		const EventContext &	ctx
	)		const

overridevirtual

Is the required parameter available?

Definition at line 35 of file SCT_ConditionsParameterTool.cxx.

                                                                                                                     {
   return (iparam==SCT_CondParameterData::AVG_THRESHOLD);
 }

◆ avg() [1/2]

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

overridevirtual

Definition at line 138 of file SCT_ConditionsParameterTool.cxx.

                                                                                        {
   const EventContext& ctx{Gaudi::Hive::currentContext()};
   return avg(iparam, ctx);
 }

◆ avg() [2/2]

float SCT_ConditionsParameterTool::avg	(	const SCT_CondParameterData::ParameterIndex	iparam,
		const EventContext &	ctx
	)		const

overridevirtual

Average value.

Definition at line 131 of file SCT_ConditionsParameterTool.cxx.

                                                                                                                 {
   const SCT_CondParameterData* data{getCondData(ctx)};
   if (data==nullptr) return invalid(iparam);
   return data->avg(iparam);
 }

◆ filled() [1/2]

bool SCT_ConditionsParameterTool::filled ( ) const

overridevirtual

Definition at line 193 of file SCT_ConditionsParameterTool.cxx.

                                           {
   const EventContext& ctx{Gaudi::Hive::currentContext()};
   return filled(ctx);
 }

◆ filled() [2/2]

bool SCT_ConditionsParameterTool::filled ( const EventContext & ctx ) const

overridevirtual

Report whether the structure was filled.

Definition at line 187 of file SCT_ConditionsParameterTool.cxx.

                                                                  {
   const SCT_CondParameterData* data{getCondData(ctx)};
   return (data!=nullptr);
 }

◆ finalize()

StatusCode SCT_ConditionsParameterTool::finalize ( )

overridevirtual

Definition at line 29 of file SCT_ConditionsParameterTool.cxx.

                                       {
   return StatusCode::SUCCESS;
 }

◆ getCondData()

const SCT_CondParameterData * SCT_ConditionsParameterTool::getCondData ( const EventContext & ctx ) const

private

Definition at line 198 of file SCT_ConditionsParameterTool.cxx.

                                                                                                    {
   SG::ReadCondHandle<SCT_CondParameterData> condData{m_condKey, ctx};
   if (not condData.isValid()) {
     ATH_MSG_ERROR("Failed to get " << m_condKey.key());
     return nullptr;
   }
   return *condData;
 }

◆ getValues() [1/2]

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

overridevirtual

Definition at line 180 of file SCT_ConditionsParameterTool.cxx.

                                                                                                                            {
   const EventContext& ctx{Gaudi::Hive::currentContext()};
   getValues(userVector, iparam, ctx);
 }

◆ getValues() [2/2]

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

overridevirtual

Fill a user-provided vector with the values (hopefully won't be needed?)

Definition at line 173 of file SCT_ConditionsParameterTool.cxx.

                                                                                                                                                     {
   const SCT_CondParameterData* data{getCondData(ctx)};
   if (data!=nullptr) data->getValues(userVector, iparam);
   //no return value
 }

◆ initialize()

StatusCode SCT_ConditionsParameterTool::initialize ( )

overridevirtual

Definition at line 21 of file SCT_ConditionsParameterTool.cxx.

                                         {
   ATH_CHECK(m_condKey.initialize());
  
   return StatusCode::SUCCESS;
 }

◆ invalid() [1/2]

float SCT_ConditionsParameterTool::invalid ( const unsigned int iparam ) const

overridevirtual

Definition at line 96 of file SCT_ConditionsParameterTool.cxx.

                                                                     {
   const EventContext& ctx{Gaudi::Hive::currentContext()};
   return invalid(iparam, ctx);
 }

◆ invalid() [2/2]

float SCT_ConditionsParameterTool::invalid	(	const unsigned int	iparam,
		const EventContext &	ctx
	)		const

overridevirtual

What is the default error value for this parameter?

Definition at line 87 of file SCT_ConditionsParameterTool.cxx.

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

◆ isValid() [1/2]

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

overridevirtual

Definition at line 80 of file SCT_ConditionsParameterTool.cxx.

                                                                                                                        {
   const EventContext& ctx{Gaudi::Hive::currentContext()};
   return isValid(parameterValue, iparam, ctx);
 }

◆ isValid() [2/2]

bool SCT_ConditionsParameterTool::isValid	(	const float	parameterValue,
		const SCT_CondParameterData::ParameterIndex	iparam,
		const EventContext &	ctx
	)		const

overridevirtual

Is a given value within acceptable limits?

Definition at line 73 of file SCT_ConditionsParameterTool.cxx.

                                                                                                                                                 {
   const SCT_CondParameterData* data{getCondData(ctx)};
   if (data==nullptr) return invalid(iparam);
   return SCT_CondParameterData::isValid(parameterValue, iparam);
 }

◆ max() [1/2]

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

overridevirtual

Definition at line 110 of file SCT_ConditionsParameterTool.cxx.

                                                                                        {
   const EventContext& ctx{Gaudi::Hive::currentContext()};
   return max(iparam, ctx);
 }

◆ max() [2/2]

float SCT_ConditionsParameterTool::max	(	const SCT_CondParameterData::ParameterIndex	iparam,
		const EventContext &	ctx
	)		const

overridevirtual

Maximum value read in from the database.

Definition at line 103 of file SCT_ConditionsParameterTool.cxx.

                                                                                                                 {
   const SCT_CondParameterData* data{getCondData(ctx)};
   if (data==nullptr) return invalid(iparam);
   return data->max(iparam);
 }

◆ min() [1/2]

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

overridevirtual

Definition at line 124 of file SCT_ConditionsParameterTool.cxx.

                                                                                        {
   const EventContext& ctx{Gaudi::Hive::currentContext()};
   return min(iparam, ctx);
 }

◆ min() [2/2]

float SCT_ConditionsParameterTool::min	(	const SCT_CondParameterData::ParameterIndex	iparam,
		const EventContext &	ctx
	)		const

overridevirtual

Minimum value read in from the database.

Definition at line 117 of file SCT_ConditionsParameterTool.cxx.

                                                                                                                 {
   const SCT_CondParameterData* data{getCondData(ctx)};
   if (data==nullptr) return invalid(iparam);
   return data->min(iparam);
 }

◆ n() [1/2]

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

overridevirtual

Definition at line 166 of file SCT_ConditionsParameterTool.cxx.

                                                                                      {
   const EventContext& ctx{Gaudi::Hive::currentContext()};
   return n(iparam, ctx);
 }

◆ n() [2/2]

unsigned int SCT_ConditionsParameterTool::n	(	const SCT_CondParameterData::ParameterIndex	iparam,
		const EventContext &	ctx
	)		const

overridevirtual

Number of values read in.

Definition at line 159 of file SCT_ConditionsParameterTool.cxx.

                                                                                                               {
   const SCT_CondParameterData* data{getCondData(ctx)};
   if (data==nullptr) return 0;
   return data->n(iparam);
 }

◆ sd() [1/2]

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

overridevirtual

Definition at line 152 of file SCT_ConditionsParameterTool.cxx.

                                                                                       {
   const EventContext& ctx{Gaudi::Hive::currentContext()};
   return sd(iparam, ctx);
 }

◆ sd() [2/2]

float SCT_ConditionsParameterTool::sd	(	const SCT_CondParameterData::ParameterIndex	iparam,
		const EventContext &	ctx
	)		const

overridevirtual

Standard deviation.

Definition at line 145 of file SCT_ConditionsParameterTool.cxx.

                                                                                                                {
   const SCT_CondParameterData* data{getCondData(ctx)};
   if (data==nullptr) return invalid(iparam);
   return data->sd(iparam);
 }

◆ validity() [1/2]

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

overridevirtual

Definition at line 66 of file SCT_ConditionsParameterTool.cxx.

                                                                                                                           {
   const EventContext& ctx{Gaudi::Hive::currentContext()};
   return validity(idHash, iparam, ctx);
 }

◆ validity() [2/2]

float SCT_ConditionsParameterTool::validity	(	const IdentifierHash &	idHash,
		const SCT_CondParameterData::ParameterIndex	iparam,
		const EventContext &	ctx
	)		const

overridevirtual

Measure of how many valid values went to calculate it. Should be 1 but if, say, 3 chip values were valid out of 6, it could be less (0.5 in this case)

Definition at line 61 of file SCT_ConditionsParameterTool.cxx.

                                                                                                                                        {
   return 1.0;
 }

◆ value() [1/2]

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

overridevirtual

Definition at line 54 of file SCT_ConditionsParameterTool.cxx.

                                                                                                                        {
   const EventContext& ctx{Gaudi::Hive::currentContext()};
   return value(idHash, iparam, ctx);
 }

◆ value() [2/2]

float SCT_ConditionsParameterTool::value	(	const IdentifierHash &	idHash,
		const SCT_CondParameterData::ParameterIndex	iparam,
		const EventContext &	ctx
	)		const

overridevirtual

Give the indicated value for a module identifier hash.

Definition at line 47 of file SCT_ConditionsParameterTool.cxx.

                                                                                                                                                 {
   const SCT_CondParameterData* data{getCondData(ctx)};
   if (data==nullptr) return invalid(iparam);
   return data->getValue(idHash, iparam);
 }

Member Data Documentation

◆ m_condKey

SG::ReadCondHandleKey<SCT_CondParameterData> SCT_ConditionsParameterTool::m_condKey {this, "CondKey", "SCT_CondParameterData", "SCT parameters"}

private

Definition at line 93 of file SCT_ConditionsParameterTool.h.

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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SCT_ConditionsParameterTool()

◆ ~SCT_ConditionsParameterTool()

Member Function Documentation

◆ available() [1/2]

◆ available() [2/2]

◆ avg() [1/2]

◆ avg() [2/2]

◆ filled() [1/2]

◆ filled() [2/2]

◆ finalize()

◆ getCondData()

◆ getValues() [1/2]

◆ getValues() [2/2]

◆ initialize()

◆ invalid() [1/2]

◆ invalid() [2/2]

◆ isValid() [1/2]

◆ isValid() [2/2]

◆ max() [1/2]

◆ max() [2/2]

◆ min() [1/2]

◆ min() [2/2]

◆ n() [1/2]

◆ n() [2/2]

◆ sd() [1/2]

◆ sd() [2/2]

◆ validity() [1/2]

◆ validity() [2/2]

◆ value() [1/2]

◆ value() [2/2]

Member Data Documentation

◆ m_condKey