Algorithm for writing LAr alignment constants to Cond DB and reading them back. More...

#include <LArAlignDbAlg.h>

Inheritance diagram for LArAlignDbAlg:

Collaboration diagram for LArAlignDbAlg:

Public Member Functions
	LArAlignDbAlg (const std::string &name, ISvcLocator *pSvcLocator)
	~LArAlignDbAlg ()
virtual StatusCode	initialize () override
virtual StatusCode	execute (const EventContext &ctx) override
	Execute method.
virtual StatusCode	finalize () override
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
bool	filterPassed (const EventContext &ctx) const
void	setFilterPassed (bool state, const EventContext &ctx) const
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

const EventContext &	getContext () const
	Deprecated methods (use the ones with EventContext).
bool	filterPassed () const
void	setFilterPassed (bool state) const

Protected Member Functions
virtual bool	isReEntrant () const override final
	Legacy algorithms are not thread-safe.
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
StatusCode	createCondObjects ()
StatusCode	printCondObjects ()
StatusCode	streamOutCondObjects ()
StatusCode	registerCondObjects ()
StatusCode	registerIOV (const CLID &clid)
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
BooleanProperty	m_writeCondObjs {this, "WriteCondObjs", false}
BooleanProperty	m_regIOV {this, "RegisterIOV", false}
StringProperty	m_streamName {this, "StreamName", "CondStream1"}
StringProperty	m_inpFile {this, "InpFile", "LArAlign.inp"}
StringProperty	m_outpFile {this, "OutpFile", "LArAlign-TEST.pool.root"}
StringProperty	m_outpTag {this, "TagName", "LARAlign-TEST"}
ServiceHandle< IIOVRegistrationSvc >	m_regSvc
ToolHandle< IAthenaOutputStreamTool >	m_streamer
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

Algorithm for writing LAr alignment constants to Cond DB and reading them back.

Definition at line 20 of file LArAlignDbAlg.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ LArAlignDbAlg()

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

Definition at line 18 of file LArAlignDbAlg.cxx.

                                                                            :
  AthAlgorithm(name, pSvcLocator),
  m_regSvc("IOVRegistrationSvc",name),
  m_streamer("AthenaOutputStreamTool")
{
}

◆ ~LArAlignDbAlg()

LArAlignDbAlg::~LArAlignDbAlg ( )

Definition at line 26 of file LArAlignDbAlg.cxx.

27{

28}

Member Function Documentation

◆ createCondObjects()

StatusCode LArAlignDbAlg::createCondObjects ( )

private

Definition at line 94 of file LArAlignDbAlg.cxx.

{
  ATH_MSG_INFO(" in createCondObjects() "  );
  
  if(detStore()->contains<DetCondKeyTrans>(LAR_ALIGN)) {
    ATH_MSG_INFO( " DetCondKeyTrans already exists, do nothing "  );
    return StatusCode::SUCCESS;
  }
 
  // Read input file, construct relevant transforms
  std::ifstream infile;
  infile.open(m_inpFile.value().c_str());
 
  if(!infile.is_open()) {
    ATH_MSG_ERROR( "Unable to open " << m_inpFile << " for reading"  );
    return StatusCode::FAILURE;
  }
 
  auto transforms = std::make_unique<DetCondKeyTrans>();
 
  char commentSign = '#';
  std::string commentLine;
  std::string key;
  double x, y, z, theta, phi, rotationAngle;
 
  while(!infile.eof()) {
    infile >> key;
    if(key.empty()) continue;
    if(key[0]==commentSign)
      std::getline(infile,commentLine);
    else {
      infile >> theta >> phi >> rotationAngle >> x >> y >> z;
 
      Hep3Vector axis(sin(theta)*cos(phi),sin(theta)*sin(phi),cos(theta));
      transforms->setTransform(key,Translate3D(x,y,z)*Rotate3D(rotationAngle,axis));
    }
  }
  infile.close();
 
  ATH_CHECK( detStore()->record(std::move(transforms),LAR_ALIGN) );
  ATH_MSG_DEBUG( " Recorded LAr/Align "  );
  
  return StatusCode::SUCCESS;
}

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::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< Gaudi::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< Gaudi::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< Gaudi::Algorithm > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Gaudi::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< Gaudi::Algorithm > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode LArAlignDbAlg::execute ( const EventContext & ctx )

overridevirtual

Execute method.

Provides access to the EventContext if needed but is non-const as opposed to AthReentrantAlgorithm.

Implements AthAlgorithm.

Definition at line 51 of file LArAlignDbAlg.cxx.

{
  ATH_MSG_DEBUG(" in execute() "  );
 
  int nrun = ctx.eventID().run_number();
  int nevt = ctx.eventID().event_number();
 
  ATH_MSG_DEBUG( " Event: [" << nrun << "," << nevt << "]"  );
 
  // If I need to write out the conditions object I'll do that on the first event
  if (m_writeCondObjs && nevt==1) {
    ATH_MSG_DEBUG( "Creating conditions objects for run " << nrun  );
      
    ATH_CHECK( createCondObjects() );
    ATH_CHECK( printCondObjects() );
  } else {
    //  Read objects from DetectorStore
    ATH_CHECK( printCondObjects() );
  }
    
  return StatusCode::SUCCESS;
}

◆ extraDeps_update_handler()

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

◆ filterPassed() [1/2]

bool AthAlgorithm::filterPassed ( ) const

inherited

Definition at line 94 of file AthAlgorithm.cxx.

                                      {
  return filterPassed( Gaudi::Hive::currentContext() );
}

◆ filterPassed() [2/2]

bool AthAlgorithm::filterPassed ( const EventContext & ctx ) const

inherited

Definition at line 98 of file AthAlgorithm.cxx.

                                                             {
  return execState( ctx ).filterPassed();
}

◆ finalize()

StatusCode LArAlignDbAlg::finalize ( )

overridevirtual

Definition at line 76 of file LArAlignDbAlg.cxx.

{
  ATH_MSG_DEBUG( " in finalize() "  );
  if(m_writeCondObjs) {
    ATH_CHECK( streamOutCondObjects() );
    ATH_MSG_DEBUG( " Streamed out OK "  );
  }
 
  if(m_regIOV) {
    ATH_CHECK( registerCondObjects() );
    ATH_MSG_DEBUG( " Register OK "  );
  }
  
  return StatusCode::SUCCESS;
}

◆ getContext()

const EventContext & AthAlgorithm::getContext ( ) const

inherited

Deprecated methods (use the ones with EventContext).

Definition at line 90 of file AthAlgorithm.cxx.

                                                   {
  return Gaudi::Hive::currentContext();
}

◆ initialize()

StatusCode LArAlignDbAlg::initialize ( )

overridevirtual

Definition at line 31 of file LArAlignDbAlg.cxx.

{
  ATH_MSG_DEBUG(" in initialize()"  );
 
  // Get Output Stream tool for writing
  if(m_writeCondObjs) {
    ATH_CHECK( m_streamer.retrieve() );
  }
    
  // Get the IOVRegistrationSvc when needed
  if(m_regIOV) {
    ATH_CHECK( m_regSvc.retrieve() );
    ATH_MSG_DEBUG( "Found IOVRegistrationSvc "   );
  }
 
  return StatusCode::SUCCESS;
}

◆ inputHandles()

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

◆ isReEntrant()

virtual bool AthAlgorithm::isReEntrant ( ) const

inlinefinaloverrideprotectedvirtualinherited

Legacy algorithms are not thread-safe.

Definition at line 111 of file AthAlgorithm.h.

111{ return false; }

◆ msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

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

◆ printCondObjects()

StatusCode LArAlignDbAlg::printCondObjects ( )

private

Definition at line 141 of file LArAlignDbAlg.cxx.

{
  const DetCondKeyTrans* align;
  StatusCode sc = detStore()->retrieve(align, LAR_ALIGN);
 
  if(sc.isFailure()) 
    ATH_MSG_WARNING( " Could not find DetCondKeyTrans"  );
  else if(nullptr == align) 
    ATH_MSG_WARNING(" DetCondKeyTrans ptr is 0"  );
  else {
    std::cout << " \n\n**************************************************** \n";
    std::cout << " ****                                            **** \n";
    std::cout << " ****         Printing Conditions Objects        **** \n";
    std::cout << " ****                                            **** \n";
    std::cout << " **************************************************** \n";
    
    align->print();
    
    std::cout << " ****  **** **** ****     END     **** **** **** **** \n\n\n";
  }
 
  return StatusCode::SUCCESS;
}

◆ registerCondObjects()

StatusCode LArAlignDbAlg::registerCondObjects ( )

private

Definition at line 190 of file LArAlignDbAlg.cxx.

{
  ATH_MSG_DEBUG( "entering registerCondObject()"   );
  
  std::string objname = "DetCondKeyTrans";
 
  // Register the IOV DB with the conditions data written out
  ATH_CHECK( m_regSvc->registerIOV(objname, m_outpTag) );
  return StatusCode::SUCCESS;
}

◆ registerIOV()

StatusCode LArAlignDbAlg::registerIOV ( const CLID & clid )

private

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

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ setFilterPassed() [1/2]

void AthAlgorithm::setFilterPassed ( bool state ) const

inherited

Definition at line 102 of file AthAlgorithm.cxx.

                                                     {
  setFilterPassed( state, Gaudi::Hive::currentContext() );
}

◆ setFilterPassed() [2/2]

void AthAlgorithm::setFilterPassed	(	bool	state,
		const EventContext &	ctx ) const

inherited

Definition at line 106 of file AthAlgorithm.cxx.

                                                                              {
  execState( ctx ).setFilterPassed(state);
}

◆ streamOutCondObjects()

StatusCode LArAlignDbAlg::streamOutCondObjects ( )

private

Definition at line 167 of file LArAlignDbAlg.cxx.

{
  ATH_MSG_DEBUG( " entering streamOutCondObjects "   );
 
  ATH_CHECK( m_streamer->connectOutput(m_outpFile.value()) );
  ATH_MSG_DEBUG(" Did connect stream to output"  );
 
  int npairs = 1;
 
  IAthenaOutputStreamTool::TypeKeyPairs typeKeys(npairs);
 
  IAthenaOutputStreamTool::TypeKeyPair align("DetCondKeyTrans", LAR_ALIGN);
  typeKeys[0] = std::move(align);
  
  ATH_CHECK( m_streamer->streamObjects(typeKeys) );
  ATH_CHECK( m_streamer->commitOutput() );
 
  return StatusCode::SUCCESS;
}

◆ 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< Gaudi::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< Gaudi::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.

◆ updateVHKA()

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

Member Data Documentation

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::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< Gaudi::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 114 of file AthAlgorithm.h.

◆ m_inpFile

StringProperty LArAlignDbAlg::m_inpFile {this, "InpFile", "LArAlign.inp"}

private

Definition at line 42 of file LArAlignDbAlg.h.

42{this, "InpFile", "LArAlign.inp"};

◆ m_outpFile

StringProperty LArAlignDbAlg::m_outpFile {this, "OutpFile", "LArAlign-TEST.pool.root"}

private

Definition at line 43 of file LArAlignDbAlg.h.

43{this, "OutpFile", "LArAlign-TEST.pool.root"};

◆ m_outpTag

StringProperty LArAlignDbAlg::m_outpTag {this, "TagName", "LARAlign-TEST"}

private

Definition at line 44 of file LArAlignDbAlg.h.

44{this, "TagName", "LARAlign-TEST"};

◆ m_regIOV

BooleanProperty LArAlignDbAlg::m_regIOV {this, "RegisterIOV", false}

private

Definition at line 40 of file LArAlignDbAlg.h.

40{this, "RegisterIOV", false};

◆ m_regSvc

ServiceHandle<IIOVRegistrationSvc> LArAlignDbAlg::m_regSvc

private

Definition at line 46 of file LArAlignDbAlg.h.

◆ m_streamer

ToolHandle<IAthenaOutputStreamTool> LArAlignDbAlg::m_streamer

private

Definition at line 47 of file LArAlignDbAlg.h.

◆ m_streamName

StringProperty LArAlignDbAlg::m_streamName {this, "StreamName", "CondStream1"}

private

Definition at line 41 of file LArAlignDbAlg.h.

41{this, "StreamName", "CondStream1"};

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

◆ m_writeCondObjs

BooleanProperty LArAlignDbAlg::m_writeCondObjs {this, "WriteCondObjs", false}

private

Definition at line 39 of file LArAlignDbAlg.h.

39{this, "WriteCondObjs", false};

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ LArAlignDbAlg()

◆ ~LArAlignDbAlg()

Member Function Documentation

◆ createCondObjects()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ filterPassed() [1/2]

◆ filterPassed() [2/2]

◆ finalize()

◆ getContext()

◆ initialize()

◆ inputHandles()

◆ isReEntrant()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ printCondObjects()

◆ registerCondObjects()

◆ registerIOV()

◆ renounce()

◆ renounceArray()

◆ setFilterPassed() [1/2]

◆ setFilterPassed() [2/2]

◆ streamOutCondObjects()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_inpFile

◆ m_outpFile

◆ m_outpTag

◆ m_regIOV

◆ m_regSvc

◆ m_streamer

◆ m_streamName

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ m_writeCondObjs