read TRT calibration constants from db and write text file More...

#include <TRTCondRead.h>

Inheritance diagram for TRTCondRead:

Collaboration diagram for TRTCondRead:

Public Types
typedef TRTCond::RtRelationMultChanContainer	RtRelationContainer
typedef TRTCond::StrawT0MultChanContainer	StrawT0Container

Public Member Functions
	TRTCondRead (const std::string &name, ISvcLocator *pSvcLocator)
	constructor
virtual	~TRTCondRead () override=default
virtual StatusCode	initialize (void) override
virtual StatusCode	execute (void) override
virtual StatusCode	finalize (void) override
virtual TRTCond::ExpandedIdentifier	trtcondid (const Identifier &id, int level=TRTCond::ExpandedIdentifier::STRAW) const
	create an TRTCond::ExpandedIdentifier from a TRTID identifier
virtual StatusCode	writeCalibTextFile (std::ostream &) const
	write calibration constants or errors to flat text file
virtual StatusCode	writeErrorTextFile (std::ostream &) const
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
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.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
ToolHandle< ITRT_CalDbTool >	m_TRTCalDbTool {this, "TRTCalDbTool", "CalDbTool", "Access to the folder of the calibration constants"}
Gaudi::Property< std::string >	m_par_caloutputfile {this, "CalibOutputFile", "caliboutput.txt", ""}
const TRT_ID *	m_trtid {}
	trt id helper
DataObjIDColl	m_extendedExtraObjects
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

read TRT calibration constants from db and write text file

Definition at line 31 of file TRTCondRead.h.

Member Typedef Documentation

◆ RtRelationContainer

typedef TRTCond::RtRelationMultChanContainer TRTCondRead::RtRelationContainer

Definition at line 34 of file TRTCondRead.h.

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

◆ StrawT0Container

typedef TRTCond::StrawT0MultChanContainer TRTCondRead::StrawT0Container

Definition at line 35 of file TRTCondRead.h.

Constructor & Destructor Documentation

◆ TRTCondRead()

TRTCondRead::TRTCondRead	(	const std::string &	name,
		ISvcLocator *	pSvcLocator )

constructor

Definition at line 20 of file TRTCondRead.cxx.

21 : AthAlgorithm(name, pSvcLocator) {}

AthAlgorithm::AthAlgorithm

AthAlgorithm()

Default constructor:

◆ ~TRTCondRead()

virtual TRTCondRead::~TRTCondRead ( )

overridevirtualdefault

Member Function Documentation

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	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());
 
  }

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( Gaudi::Property< T, V, H > & 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< Algorithm > >::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; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::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; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode TRTCondRead::execute ( void )

overridevirtual

Definition at line 36 of file TRTCondRead.cxx.

{
 
    // Write text file.
    if (!m_par_caloutputfile.empty())
    {
        ATH_MSG_INFO(" Writing calibration constants to text file " << m_par_caloutputfile);
        std::ofstream outfile(m_par_caloutputfile);
        // if ((m_par_caloutputfile.value()).contains("caliboutput")) TO BE CORRECTED when C++23
        if (m_par_caloutputfile.value().find("caliboutput") != std::string::npos)
        {
            ATH_MSG_INFO("File name: "<< m_par_caloutputfile);
            ATH_CHECK(writeCalibTextFile(outfile));
        }
        // else if ((m_par_caloutputfile.value()).contains("erroroutput")) TO BE CORRECTED when C++23
        else if (m_par_caloutputfile.value().find("erroroutput") != std::string::npos)
        {
            ATH_MSG_INFO("File name: "<< m_par_caloutputfile);
            ATH_CHECK(writeErrorTextFile(outfile));
        }
        else
        {
            ATH_MSG_WARNING("The file name must contain either 'caliboutput' or 'erroroutput' ");
        }
        outfile.close();
    }
 
    // Quick spot check of the T0s
    ATH_MSG_INFO(" Spot check of T0 in every 10'th straw_layer in phi_modules 0, 10, 20 and 30");
    for (std::vector<Identifier>::const_iterator it = m_trtid->straw_layer_begin(); it != m_trtid->straw_layer_end(); ++it)
    {
        Identifier id = m_trtid->straw_id(*it, 0);
        if (m_trtid->phi_module(id) % 10 == 0 && m_trtid->straw_layer(id) % 10 == 0)
        {
            float t0 = m_TRTCalDbTool->getT0(id);
            ATH_MSG_INFO(" bec: " << m_trtid->barrel_ec(id) << " lay: " << m_trtid->layer_or_wheel(id) << " phi: " << m_trtid->phi_module(id) << " slay: " << m_trtid->straw_layer(id) << " t0: " << t0);
        }
    }
 
    ATH_MSG_INFO("");
    ATH_MSG_INFO("List of straws with T0=0 :");
 
    int nzeros = 0;
    for (std::vector<Identifier>::const_iterator it = m_trtid->straw_layer_begin(); it != m_trtid->straw_layer_end(); ++it)
    {
        int nStrawsInLayer = m_trtid->straw_max(*it);
        for (int i = 0; i <= nStrawsInLayer; i++)
        {
            Identifier strid = m_trtid->straw_id(*it, i);
            if (m_TRTCalDbTool->getT0(strid) == 0)
            {
                ATH_MSG_INFO(" bec: " << m_trtid->barrel_ec(strid) << " lay: " << m_trtid->layer_or_wheel(strid)
                                      << " phi: " << m_trtid->phi_module(strid) << " slay: " << m_trtid->straw_layer(strid) << " straw: " << m_trtid->straw(strid));
                nzeros++;
            }
        }
    }
 
    if (nzeros > 10)
    {
        ATH_MSG_INFO(" Several cases of T0=0. Check the input text file and assign default T0 values instead of zero ");
    }
    ATH_MSG_INFO("");
 
    return StatusCode::SUCCESS;
}

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::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

◆ extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 50 of file AthAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return Algorithm::extraOutputDeps();
}

◆ finalize()

StatusCode TRTCondRead::finalize ( void )

overridevirtual

Definition at line 103 of file TRTCondRead.cxx.

{
    return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode TRTCondRead::initialize ( void )

overridevirtual

Definition at line 23 of file TRTCondRead.cxx.

{
 
    ATH_MSG_DEBUG("TRTCondRead::initialize() called");
 
    ATH_CHECK(m_TRTCalDbTool.retrieve());
 
    // Get TRT ID helper
    ATH_CHECK(detStore()->retrieve(m_trtid, "TRT_ID"));
 
    return StatusCode::SUCCESS;
}

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::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.

◆ msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< Algorithm >::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< Algorithm > >::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.

◆ 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< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

StatusCode AthAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, and PyAthena::Alg.

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;
}

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::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.

◆ trtcondid()

TRTCond::ExpandedIdentifier TRTCondRead::trtcondid	(	const Identifier &	id,
		int	level = TRTCond::ExpandedIdentifier::STRAW ) const

virtual

create an TRTCond::ExpandedIdentifier from a TRTID identifier

Definition at line 177 of file TRTCondRead.cxx.

{
    return TRTCond::ExpandedIdentifier(m_trtid->barrel_ec(id), m_trtid->layer_or_wheel(id),
                                       m_trtid->phi_module(id), m_trtid->straw_layer(id),
                                       m_trtid->straw(id), level);
}

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::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);
      }
    }
  }

◆ writeCalibTextFile()

StatusCode TRTCondRead::writeCalibTextFile ( std::ostream & outfile ) const

virtual

write calibration constants or errors to flat text file

Definition at line 108 of file TRTCondRead.cxx.

{
    const RtRelationContainer *rtContainer = m_TRTCalDbTool->getRtContainer();
    const StrawT0Container *t0Container = m_TRTCalDbTool->getT0Container();
 
    // first store rtrelations
    outfile << "# Rtrelation" << std::endl;
    RtRelationContainer::FlatContainer rtrelations;
    rtContainer->getall(rtrelations);
    for (RtRelationContainer::FlatContainer::iterator it = rtrelations.begin(); it != rtrelations.end(); ++it)
    {
        // write the identifier
        outfile << it->first << " : ";
        // write the rt-relation via the factory
        TRTCond::RtRelationFactory::writeToFile(outfile, **(it->second));
        outfile << std::endl;
    }
 
    // now store the t0s
    outfile << "# StrawT0" << std::endl;
    StrawT0Container::FlatContainer packedstrawdata;
    t0Container->getall(packedstrawdata);
    float t0(0), t0err(0);
    for (TRTCond::StrawT0Container::FlatContainer::iterator it = packedstrawdata.begin(); it != packedstrawdata.end(); ++it)
    {
        const TRTCond::ExpandedIdentifier &calid = it->first;
        t0Container->unpack(calid, *it->second, t0, t0err);
        outfile << calid << " : " << t0 << " " << t0err << std::endl;
    }
 
    return StatusCode::SUCCESS;
}

◆ writeErrorTextFile()

StatusCode TRTCondRead::writeErrorTextFile ( std::ostream & outfile ) const

virtual

Definition at line 141 of file TRTCondRead.cxx.

{
    const RtRelationContainer *errContainer = m_TRTCalDbTool->getErrContainer();
    const RtRelationContainer *slopeContainer = m_TRTCalDbTool->getSlopeContainer();
 
    // then store errors2d
    outfile << "# RtErrors" << std::endl;
    RtRelationContainer::FlatContainer errors;
    errContainer->getall(errors);
    for (RtRelationContainer::FlatContainer::iterator it = errors.begin();
         it != errors.end(); ++it)
    {
        // write the identifier
        outfile << it->first << " : ";
        // write the errors via the factory
        TRTCond::RtRelationFactory::writeToFile(outfile, **(it->second));
        outfile << std::endl;
    }
 
    // then store slopes
    outfile << "# RtSlopes" << std::endl;
    RtRelationContainer::FlatContainer slopes;
    slopeContainer->getall(slopes);
    for (RtRelationContainer::FlatContainer::iterator it = slopes.begin();
         it != slopes.end(); ++it)
    {
        // write the identifier
        outfile << it->first << " : ";
        // write the slopes via the factory
        TRTCond::RtRelationFactory::writeToFile(outfile, **(it->second));
        outfile << std::endl;
    }
 
    return StatusCode::SUCCESS;
}

Member Data Documentation

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

◆ m_par_caloutputfile

Gaudi::Property<std::string> TRTCondRead::m_par_caloutputfile {this, "CalibOutputFile", "caliboutput.txt", ""}

private

Definition at line 57 of file TRTCondRead.h.

57{this, "CalibOutputFile", "caliboutput.txt", ""};

◆ m_TRTCalDbTool

ToolHandle<ITRT_CalDbTool> TRTCondRead::m_TRTCalDbTool {this, "TRTCalDbTool", "CalDbTool", "Access to the folder of the calibration constants"}

private

Definition at line 56 of file TRTCondRead.h.

56{this, "TRTCalDbTool", "CalDbTool", "Access to the folder of the calibration constants"};

◆ m_trtid

const TRT_ID* TRTCondRead::m_trtid {}

private

trt id helper

Definition at line 58 of file TRTCondRead.h.

58{};

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ RtRelationContainer

◆ StoreGateSvc_t

◆ StrawT0Container

Constructor & Destructor Documentation

◆ TRTCondRead()

◆ ~TRTCondRead()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ trtcondid()

◆ updateVHKA()

◆ writeCalibTextFile()

◆ writeErrorTextFile()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_par_caloutputfile

◆ m_TRTCalDbTool

◆ m_trtid

◆ m_varHandleArraysDeclared

◆ m_vhka