TBXMLCaloCellWriterTool Class Reference

#include <TBXMLCaloCellWriterTool.h>

Inheritance diagram for TBXMLCaloCellWriterTool:

Collaboration diagram for TBXMLCaloCellWriterTool:

Public Member Functions
	TBXMLCaloCellWriterTool (const std::string &type, const std::string &name, const IInterface *parent)
	tool constructor
	~TBXMLCaloCellWriterTool ()
virtual StatusCode	initialize () override
virtual StatusCode	writeOut (std::ostream &outStream, std::string_view entryTag=" ")
virtual StatusCode	finalize () override
virtual StatusCode	finalize (std::ostream &outStream)
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	sysInitialize () override
	Perform system initialization for an algorithm.
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
virtual StatusCode	writeRunFiles (const std::string &fileDir, unsigned int runNumber) override
virtual StatusCode	writeEvent (std::ostream &outFile, std::string_view) override
virtual StatusCode	convertProperties ()
virtual void	openDictionary (std::ostream &outStream, const std::string &dictName, const std::vector< std::string > &listOfElements)
virtual void	openDictionary (std::ostream &outStream, const std::string &dictName)
virtual void	closeDictionary (std::ostream &outStream)
virtual void	addDictElement (std::ostream &outStream, const std::string &theElement, const std::vector< std::string > &listOfElements)
virtual void	addAttributes (std::ostream &outStream, const std::string &theElement, const std::vector< std::string > &listOfAttributes)
virtual void	openElement (std::ostream &outStream, std::string_view theElement, const std::vector< std::string > &listOfAttr, const std::vector< std::string > &listOfValues)
virtual void	closeElement (std::ostream &outStream, const std::string &theElement)
virtual void	closeElement (std::ostream &outStream)
virtual void	closeAllElements (std::ostream &outStream)
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.

Protected Attributes
std::vector< std::string >	m_elementList
std::string	m_dictionary

Static Protected Attributes
static const std::string	m_doubleQuote = "\042"

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
std::vector< std::string >	m_includedCalos
std::vector< std::string >	m_includedSamplings
double	m_etaMin
double	m_etaMax
double	m_phiMin
double	m_phiMax
bool	m_firstEvent
std::vector< CaloCell_ID::SUBCALO >	m_caloIndices
std::vector< CaloSampling::CaloSample >	m_caloSamplings
std::string	m_cellContainer
const CaloCell_ID *	m_idHelper {}
const TBXMLWriter *	m_mother {}
std::unordered_set< EventIDBase::number_type >	m_runNumbers
SG::ReadCondHandleKey< CaloDetDescrManager >	m_caloMgrKey
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

Static Private Attributes
static const unsigned int	m_nCols = 2

Detailed Description

Definition at line 27 of file TBXMLCaloCellWriterTool.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

TBXMLCaloCellWriterTool()

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

tool constructor

Definition at line 42 of file TBXMLCaloCellWriterTool.cxx.

  : TBXMLWriterToolBase(type,name,parent)
    , m_etaMin(-5.0)
    , m_etaMax(5.0)
    , m_phiMin(0.*deg)
    , m_phiMax(360.*deg)
    , m_firstEvent(true)
    , m_idHelper(0)
{
  declareProperty("InputCellContainer", m_cellContainer);
  declareProperty("IncludedCalos",      m_includedCalos);
  declareProperty("IncludedSamplings",  m_includedSamplings);
  declareProperty("EtaMin",             m_etaMin);
  declareProperty("EtaMax",             m_etaMax);
  declareProperty("PhiMin",             m_phiMin);
  declareProperty("PhiMax",             m_phiMax);
  // save pointer to algorithm
  m_mother = dynamic_cast<const TBXMLWriter*>(parent);
}

~TBXMLCaloCellWriterTool()

TBXMLCaloCellWriterTool::~TBXMLCaloCellWriterTool

(

)

Definition at line 64 of file TBXMLCaloCellWriterTool.cxx.

{ }

Member Function Documentation

addAttributes()

void TBXMLWriterToolBase::addAttributes ( std::ostream & outStream, const std::string & theElement, const std::vector< std::string > & listOfAttributes )

protectedvirtualinherited

Definition at line 91 of file TBXMLWriterToolBase.cxx.

{
  outStream << "  <!ATTLIST " << theElement << std::endl;
  for ( unsigned int i=0; i<listOfAttr.size(); i++ )
    {
      outStream << "            " << listOfAttr[i] << std::endl;
    }
  outStream << ">" << std::endl;
}

addDictElement()

void TBXMLWriterToolBase::addDictElement ( std::ostream & outStream, const std::string & theElement, const std::vector< std::string > & listOfElements )

protectedvirtualinherited

Definition at line 57 of file TBXMLWriterToolBase.cxx.

{
  outStream << "<!ELEMENT " << theElement;
  // add document as element
  if ( listOfElements.size() == 0 )
    {
      outStream << ">" << std::endl;
    }
  else
    {
      // store elements
      if ( listOfElements[0] == "ANY"   ||
       listOfElements[0] == "EMPTY" ||
       listOfElements[0] == "ALL" )
    {
      outStream << " " << listOfElements[0] << " >" << std::endl;
    }
      else
    {
      outStream << " (" << listOfElements[0];
      for ( unsigned int i=1; i<listOfElements.size(); i++ )
        {
          outStream << "," << listOfElements[i];
        }
      outStream << ") >" << std::endl;
    }
    }
}

closeAllElements()

void TBXMLWriterToolBase::closeAllElements ( std::ostream & outStream )

protectedvirtualinherited

Definition at line 159 of file TBXMLWriterToolBase.cxx.

{
  for ( int i=m_elementList.size()-1; i>=0; i-- ) 
    {
      outStream << "</" << m_elementList[i] << ">" << std::endl;
    }
  m_elementList.clear();
}

closeDictionary()

void TBXMLWriterToolBase::closeDictionary ( std::ostream & outStream )

protectedvirtualinherited

Definition at line 50 of file TBXMLWriterToolBase.cxx.

{
  outStream << "]>" << std::endl;
}

closeElement() [1/2]

void TBXMLWriterToolBase::closeElement ( std::ostream & outStream )

protectedvirtualinherited

Definition at line 130 of file TBXMLWriterToolBase.cxx.

{
  unsigned int thisSize = m_elementList.size() - 1;
  outStream << "</" << m_elementList[thisSize] << ">" << std::endl;
  m_elementList.resize(thisSize);
}

closeElement() [2/2]

void TBXMLWriterToolBase::closeElement ( std::ostream & outStream, const std::string & theElement )

protectedvirtualinherited

Definition at line 139 of file TBXMLWriterToolBase.cxx.

{
  std::vector<std::string>::iterator inVec = 
    find( m_elementList.begin(), m_elementList.end(), theElement);
  if ( inVec != m_elementList.end() )
    {
      outStream << "</" << (*inVec) << ">" << std::endl;
      m_elementList.erase(inVec);
    }
  else
    {
      outStream << "<!-- XML Structural Problem! \n\n"
        << "     cannot find an element " << theElement << "!\n\n"
        << "-->" << std::endl;
    }
}

convertProperties()

StatusCode TBXMLCaloCellWriterTool::convertProperties ( )

protectedvirtual

Definition at line 417 of file TBXMLCaloCellWriterTool.cxx.

{
  // messaging
  MsgStream log(msgSvc(),name());
 
  // get calo id helper
  ATH_CHECK( detStore()->retrieve (m_idHelper, "CaloCell_ID") );

  // Get Calo Indices //
 
  std::vector<std::string>::iterator firstCalo = m_includedCalos.begin();
  std::vector<std::string>::iterator lastCalo  = m_includedCalos.end();
  while ( firstCalo != lastCalo )
    {
      if ( *firstCalo == "LAREM" )
    {
      m_caloIndices.push_back(CaloCell_ID::LAREM);
      ++firstCalo;
    }
      else if ( *firstCalo == "LARHEC" )
    {
      m_caloIndices.push_back(CaloCell_ID::LARHEC);
      ++firstCalo;
    }
      else if ( *firstCalo == "LARFCAL" )
    {
      m_caloIndices.push_back(CaloCell_ID::LARFCAL);
      ++firstCalo;
    }
      else if ( *firstCalo == "TILE" )
    {
      m_caloIndices.push_back(CaloCell_ID::TILE);
      ++firstCalo;
    }
      else
    {
      firstCalo = m_includedCalos.erase(firstCalo);
    }
    }

  // Get CaloSamplings //
 
  // nasty (no switch on string types...)
  for (const std::string& sample : m_includedSamplings)
    {
      // H8 calos
      if ( sample == "PreSamplerB" ) 
    m_caloSamplings.push_back(CaloSampling::PreSamplerB);
      if ( sample == "EMB0" )
    m_caloSamplings.push_back(CaloSampling::EMB1);
      if ( sample == "EMB1" )
    m_caloSamplings.push_back(CaloSampling::EMB2);
      if ( sample == "EMB2" )
    m_caloSamplings.push_back(CaloSampling::EMB3);
      if ( sample == "TileBar0" )
    m_caloSamplings.push_back(CaloSampling::TileBar0);
      if ( sample == "TileBar1" )
    m_caloSamplings.push_back(CaloSampling::TileBar0);
      if ( sample == "TileBar2" )
    m_caloSamplings.push_back(CaloSampling::TileBar0);
      if ( sample == "TileExt0" )
    m_caloSamplings.push_back(CaloSampling::TileExt0);
      if ( sample == "TileExt1" )
    m_caloSamplings.push_back(CaloSampling::TileExt1);
      if ( sample == "TileExt2" )
    m_caloSamplings.push_back(CaloSampling::TileExt2);
 
      // H6 calos
      if ( sample == "EME1" )
    m_caloSamplings.push_back(CaloSampling::EME1);
      if ( sample == "EME2" )
    m_caloSamplings.push_back(CaloSampling::EME2);
      if ( sample == "HEC0" )
    m_caloSamplings.push_back(CaloSampling::HEC0);
      if ( sample == "HEC1" )
    m_caloSamplings.push_back(CaloSampling::HEC1);
      if ( sample == "HEC2" )
    m_caloSamplings.push_back(CaloSampling::HEC2);
      if ( sample == "HEC3" )
    m_caloSamplings.push_back(CaloSampling::HEC3);
      if ( sample == "FCAL0" )
    m_caloSamplings.push_back(CaloSampling::FCAL0);
      if ( sample == "FCAL1" )
    m_caloSamplings.push_back(CaloSampling::FCAL1);
      if ( sample == "FCAL2" )
    m_caloSamplings.push_back(CaloSampling::FCAL2);
    }
 
  return m_caloSamplings.size() == 0 && m_caloIndices.size() == 0
    ? StatusCode::FAILURE
    : StatusCode::SUCCESS;
}      

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::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< AlgTool > >::detStore ( ) const

inlineinherited

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

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

evtStore()

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.

{ 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

finalize() [1/2]

virtual StatusCode TBXMLWriterToolBase::finalize ( )

inlineoverridevirtualinherited

Definition at line 52 of file TBXMLWriterToolBase.h.

    { 
      return StatusCode::SUCCESS;
    }

finalize() [2/2]

virtual StatusCode TBXMLWriterToolBase::finalize ( std::ostream & outStream )

inlinevirtualinherited

Definition at line 57 of file TBXMLWriterToolBase.h.

   {
     this->closeAllElements(outStream);
     return this->finalize();
   }

initialize()

StatusCode TBXMLCaloCellWriterTool::initialize ( )

overridevirtual

Reimplemented from TBXMLWriterToolBase.

Definition at line 67 of file TBXMLCaloCellWriterTool.cxx.

{
  ATH_CHECK(TBXMLWriterToolBase::initialize());
  ATH_CHECK(m_caloMgrKey.initialize());
  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.

msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

openDictionary() [1/2]

void TBXMLWriterToolBase::openDictionary ( std::ostream & outStream, const std::string & dictName )

protectedvirtualinherited

Definition at line 41 of file TBXMLWriterToolBase.cxx.

{
  std::vector<std::string> emptyList;
  this->openDictionary(outStream,dictName, emptyList);
}

openDictionary() [2/2]

void TBXMLWriterToolBase::openDictionary ( std::ostream & outStream, const std::string & dictName, const std::vector< std::string > & listOfElements )

protectedvirtualinherited

Definition at line 18 of file TBXMLWriterToolBase.cxx.

{
  // clean up
  m_elementList.clear();
  m_dictionary = dictName;
 
  // write header
  outStream << "<?XML version=" << m_doubleQuote
        << "1" << m_doubleQuote << "?>" << std::endl;
  
  // write begin of dictionary
  outStream << "<!DOCTYPE " << dictName
        << " [" << std::endl;
 
  // add doctype as element
  this->addDictElement(outStream,dictName,listOfElements);
}      

openElement()

void TBXMLWriterToolBase::openElement ( std::ostream & outStream, std::string_view theElement, const std::vector< std::string > & listOfAttr, const std::vector< std::string > & listOfValues )

protectedvirtualinherited

Definition at line 106 of file TBXMLWriterToolBase.cxx.

{
  m_elementList.emplace_back(theElement);
  outStream << "<" << theElement;
  if ( listOfAttr.size() > 0 && listOfValues.size() == listOfAttr.size() )
    {
      for ( unsigned int i=0; i<listOfAttr.size(); i++ )
    {
      outStream << " " << listOfAttr[i] << "="
            << m_doubleQuote 
            << listOfValues[i]
            << m_doubleQuote;
    }
    }
  outStream << ">" << std::endl;
}

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.

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 asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, and AthCheckedComponent<::AthAlgTool >.

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);
      }
    }
  }

writeEvent()

StatusCode TBXMLCaloCellWriterTool::writeEvent ( std::ostream & outFile, std::string_view  )

overrideprotectedvirtual

Implements TBXMLWriterToolBase.

Definition at line 79 of file TBXMLCaloCellWriterTool.cxx.

{
  // messaging
  MsgStream log(msgSvc(),name());

  // On the Fly Initialization //
 
  if ( m_firstEvent ) 
    {
      // check pointer
      if ( m_mother == 0 )
    {
      log << MSG::ERROR
          << "tool does not hang off the TBXMLWriter algorithm."
          << endmsg;
      return StatusCode::FAILURE;
    }
 
      // convert poperties
      StatusCode checkOut = this->convertProperties();
      if ( checkOut.isFailure() )
    {
      log << MSG::ERROR
          << "cannot convert properties correctly!"
          << endmsg;
      return StatusCode::FAILURE;
    }
      m_firstEvent = false;
 
      // print out configuration
      log << MSG::INFO
      << "list of included calo samplings:"
      << endmsg;
      for ( unsigned int i=0; i<m_caloSamplings.size(); i++ )
    {
      log << MSG::INFO
          << "Sampling \042"
          << m_includedSamplings[i]
          << "\042 with SubCalo index "
          << (int)m_caloSamplings[i]
          << endmsg;
    }
    }

  // Check On Begin Run //
 
  const EventContext& ctx = Gaudi::Hive::currentContext();
  EventIDBase::number_type run_number = ctx.eventID().run_number();
  if (m_runNumbers.insert (run_number).second) {
      StatusCode checkOut =  this->writeRunFiles(m_mother->getFileDir(),
                         run_number);
      if ( checkOut.isFailure() )
    {
      log << MSG::ERROR
          << "cannot produce run XML files."
          << endmsg;
      return StatusCode::FAILURE;
    }
    }
 

  // Retrieve Data from StoreGate //
 
  const CaloCellContainer* theContainer = 0;
  ATH_CHECK( evtStore()->retrieve(theContainer,m_cellContainer) );

  // Loop Individual Calorimeters //
 
  for ( unsigned int i=0; i<m_caloIndices.size(); i++ )
    {
      // write container tag
      outStream << "<!-- TBXMLCaloCellWriterTool: begin write cell container "
        << m_includedCalos[i] << " -->" << '\n';
 
      std::vector<std::string> theCellAttrNames;
      theCellAttrNames.push_back("name");
      theCellAttrNames.push_back("ncols");
      theCellAttrNames.push_back("nrows");
      theCellAttrNames.push_back("idtype");
      theCellAttrNames.push_back("etype");
      std::vector<std::string> theCellAttrValues;
      theCellAttrValues.push_back(m_includedCalos[i]);
 
      // get data size
      unsigned int dataSize = theContainer->nCellsCalo(m_caloIndices[i]);
      unsigned int nRows = 
    (unsigned int)ceil( (double)dataSize / (double)m_nCols );
      theCellAttrValues.push_back(std::to_string(m_nCols));
      theCellAttrValues.push_back(std::to_string(nRows));
      theCellAttrValues.push_back("uint");
      theCellAttrValues.push_back("double");
      this->openElement(outStream,"CaloCellContainer",
            theCellAttrNames,theCellAttrValues);
 
      // loop on cells
      CaloCellContainer::const_iterator firstCell = 
    theContainer->beginConstCalo(m_caloIndices[i]);
      CaloCellContainer::const_iterator lastCell =
    theContainer->endConstCalo(m_caloIndices[i]);
 
      // baseline index
      IdentifierHash baseIndex, lastIndex;
      m_idHelper->calo_cell_hash_range((int)m_caloIndices[i],
                       baseIndex, lastIndex);
 
      unsigned int theCtr = 0;
      bool isTerminated = false;
      for ( ; firstCell != lastCell; ++firstCell )
    {  
      // check if cell in requested layer and range
      double eta = (*firstCell)->eta();
      double phi = (*firstCell)->phi();
          const CaloDetDescrElement * theCaloDDE= (*firstCell)->caloDDE();
      CaloSampling::CaloSample theLayer;
          if (theCaloDDE) {
              theLayer = (CaloSampling::CaloSample) theCaloDDE->getSampling();
          }else{
              theLayer =  CaloSampling::Unknown;
          } 
      if ( ( std::find(m_caloSamplings.begin(),
               m_caloSamplings.end(),
               theLayer) != m_caloSamplings.end() ) &&
           ( ( eta > m_etaMin && eta < m_etaMax ) &&
         ( phi > m_phiMin && phi < m_phiMax ) )
           )
        {         
          // get calorimeter hash index
          IdentifierHash theIndex = 
        (*firstCell)->caloDDE()->calo_hash();
          // get eta, phi, region
          int etaIndex = m_idHelper->eta((*firstCell)->ID());
          int phiIndex = m_idHelper->phi((*firstCell)->ID());
          int regIndex = m_idHelper->region((*firstCell)->ID());
          // int subIndex = m_idHelper->sub_calo((*firstCell)->ID());
          int lyrIndex = m_idHelper->sampling((*firstCell)->ID());
          int subIndex = -1;
          // get subIndex
          if ( m_idHelper->is_em_barrel((*firstCell)->ID()) )
        {
          subIndex = 0;
        }
          else if ( m_idHelper->is_em_endcap((*firstCell)->ID()) )
        {
          subIndex = 1;
        }
          else if ( m_idHelper->is_tile_barrel((*firstCell)->ID()) )
        {
          subIndex = 2;
        }
          else if ( m_idHelper->is_tile_extbarrel((*firstCell)->ID()) )
        {
          subIndex = 3;
        }
          else if ( m_idHelper->is_hec((*firstCell)->ID()) )
        {
          subIndex = 4;
        }
          else if ( m_idHelper->is_fcal((*firstCell)->ID()) )
        {
          subIndex = 5;
        }
          // get signal
          double theEnergy     = (*firstCell)->e();
          if ( theCtr == 0 || ( theCtr % m_nCols ) == 0 )
        {
          outStream << "     ";
        }
          theIndex -= (int)baseIndex;
          //coverity[RW.CONSTEVAL_CALL_NONCONSTANT:FALSE]
        outStream << std::format("{:>10} {:>3} {:>3} {:>3} {:>3} {:>3} {:>10.5g}",
                                     theIndex.value(),
                                     subIndex,
                                     lyrIndex,
                                     regIndex,
                                     etaIndex,
                                     phiIndex,
                                     theEnergy);
          theCtr++;
          if ( (isTerminated = ( theCtr % m_nCols )) == 0 )
        {
          outStream << '\n';
        }
        }
    }
      if ( ! isTerminated ) outStream << '\n';
      this->closeElement(outStream);
      // write container tag
      outStream << "<!-- TBXMLCaloCellWriterTool: end write cell container "
        << m_includedCalos[i] << " -->" << '\n';
    }
  
  return StatusCode::SUCCESS;
}

writeOut()

virtual StatusCode TBXMLWriterToolBase::writeOut ( std::ostream & outStream, std::string_view entryTag = " " )

inlinevirtualinherited

Definition at line 46 of file TBXMLWriterToolBase.h.

    {
      return this->writeEvent(outStream,entryTag);
    }

writeRunFiles()

StatusCode TBXMLCaloCellWriterTool::writeRunFiles ( const std::string & fileDir, unsigned int runNumber )

overrideprotectedvirtual

Implements TBXMLWriterToolBase.

Definition at line 287 of file TBXMLCaloCellWriterTool.cxx.

{

  // Write Dictionary //
 
  std::ofstream thisFileStream(std::format("{}/geom.{:06}.xml", fileDir, runNumber));
 
  // Document type
  std::vector<std::string> theRunElements;
  theRunElements.push_back("FCalGeomTable*");
  this->openDictionary(thisFileStream,"FCalGeomTable",theRunElements);
  std::vector<std::string> theRunAttr;
  theRunAttr.push_back("name     CDATA                           #REQUIRED");
  this->addAttributes(thisFileStream,"FCalGeomTable",theRunAttr);
 
  // FCal geometry table
  std::vector<std::string> anyData;
  anyData.push_back("ANY");
  this->addDictElement(thisFileStream,"FCalGeomTable",anyData);
  std::vector<std::string> theGeomAttr;
  theGeomAttr.push_back("name    CDATA                           #REQUIRED");
  this->addAttributes(thisFileStream,"FCalGeomTable",theGeomAttr);
 
  // close dictionary
  this->closeDictionary(thisFileStream);

  // Write Run Geometry //
 
  SG::ReadCondHandle<CaloDetDescrManager> caloMgrHandle{m_caloMgrKey};  
  const CaloDetDescrManager* caloDetMgr = *caloMgrHandle;
  ATH_CHECK( detStore()->retrieve (caloDetMgr, "CaloMgr") );
 
  IdentifierHash firstIndex, lastIndex, safeIndex;
  m_idHelper->calo_cell_hash_range((int)CaloCell_ID::LARFCAL,
                   firstIndex, lastIndex);
  safeIndex = firstIndex;
 
  // open element 
  std::vector<std::string> theRunValues(theRunAttr.size());
  for ( unsigned int i=0; i<theRunAttr.size(); i++ )
    {
      if ( (theRunAttr[i]).find("name") != std::string::npos )
    {
      theRunValues[i] = "FCalMod0";
      theRunAttr[i] = 
        theRunAttr[i].substr(0,theRunAttr[i].find_first_of(' '));
    }
    }
  this->openElement(thisFileStream,"FCalGeomTable",theRunAttr,theRunValues);
  theRunValues[0] = "FCalCells";
  this->openElement(thisFileStream,"FCalGeomTable",theRunAttr,theRunValues);
  thisFileStream << "<!-- 32-bit Id"
         << "   Module#  "
         << "   EtaIndex "
         << "   PhiIndex "
         << "   X [cm]   "
         << "   Y [cm]   "
         << "   Z [cm]   "
         << "  TileSize  "
         << "-->\n";
 
  // find big/small tile indicator -> to be replaced
  std::unordered_map<int, double> smallestDx;
  smallestDx.reserve(8);                    // usually only 3-4 sub-calos
  
  for (unsigned int iCtr = safeIndex; iCtr <= lastIndex; ++iCtr)
  {
      const Identifier theId = m_idHelper->cell_id(IdentifierHash(iCtr));
      const int theCalo = m_idHelper->sub_calo(theId);
  
      const CaloDetDescrElement* theElement = caloDetMgr->get_element(IdentifierHash(iCtr));
      const double dx = theElement->dx();
  
      // One-lookup minimum update (very fast)
      auto [it, inserted] = smallestDx.try_emplace(theCalo, dx);
      if (!inserted && dx < it->second)
          it->second = dx;
  }
 
  // get geometry
  for (unsigned int iCtr=(unsigned int)firstIndex; 
       iCtr<=(unsigned int)lastIndex; iCtr++ )
    {
      IdentifierHash theIndex(iCtr);
      // get identifiers
      Identifier theId = m_idHelper->cell_id(theIndex);
      int theModule    = m_idHelper->sampling(theId);
      int theEta       = m_idHelper->eta(theId);
      int thePhi       = m_idHelper->phi(theId);
      int theCalo      = m_idHelper->sub_calo(theId);
      // get geometry
      const CaloDetDescrElement* theElement = 
    caloDetMgr->get_element(theIndex);
      double theX      = theElement->x();
      double theY      = theElement->y();
      double theZ      = theElement->z();
      // check tile size
      double dx        = theElement->dx();
      int tileSize     = dx > 1.1*smallestDx[theCalo] ? 1 : 0;
 
      // write out
      thisFileStream << "    "
             << std::setw(10) 
             << std::setfill(' ') << iCtr-(unsigned int)firstIndex
             << "     "
             << std::setw(2)  << std::setfill(' ') << theModule 
             << "          "
             << std::setw(2)  << std::setfill(' ') << theEta    
             << "          "
             << std::setw(2)  << std::setfill(' ') << thePhi    
             << "   "
             << std::setw(10) << std::setprecision(5) << theX << "  "
             << std::setw(10) << std::setprecision(5) << theY << "  "
             << std::setw(10) << std::setprecision(5) << theZ << "  "
             << "       "
             << std::setw(2)  << std::setfill(' ')    << tileSize 
             << '\n';
    }
  ATH_CHECK(this->finalize(thisFileStream));
  thisFileStream.close();
 
  return StatusCode::SUCCESS;
}

Member Data Documentation

m_caloIndices

std::vector<CaloCell_ID::SUBCALO> TBXMLCaloCellWriterTool::m_caloIndices

private

Definition at line 69 of file TBXMLCaloCellWriterTool.h.

m_caloMgrKey

SG::ReadCondHandleKey<CaloDetDescrManager> TBXMLCaloCellWriterTool::m_caloMgrKey

private

Initial value:

{ this
      , "CaloDetDescrManager"
      , "CaloDetDescrManager"
      , "SG Key for CaloDetDescrManager in the Condition Store" }

Definition at line 79 of file TBXMLCaloCellWriterTool.h.

                                                        { this
      , "CaloDetDescrManager"
      , "CaloDetDescrManager"
      , "SG Key for CaloDetDescrManager in the Condition Store" };

m_caloSamplings

std::vector<CaloSampling::CaloSample> TBXMLCaloCellWriterTool::m_caloSamplings

private

Definition at line 70 of file TBXMLCaloCellWriterTool.h.

m_cellContainer

std::string TBXMLCaloCellWriterTool::m_cellContainer

private

Definition at line 71 of file TBXMLCaloCellWriterTool.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_dictionary

std::string TBXMLWriterToolBase::m_dictionary

protectedinherited

Definition at line 108 of file TBXMLWriterToolBase.h.

m_doubleQuote

const std::string TBXMLWriterToolBase::m_doubleQuote = "\042"

staticprotectedinherited

Definition at line 110 of file TBXMLWriterToolBase.h.

m_elementList

std::vector<std::string> TBXMLWriterToolBase::m_elementList

protectedinherited

Definition at line 107 of file TBXMLWriterToolBase.h.

m_etaMax

double TBXMLCaloCellWriterTool::m_etaMax

private

Definition at line 65 of file TBXMLCaloCellWriterTool.h.

m_etaMin

double TBXMLCaloCellWriterTool::m_etaMin

private

Definition at line 65 of file TBXMLCaloCellWriterTool.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_firstEvent

bool TBXMLCaloCellWriterTool::m_firstEvent

private

Definition at line 67 of file TBXMLCaloCellWriterTool.h.

m_idHelper

const CaloCell_ID* TBXMLCaloCellWriterTool::m_idHelper {}

private

Definition at line 73 of file TBXMLCaloCellWriterTool.h.

{};

m_includedCalos

std::vector<std::string> TBXMLCaloCellWriterTool::m_includedCalos

private

Definition at line 62 of file TBXMLCaloCellWriterTool.h.

m_includedSamplings

std::vector<std::string> TBXMLCaloCellWriterTool::m_includedSamplings

private

Definition at line 63 of file TBXMLCaloCellWriterTool.h.

m_mother

const TBXMLWriter* TBXMLCaloCellWriterTool::m_mother {}

private

Definition at line 75 of file TBXMLCaloCellWriterTool.h.

{};

m_nCols

const unsigned int TBXMLCaloCellWriterTool::m_nCols = 2

staticprivate

Definition at line 60 of file TBXMLCaloCellWriterTool.h.

m_phiMax

double TBXMLCaloCellWriterTool::m_phiMax

private

Definition at line 65 of file TBXMLCaloCellWriterTool.h.

m_phiMin

double TBXMLCaloCellWriterTool::m_phiMin

private

Definition at line 65 of file TBXMLCaloCellWriterTool.h.

m_runNumbers

std::unordered_set<EventIDBase::number_type> TBXMLCaloCellWriterTool::m_runNumbers

private

Definition at line 77 of file TBXMLCaloCellWriterTool.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.

---

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

• TBXMLCaloCellWriterTool.h
• TBXMLCaloCellWriterTool.cxx