Tool to retrieve dynamic pedestal values from a text file. More...

#include <L1DynamicPedestalProviderTxt.h>

Inheritance diagram for LVL1::L1DynamicPedestalProviderTxt:

Collaboration diagram for LVL1::L1DynamicPedestalProviderTxt:

Classes
class	ParamFunc

Public Member Functions
	L1DynamicPedestalProviderTxt (const std::string &, const std::string &, const IInterface *)
	constructor More...

virtual	~L1DynamicPedestalProviderTxt ()
	default destructor More...

virtual StatusCode	initialize () override
	standard Athena-Algorithm method More...

virtual int	dynamicPedestal (int iEta, int layer, int pedestal, int iBCID, float mu) const override
	retrieve the bcidCorrection value More...

ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`. More...

virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm. More...

virtual StatusCode	sysStart () override
	Handle START transition. More...

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...

void	updateVHKA (Gaudi::Details::PropertyBase &)

MsgStream &	msg () const

MsgStream &	msg (const MSG::Level lvl) const

bool	msgLvl (const MSG::Level lvl) const

Static Public Member Functions
static const InterfaceID &	interfaceID ()

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)

void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
std::pair< bool, int >	distanceFromHeadOfTrain (int bcid) const

void	parseInputFile (const std::string &fileName, std::vector< std::vector< std::unique_ptr< ParamFunc >>> &params)

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
std::array< std::vector< std::vector< std::unique_ptr< ParamFunc > > >, 2 >	m_emParameterizations

std::array< std::vector< std::vector< std::unique_ptr< ParamFunc > > >, 2 >	m_hadParameterizations

SG::ReadCondHandleKey< BunchCrossingCondData >	m_bcDataKey {this, "BunchCrossingCondDataKey", "BunchCrossingData" ,"SG Key of BunchCrossing CDO"}

std::string	m_inputFileEMShort

std::string	m_inputFileHADShort

std::string	m_inputFileEMLong

std::string	m_inputFileHADLong

StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...

StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...

std::vector< SG::VarHandleKeyArray * >	m_vhka

bool	m_varHandleArraysDeclared

Static Private Attributes
static const unsigned	s_nElements = 33

static const unsigned	s_nBCIDPerTrain = 74

Detailed Description

Tool to retrieve dynamic pedestal values from a text file.

This tool retrieves the dynamic pedestal value given the trigger tower location and the bcid and mu value of the event. The correction is parameterized as a function of eta, BCID and mu. To reduce the number of parameters necessary the eta dependence is parameterized in a so-called "second parameterization" for large parts of the detector. The parameters are read from a text file.

Definition at line 53 of file L1DynamicPedestalProviderTxt.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ L1DynamicPedestalProviderTxt()

LVL1::L1DynamicPedestalProviderTxt::L1DynamicPedestalProviderTxt	(	const std::string &	t,
		const std::string &	n,
		const IInterface *	p
	)

constructor

Definition at line 52 of file L1DynamicPedestalProviderTxt.cxx.

   : AthAlgTool(t, n, p)
 {
   declareInterface<IL1DynamicPedestalProvider>(this);
  
   // fill the vectors with default values - didn't find a more clever way due to move-only unique_ptr
   m_emParameterizations[0] = std::vector<std::vector<std::unique_ptr<ParamFunc>>>(s_nElements);
   m_emParameterizations[1] = std::vector<std::vector<std::unique_ptr<ParamFunc>>>(s_nElements);
   m_hadParameterizations[0] = std::vector<std::vector<std::unique_ptr<ParamFunc>>>(s_nElements);
   m_hadParameterizations[1] = std::vector<std::vector<std::unique_ptr<ParamFunc>>>(s_nElements);
   for(std::size_t i = 0; i < s_nElements; ++i) {
     m_emParameterizations[0][i] = std::vector<std::unique_ptr<ParamFunc>>(s_nBCIDPerTrain);
     m_emParameterizations[1][i] = std::vector<std::unique_ptr<ParamFunc>>(s_nBCIDPerTrain);
     m_hadParameterizations[0][i] = std::vector<std::unique_ptr<ParamFunc>>(s_nBCIDPerTrain);
     m_hadParameterizations[1][i] = std::vector<std::unique_ptr<ParamFunc>>(s_nBCIDPerTrain);
   }
  
   // Input files containing the parameters for the electromagnetic and hadronic
   // layer, respectively.
   declareProperty("InputFileEM_ShortGap", m_inputFileEMShort);
   declareProperty("InputFileHAD_ShortGap", m_inputFileHADShort);
   declareProperty("InputFileEM_LongGap", m_inputFileEMLong);
   declareProperty("InputFileHAD_LongGap", m_inputFileHADLong);
 }

◆ ~L1DynamicPedestalProviderTxt()

LVL1::L1DynamicPedestalProviderTxt::~L1DynamicPedestalProviderTxt ( )

virtual

default destructor

Definition at line 80 of file L1DynamicPedestalProviderTxt.cxx.

 {
   // keep destructor in .cxx file since ~unique_ptr needs full type
 }

Member Function Documentation

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyArrayType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
   }

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	t,
		const SG::NotHandleType &
	)

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleBase &	hndl,
		const std::string &	doc,
		const SG::VarHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

   {
     this->declare(hndl.vhKey());
     hndl.vhKey().setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKey &	hndl,
		const std::string &	doc,
		const SG::VarHandleKeyType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

   {
     this->declare(hndl);
     hndl.setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKeyArray &	hndArr,
		const std::string &	doc,
		const SG::VarHandleKeyArrayType &
	)

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

   {
  
     // std::ostringstream ost;
     // ost << Algorithm::name() << " VHKA declareProp: " << name 
     //     << " size: " << hndArr.keys().size() 
     //     << " mode: " << hndArr.mode() 
     //     << "  vhka size: " << m_vhka.size()
     //     << "\n";
     // debug() << ost.str() << endmsg;
  
     hndArr.setOwner(this);
     m_vhka.push_back(&hndArr);
  
     Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
     if (p != 0) {
       p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
     } else {
       ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                     << name);
     }
  
     return p;
  
   }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc,
		const SG::NotHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(name, property, doc);
   }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

   {
     typedef typename SG::HandleClassifier<T>::type htype;
     return declareProperty (name, property, doc, htype());
   }

◆ declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                  {
     typedef typename SG::HandleClassifier<T>::type htype;
     return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
   }

◆ detStore()

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95 { return m_detStore; }

◆ distanceFromHeadOfTrain()

std::pair< bool, int > LVL1::L1DynamicPedestalProviderTxt::distanceFromHeadOfTrain ( int bcid ) const

private

Definition at line 179 of file L1DynamicPedestalProviderTxt.cxx.

 {
   const auto BC = BunchCrossingCondData::BunchCrossings;
  
   SG::ReadCondHandle<BunchCrossingCondData> bcData(m_bcDataKey);
  
   if(bcData->isFilled(bcid) || bcData->bcType(bcid) == BunchCrossingCondData::MiddleEmpty) {
     return {bcData->gapBeforeTrain(bcid) > 250, bcData->distanceFromFront(bcid, BC)};
   } else {
     if(bcData->gapAfterBunch(bcid, BC) == 0) {
       const bcid_t head = ((bcid + 1) == MAX_BCID ? 0 : bcid + 1); // wrap around
       return {bcData->gapBeforeTrain(head) > 250, -1};
     } else if(bcData->gapBeforeBunch(bcid, BC) == 0) {
       const bcid_t tail = bcid ? bcid - 1 : MAX_BCID - 1; // wrap around
       return {bcData->gapBeforeTrain(tail) > 250,
               bcData->distanceFromFront(tail, BC) + 1};
     } else {
       return {false, -10};
     }
   }
 }

◆ dynamicPedestal()

int LVL1::L1DynamicPedestalProviderTxt::dynamicPedestal	(	int	iEta,
		int	layer,
		int	pedestal,
		int	iBCID,
		float	mu
	)		const

overridevirtual

retrieve the bcidCorrection value

Implements LVL1::IL1DynamicPedestalProvider.

Definition at line 205 of file L1DynamicPedestalProviderTxt.cxx.

 {
   /*
    * Uncomment this for debugging/printing the full bunch train pattern
    *
   static bool first=true;
   if (first) {
     SG::ReadCondHandle<BunchCrossingCondData> bcData(m_bcDataKey);
     first = false;
     std::vector<std::pair<bool, int16_t>> dist;
     dist.assign(MAX_BCID, std::make_pair(false, -10));
     for(bcid_t bcid = 0; bcid != MAX_BCID; ++bcid) {
       dist[bcid] = distanceFromHeadOfTrain(bcid);
     }
     printPatternParsingInfo(msg(), *bcData.retrieve(), dist);
   }
   */
  
   if(iBCID < 0 || (unsigned)iBCID >= MAX_BCID) return pedestal;
  
   // Only one bunch train is parameterized. Thus the BCID needs to be mapped
   // to the first train. The train starts at bcid = 1, thus the '+ 1'.
   // Bunches without available parameterization will have a value of -9 and a value of 0 is returned.
   auto bcidInfo = distanceFromHeadOfTrain(iBCID);
   bool longGap = bcidInfo.first;
   int bcid = bcidInfo.second + 1;
   
   if(bcid < 0) return pedestal;
  
   // The parameterization is done for the dynamic pedestal correction,
   // i.e. correction = (dynamic_pedestal - pedestal).
   // Since the return value is expected to be the dynamic_pedestal itself, the
   // pedestal is added to the value obtained from the parameterization.
   int correction = 0;
   if(layer == 0) {
     correction = std::round((*m_emParameterizations[longGap][iElement][bcid])(mu));
   } else if(layer == 1) {
     correction = std::round((*m_hadParameterizations[longGap][iElement][bcid])(mu));
   } else {
     ATH_MSG_ERROR("Wrong layer index. Give 0 for Em, 1 for Had.");
   }
  
   // Hardware cannot calculate a dynamic pedestal < 0, but it is possible the parameterisation can
   int dynamic_pedestal = correction + pedestal;
   if (dynamic_pedestal < 0) dynamic_pedestal = 0;
  
   return dynamic_pedestal;
 }

◆ evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85 { return m_evtStore; }

◆ evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( ) const

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ initialize()

StatusCode LVL1::L1DynamicPedestalProviderTxt::initialize ( )

overridevirtual

standard Athena-Algorithm method

Definition at line 87 of file L1DynamicPedestalProviderTxt.cxx.

 {
   ATH_CHECK( m_bcDataKey.initialize() );
  
   // parse parameterization for the electromagnetic layer
   std::string fileNameEMShort = PathResolver::find_file(m_inputFileEMShort, "DATAPATH");
   if(fileNameEMShort.empty()) {
     ATH_MSG_FATAL("Could not resolve input file: " << m_inputFileEMShort);
     return StatusCode::FAILURE;
   }
   ATH_MSG_VERBOSE("::initialize: resolved input file: " << fileNameEMShort);
  
   try {
     parseInputFile(fileNameEMShort, m_emParameterizations[0]);
   } catch (const ParseException& e) {
     ATH_MSG_FATAL("Could not parse input file: " << fileNameEMShort << "; error: " << e.what());
     return StatusCode::FAILURE;
   }
  
   std::string fileNameEMLong = PathResolver::find_file(m_inputFileEMLong, "DATAPATH");
   if(fileNameEMLong.empty()) {
     ATH_MSG_FATAL("Could not resolve input file: " << m_inputFileEMLong);
     return StatusCode::FAILURE;
   }
   ATH_MSG_VERBOSE("::initialize: resolved input file: " << fileNameEMLong);
  
   try {
     parseInputFile(fileNameEMLong, m_emParameterizations[1]);
   } catch (const ParseException& e) {
     ATH_MSG_FATAL("Could not parse input file: " << fileNameEMLong << "; error: " << e.what());
     return StatusCode::FAILURE;
   }
  
   // parse parameterization for the hadronic layer
   std::string fileNameHADShort = PathResolver::find_file(m_inputFileHADShort, "DATAPATH");
   if(fileNameHADShort.empty()) {
     ATH_MSG_FATAL("Could not resolve input file: " << m_inputFileHADShort);
     return StatusCode::FAILURE;
   }
   ATH_MSG_VERBOSE("::initialize: resolved input file: " << fileNameHADShort);
  
   try {
     parseInputFile(fileNameHADShort, m_hadParameterizations[0]);
   } catch (const ParseException& e) {
     ATH_MSG_FATAL("Could not parse input file: " << fileNameHADShort << "; error: " << e.what());
     return StatusCode::FAILURE;
   }
  
   std::string fileNameHADLong = PathResolver::find_file(m_inputFileHADLong, "DATAPATH");
   if(fileNameHADLong.empty()) {
     ATH_MSG_FATAL("Could not resolve input file: " << m_inputFileHADLong);
     return StatusCode::FAILURE;
   }
   ATH_MSG_VERBOSE("::initialize: resolved input file: " << fileNameHADLong);
  
   try {
     parseInputFile(fileNameHADLong, m_hadParameterizations[1]);
   } catch (const ParseException& e) {
     ATH_MSG_FATAL("Could not parse input file: " << fileNameHADLong << "; error: " << e.what());
     return StatusCode::FAILURE;
   }
  
   return StatusCode::SUCCESS;
 }

◆ inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ interfaceID()

const InterfaceID & LVL1::IL1DynamicPedestalProvider::interfaceID ( )

inlinestaticinherited

Definition at line 30 of file IL1DynamicPedestalProvider.h.

 {
   return IID_IL1DynamicPedestalProvider;
 }

◆ msg() [1/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                                {
     return this->msgLevel(lvl);
   }

◆ outputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ parseInputFile()

void LVL1::L1DynamicPedestalProviderTxt::parseInputFile	(	const std::string &	fileName,
		std::vector< std::vector< std::unique_ptr< ParamFunc >>> &	params
	)

private

Definition at line 295 of file L1DynamicPedestalProviderTxt.cxx.

 {
   using std::istream_iterator;
  
   std::ifstream F(fileName);
   Context ctx;
  
   // read file line-by-line
   const std::set<char> whitespaces{'\t',' ','\n','\r'};
   for(std::string L; std::getline(F, L); ) {
     while ((!L.empty()) && whitespaces.count(L.back())) L.pop_back();
     if(L.empty()) continue; // ignore empty lines
     if(L[0] == '#') continue; // ignore comments
  
     std::istringstream S(L);
  
     // parsing
     if(ctx.P == Context::Element) {
       // start parsing a new element block
       std::string C = "";
       S >> C >> ctx.E;
       if(C != "element")
         throw ParseException("got '" + C + "' expected 'element'.");
       if(ctx.E > s_nElements)
         throw ParseException("element number (" +  std::to_string(ctx.E) + ") out-of-range.");
       
       ctx.P = Context::Poly; // advance state
     } else if(ctx.P == Context::Poly) {
       // start parsing a poly line
       std::string C = "";
       S >> C;
       if(C != "poly")  throw ParseException("got '" + C + "' expected 'poly'.");
       std::copy(istream_iterator<size_t>(S), istream_iterator<size_t>(), std::back_inserter(ctx.poly));
  
       ctx.P = Context::Exp; // advance state
     } else if(ctx.P == Context::Exp) {
       // start parsing a exp line
       std::string C = "";
       S >> C;
       if(C != "exp")  throw ParseException("got '" + C + "' expected 'exp'.");
       std::copy(istream_iterator<size_t>(S), istream_iterator<size_t>(), std::back_inserter(ctx.exp));
  
       ctx.P = Context::BCID; // advance state
     } else if(ctx.P == Context::BCID) {
       size_t B;
       std::vector<float> P;
       S >> B; // bcid
       std::copy(istream_iterator<float>(S), istream_iterator<float>(), back_inserter(P)); // parameters
       if(P.size() != 3) {
     throw ParseException("BCID=" + std::to_string(B) +
                  ": expected 3 parameters got " + std::to_string(P.size()));
       }
       if(std::binary_search(ctx.poly.begin(), ctx.poly.end(), B)) {
         params[ctx.E][B] = make_unique<ParamFuncPol2>(P[0], P[1], P[2]);
       } else if(std::binary_search(ctx.exp.begin(), ctx.exp.end(), B)) {
         params[ctx.E][B] = make_unique<ParamFuncExp>(P[0], P[1], P[2]);
       } else {
     throw ParseException("BCID '" + std::to_string(B) + "' didn't appear in 'poly' or 'exp' for element '" +
                              std::to_string(ctx.E) + "'.");
       }
  
       if(++ctx.N == (ctx.poly.size() + ctx.exp.size())) {
     // all bcids exhausted block is finished
         if(ctx.N != s_nBCIDPerTrain) {
           throw ParseException("Not all BCIDs filled");
         }
  
     ctx.reset();
       }
     }
   }
  
   for(auto& V : params) {
     if(std::find_if(V.begin(), V.end(), [](std::unique_ptr<ParamFunc>& p) { return p == nullptr; }) != V.end()) {
       throw ParseException("Not all elements and bcids filled!");
     }
   }
 }

◆ renounce()

std::enable_if_t<std::is_void_v<std::result_of_t<decltype(&T::renounce)(T)> > && !std::is_base_of_v<SG::VarHandleKeyArray, T> && std::is_base_of_v<Gaudi::DataHandle, T>, void> AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

   {
     h.renounce();
     PBASE::renounce (h);
   }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                           {
     handlesArray.renounce();
   }

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                                {
     // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
     //         << "  size: " << m_vhka.size() << endmsg;
     for (auto &a : m_vhka) {
       std::vector<SG::VarHandleKey*> keys = a->keys();
       for (auto k : keys) {
         k->setOwner(this);
       }
     }
   }

Member Data Documentation

◆ m_bcDataKey

SG::ReadCondHandleKey<BunchCrossingCondData> LVL1::L1DynamicPedestalProviderTxt::m_bcDataKey {this, "BunchCrossingCondDataKey", "BunchCrossingData" ,"SG Key of BunchCrossing CDO"}

private

Definition at line 79 of file L1DynamicPedestalProviderTxt.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_emParameterizations

std::array<std::vector<std::vector<std::unique_ptr<ParamFunc> > >, 2> LVL1::L1DynamicPedestalProviderTxt::m_emParameterizations

private

Definition at line 75 of file L1DynamicPedestalProviderTxt.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_hadParameterizations

std::array<std::vector<std::vector<std::unique_ptr<ParamFunc> > >, 2> LVL1::L1DynamicPedestalProviderTxt::m_hadParameterizations

private

Definition at line 76 of file L1DynamicPedestalProviderTxt.h.

◆ m_inputFileEMLong

std::string LVL1::L1DynamicPedestalProviderTxt::m_inputFileEMLong

private

Definition at line 84 of file L1DynamicPedestalProviderTxt.h.

◆ m_inputFileEMShort

std::string LVL1::L1DynamicPedestalProviderTxt::m_inputFileEMShort

private

Definition at line 82 of file L1DynamicPedestalProviderTxt.h.

◆ m_inputFileHADLong

std::string LVL1::L1DynamicPedestalProviderTxt::m_inputFileHADLong

private

Definition at line 85 of file L1DynamicPedestalProviderTxt.h.

◆ m_inputFileHADShort

std::string LVL1::L1DynamicPedestalProviderTxt::m_inputFileHADShort

private

Definition at line 83 of file L1DynamicPedestalProviderTxt.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

◆ s_nBCIDPerTrain

const unsigned LVL1::L1DynamicPedestalProviderTxt::s_nBCIDPerTrain = 74

staticprivate

Definition at line 95 of file L1DynamicPedestalProviderTxt.h.

◆ s_nElements

const unsigned LVL1::L1DynamicPedestalProviderTxt::s_nElements = 33

staticprivate

Definition at line 94 of file L1DynamicPedestalProviderTxt.h.

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

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ L1DynamicPedestalProviderTxt()

◆ ~L1DynamicPedestalProviderTxt()

Member Function Documentation

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ distanceFromHeadOfTrain()

◆ dynamicPedestal()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ parseInputFile()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_bcDataKey

◆ m_detStore

◆ m_emParameterizations

◆ m_evtStore

◆ m_hadParameterizations

◆ m_inputFileEMLong

◆ m_inputFileEMShort

◆ m_inputFileHADLong

◆ m_inputFileHADShort

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ s_nBCIDPerTrain

◆ s_nElements