GlobalSim::LArCellPreparationAlg Class Reference

#include <LArCellPreparationAlg.h>

Inheritance diagram for GlobalSim::LArCellPreparationAlg:

Collaboration diagram for GlobalSim::LArCellPreparationAlg:

Public Member Functions
virtual StatusCode	initialize () override
	initialize function running before first event More...
virtual StatusCode	execute (const EventContext &) const override
	execute function running for every event More...
virtual StatusCode	sysInitialize () override
	Override sysInitialize. More...
virtual bool	isClonable () const override
	Specify if the algorithm is clonable. More...
virtual unsigned int	cardinality () const override
	Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant. More...
virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm. More...
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies. More...
virtual bool	filterPassed (const EventContext &ctx) const
virtual void	setFilterPassed (bool state, const EventContext &ctx) const
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	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, V, H > &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

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< float, boost::dynamic_bitset<> >	encodeEnergy (float energy) const
	Function to simulate the cell energy as seen by Global. More...
StatusCode	removeCellsFromOverloadedFEB (std::vector< GlobalSim::GlobalLArCell > &cells) const
	Function to simulate the truncation of overflowing FEB2s. More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
int	m_readoutRanges [5] = {-1,-1,-1,-1,-1}
	array holding the energy edges of the multilinear encoding More...
int	m_stepsPerRange = -1
	number of discrete values per multilinear energy encoding range More...
unsigned	m_maxCellsPerFEB = -1
	maximum number of cells that can be send to Global for each FEB2 More...
std::map< int, GlobalSim::GlobalLArCell >	m_gblLArCellMap = {}
	LAr cell map where the key is the offline cell ID. More...
std::unique_ptr< GlobalSim::GlobalLArCellContainer >	m_gblLArCellContainerTemplate
	GlobalLArCellContainer template which is constructed in initialize and used in execute. More...
SG::ReadHandleKey< xAOD::EventInfo >	m_eventInfo {this, "EventInfo", "EventInfo", "Key for the EventInfo container"}
	Key for the EventInfo object. More...
Gaudi::Property< int >	m_numberOfEnergyBits {this, "numberOfEnergyBits", 6, "Number of bits reserved for the multilinear energy encoding"}
	Parameters defining the multilinear energy encoding scheme. More...
Gaudi::Property< int >	m_valueLSB {this, "valueLeastSignificantBit", 40, "Value of the least significant bit in MeV"}
Gaudi::Property< int >	m_valueGainFactor {this, "valueGainFactor", 4, "Value of the gain factor of the multilinear energey encoding"}
Gaudi::Property< std::string >	m_LArCellMap
	Path to the LAr cell map in the CVMFS GroupData space. More...
SG::ReadHandleKey< CaloCellContainer >	m_caloCellsKey {this, "caloCells", "AllCalo", "key to read in a CaloCell container"}
	Key to the CaloCell container. More...
SG::ReadCondHandleKey< CaloNoise >	m_totalNoiseKey {this, "totalNoiseKey", "totalNoise", "SG Key of CaloNoise data object"}
	Key to the total noise used for each CaloCell. More...
SG::WriteHandleKey< GlobalSim::GlobalLArCellContainer >	m_LArCellContainerKey {this, "GlobalLArCellsKey", "GlobalLArCells", "Key for the output container of the LAr cells sent to Global"}
	Key to writing the GlobalLArCellContainer to StoreGate. More...
DataObjIDColl	m_extendedExtraObjects
	Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks. More...
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

Detailed Description

Definition at line 29 of file LArCellPreparationAlg.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Function Documentation

cardinality()

unsigned int AthCommonReentrantAlgorithm< Gaudi::Algorithm >::cardinality

overridevirtualinherited

Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.

Override this to return 0 for reentrant algorithms.

Override this to return 0 for reentrant algorithms.

Definition at line 75 of file AthCommonReentrantAlgorithm.cxx.

{
  return 0;
}

declareGaudiProperty() [1/4]

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

declareGaudiProperty() [3/4]

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

{ return m_detStore; }

encodeEnergy()

std::pair< float, boost::dynamic_bitset<> > GlobalSim::LArCellPreparationAlg::encodeEnergy ( float  energy ) const

private

Function to simulate the cell energy as seen by Global.

Definition at line 218 of file LArCellPreparationAlg.cxx.

                                                                                             {
 
    // Negative energy cell
    if (energy < 0) return std::pair<float,boost::dynamic_bitset<>>(0.0,boost::dynamic_bitset<>(m_numberOfEnergyBits.value(),0));
  
    // Saturated cell
    if (energy > m_readoutRanges[4]) {
          int max_value = m_stepsPerRange+(m_stepsPerRange*m_valueGainFactor.value())+(m_stepsPerRange*m_valueGainFactor.value()*m_valueGainFactor.value()) +
                         ((m_stepsPerRange-1)*m_valueGainFactor.value()*m_valueGainFactor.value()*m_valueGainFactor.value())*m_valueLSB.value();
          return std::pair<float,boost::dynamic_bitset<>>(max_value,boost::dynamic_bitset<>(m_numberOfEnergyBits.value(),std::pow(2,m_numberOfEnergyBits.value())-1));
    }
  
    int range = 0;
    for (int i = 1; i <= 3; ++i) {
          if (energy > m_readoutRanges[i]) range = i;
    }
  
    float step = ((float) m_readoutRanges[range+1] - (float) m_readoutRanges[range]) / m_stepsPerRange;
  
    float encoded_energy = -1;
    int used_steps = 0;
    for (int i = 0; i < m_stepsPerRange; ++i) {
          encoded_energy = m_readoutRanges[range]+(step*i);
          used_steps = i;
          if (energy < (m_readoutRanges[range]+(step*(i+1)))) break;
    }
  
    std::size_t n_bitsE = m_numberOfEnergyBits.value() - 2;
    boost::dynamic_bitset<> energy_bits(m_numberOfEnergyBits.value(), used_steps);
    energy_bits |= boost::dynamic_bitset<>(m_numberOfEnergyBits.value(), static_cast<unsigned long>(range) << n_bitsE);
 
    return std::pair<float,boost::dynamic_bitset<>>(encoded_energy,energy_bits);
  }

evtStore() [1/2]

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.

{ return m_evtStore; }

evtStore() [2/2]

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

inlineinherited

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

Definition at line 90 of file AthCommonDataStore.h.

{ return m_evtStore; }

execute()

StatusCode GlobalSim::LArCellPreparationAlg::execute ( const EventContext &  ctx ) const

overridevirtual

execute function running for every event

Definition at line 130 of file LArCellPreparationAlg.cxx.

                                                                         {
 
    ATH_MSG_DEBUG ("Executing LArCellPreparationAlg algorithm");
    
    SG::ReadHandle<xAOD::EventInfo> eventInfo(m_eventInfo, ctx);
    CHECK(eventInfo.isValid());
 
    // Read in container containing calorimeter cells
    auto h_caloCells = SG::makeHandle(m_caloCellsKey, ctx);
    CHECK(h_caloCells.isValid());
    const auto & cells = *h_caloCells;
 
    ATH_MSG_DEBUG("Reading " << std::to_string(h_caloCells->size()) << " cells in input cell container");
 
    SG::ReadCondHandle<CaloNoise> totalNoiseHdl{m_totalNoiseKey, ctx};
    if (!totalNoiseHdl.isValid()) {return StatusCode::FAILURE;}
    const CaloNoise* totalNoiseCDO = *totalNoiseHdl;
 
    std::map<std::string,std::vector<GlobalSim::GlobalLArCell>> gblLArCellsPerFEB2;
 
    for(const auto *cell: cells){
 
        int cell_id = (cell->ID().get_identifier32()).get_compact();
 
        auto gblLArCell_itr = m_gblLArCellMap.find(cell_id);
        if (gblLArCell_itr == m_gblLArCellMap.end()) continue;
 
        GlobalSim::GlobalLArCell gblLArCell = gblLArCell_itr->second;
 
        float totalNoise = totalNoiseCDO->getNoise(cell->ID(), cell->gain());
        float sigma = cell->energy() / totalNoise;
 
        // Only send positive-energy 2sigma cells to the GEP
        if (sigma < 2.0) continue;
 
        if (cell->badcell()) continue;
 
        std::pair<float, boost::dynamic_bitset<>> gep_energy = encodeEnergy(cell->energy() / TMath::CosH(cell->eta()));
 
        gblLArCell.setEnergy(gep_energy.first, std::move(gep_energy.second));
        gblLArCell.setSigma(sigma);
        gblLArCell.setPosition(cell->eta(), cell->phi());
 
        // Fill cells into map according to FEB  
        auto feb2_itr = gblLArCellsPerFEB2.find(gblLArCell.getFEB2());
        if (feb2_itr != gblLArCellsPerFEB2.end()) feb2_itr->second.push_back(gblLArCell);
        else {
            std::vector<GlobalSim::GlobalLArCell> cellsThisFEB;
            cellsThisFEB.push_back(gblLArCell);
            gblLArCellsPerFEB2.insert(std::pair<std::string,std::vector<GlobalSim::GlobalLArCell>>(gblLArCell.getFEB2(),cellsThisFEB));
        }
    }
 
    // Set up a GlobalLArCellContainer from template
    const GlobalSim::GlobalLArCellContainer& templateRef = *m_gblLArCellContainerTemplate;
    auto gblLArCellContainer = std::make_unique<GlobalSim::GlobalLArCellContainer>(templateRef);
 
    // do truncation
    for (auto& [feb2Name, cells] : gblLArCellsPerFEB2) {
 
        // Overflow and error flags
        bool inOverflow = false;
        bool inError = false;
 
        // LAr FEBs might overflow, so they will get truncated
        if (cells.size() > m_maxCellsPerFEB) {
            ATH_MSG_INFO("FEB " << feb2Name << " is sending " << cells.size() << " cells, which is more cells than GEP can receive. Removing all but the possible " << m_maxCellsPerFEB << " cells.");
            CHECK(removeCellsFromOverloadedFEB(cells));
            inOverflow = true;
        }
 
        for (auto& gblLArCell : cells)
            gblLArCellContainer->push_back(std::move(gblLArCell));
 
        gblLArCellContainer->setFeb2Flags(feb2Name, inOverflow, inError);
    }
    ATH_MSG_DEBUG("Global is receiving a total of " << gblLArCellContainer->size() << " LAr cells in this event");
 
    SG::WriteHandle<GlobalSim::GlobalLArCellContainer> h_gblLArCellContainer = SG::makeHandle(m_LArCellContainerKey, ctx);
    ATH_CHECK( h_gblLArCellContainer.record( std::move(gblLArCellContainer) ) );
 
    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 & AthCommonReentrantAlgorithm< Gaudi::Algorithm >::extraOutputDeps

overridevirtualinherited

Return the list of extra output dependencies.

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

Definition at line 94 of file AthCommonReentrantAlgorithm.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 BaseAlg::extraOutputDeps();
}

filterPassed()

virtual bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::filterPassed ( const EventContext &  ctx ) const

inlinevirtualinherited

Definition at line 96 of file AthCommonReentrantAlgorithm.h.

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

initialize()

StatusCode GlobalSim::LArCellPreparationAlg::initialize ( )

overridevirtual

initialize function running before first event

Definition at line 27 of file LArCellPreparationAlg.cxx.

                                               {
    ATH_MSG_INFO ("Initializing " << name());
    ATH_MSG_INFO ("Target name of GlobalLArCellContainer is " << m_LArCellContainerKey);
 
    CHECK(m_eventInfo.initialize());
    CHECK(m_caloCellsKey.initialize());
    CHECK(m_LArCellContainerKey.initialize());
 
    ATH_CHECK(m_totalNoiseKey.initialize());
 
    ATH_MSG_INFO("Active energy encoding scheme for LAr cells is " << m_numberOfEnergyBits.value() << " energy bits with " << m_valueLSB.value() << " MeV for the least significant bit and a gain factor of " << m_valueGainFactor.value());
 
    m_stepsPerRange = std::pow(2,m_numberOfEnergyBits.value()-2);
 
    m_readoutRanges[0] = 0;
    m_readoutRanges[1] = m_stepsPerRange*m_valueLSB.value();
    m_readoutRanges[2] = ((m_valueGainFactor.value()*m_stepsPerRange)+m_stepsPerRange)*m_valueLSB.value();
    m_readoutRanges[3] = (m_stepsPerRange+(m_stepsPerRange*m_valueGainFactor.value())+(m_stepsPerRange*m_valueGainFactor.value()*m_valueGainFactor.value()))*m_valueLSB.value();
    m_readoutRanges[4] = (m_stepsPerRange+(m_stepsPerRange*m_valueGainFactor.value())+(m_stepsPerRange*m_valueGainFactor.value()*m_valueGainFactor.value()) +
                         (m_stepsPerRange*m_valueGainFactor.value()*m_valueGainFactor.value()*m_valueGainFactor.value()))*m_valueLSB.value();
 
    ATH_MSG_DEBUG("Readout scheme with " << m_numberOfEnergyBits.value() << "-bits provides the following four energy thresholds (with " << m_stepsPerRange << " discrete steps on each threshold)");
    ATH_MSG_DEBUG("GEP cell energy range 0: min = " << m_readoutRanges[0] << " MeV -> max = " << m_readoutRanges[1] << " MeV");
    ATH_MSG_DEBUG("GEP cell energy range 1: min = " << m_readoutRanges[1] + m_valueLSB.value() << " MeV -> max = " << m_readoutRanges[2] << " MeV");
    ATH_MSG_DEBUG("GEP cell energy range 2: min = " << m_readoutRanges[2]+(m_valueGainFactor.value()*m_valueLSB.value()) << " MeV -> max = " << m_readoutRanges[3] << " MeV");
    ATH_MSG_DEBUG("GEP cell energy range 3: min = " << m_readoutRanges[3]+(m_valueGainFactor.value()*m_valueGainFactor.value()*m_valueLSB.value()) << " MeV -> max = " << m_readoutRanges[4] << " MeV");
 
    // At the moment only have a detailed scheme for 6-10 bit readouts, thus rejecting any other value
    switch(m_numberOfEnergyBits.value()) {
        case 6: m_maxCellsPerFEB = 62; break;
        case 7: m_maxCellsPerFEB = 54; break;
        case 8: m_maxCellsPerFEB = 48; break;
        case 9: m_maxCellsPerFEB = 43; break;
        case 10: m_maxCellsPerFEB = 39; break;
        default: ATH_MSG_FATAL("A LAr cell energy encoding scheme with " << m_numberOfEnergyBits.value() << " energy bits is currently not defined");
        return StatusCode::FAILURE;
    }
 
    ATH_MSG_INFO("Loading cell map associating LAr cells to FEB2s");
 
    std::string cellMapPath = PathResolverFindCalibFile(m_LArCellMap);
    if(cellMapPath.empty()) ATH_MSG_ERROR("Could not find file with cell map data: " << m_LArCellMap.value());
 
    std::ifstream file(cellMapPath.c_str());
 
    unsigned n_cells = 0;
    m_gblLArCellMap.clear();
 
    std::map<std::string,Feb2MuxInfo> feb2MuxAssoc;
 
    // Read input file
    if (file.is_open()) {
 
        int online_id, offline_id, channel, con_num, fbr;
        std::string assocFEB2, con_type, muxname, muxrack, cnnctr, laspname, lasprack;
 
        // Skipping header of file
        std::getline(file, assocFEB2);
 
        // start reading data
        while (true) {
 
            file >> offline_id >> online_id >> assocFEB2 >> channel >> con_type >> con_num >> fbr >> muxname >> muxrack >> cnnctr >> laspname >> lasprack;
 
            if (file.eof()) break;
 
            GlobalSim::GlobalLArCell gblLArCell(offline_id, assocFEB2, channel);
            gblLArCell.setBoardConnector(cnnctr, con_type, con_num, fbr);
            gblLArCell.setMUX(muxname);
            gblLArCell.setLASP(laspname);
 
            m_gblLArCellMap.insert(std::pair<int, GlobalSim::GlobalLArCell>(offline_id, gblLArCell));
 
            int indexOnMux = fbr;
            if (cnnctr == "B") indexOnMux += 24;
            if (cnnctr == "C") indexOnMux += 32;
 
            // Add FEB2 to MUX association map
            auto itr = feb2MuxAssoc.find(assocFEB2);
            if (itr == feb2MuxAssoc.end()) {
                feb2MuxAssoc.insert(std::pair<std::string,Feb2MuxInfo>(assocFEB2, {muxname, indexOnMux}));
            }
 
            ++n_cells;
        }
    }
    else {
            ATH_MSG_ERROR("Could not open file containing the cell to FEB2 association");
            return StatusCode::FAILURE;
    }
 
    ATH_MSG_DEBUG("Loaded FEB2 information for " << n_cells << " LAr cells");
 
    // Constructing the GlobalLArCellContainer
    m_gblLArCellContainerTemplate = std::make_unique<GlobalSim::GlobalLArCellContainer>(feb2MuxAssoc);
    m_gblLArCellContainerTemplate->setMaxCellsPerFeb2(m_maxCellsPerFEB);
  
    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.

isClonable()

bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::isClonable

overridevirtualinherited

Specify if the algorithm is clonable.

Reentrant algorithms are clonable.

Definition at line 68 of file AthCommonReentrantAlgorithm.cxx.

{
  // Reentrant algorithms are clonable.
  return true;
}

msg() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg() [2/2]

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

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                  {
    return this->msgStream(lvl);
  }

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.

removeCellsFromOverloadedFEB()

StatusCode GlobalSim::LArCellPreparationAlg::removeCellsFromOverloadedFEB ( std::vector< GlobalSim::GlobalLArCell > &  cells ) const

private

Function to simulate the truncation of overflowing FEB2s.

Definition at line 255 of file LArCellPreparationAlg.cxx.

                                                                                                               {
 
    // Sort cells by channel
    std::sort(cells.begin(), cells.end(), [](const auto& a, const auto& b) {
        return a.getChannel() < b.getChannel(); });
 
    // Remove overflowing cells from vector
    if (cells.size() > m_maxCellsPerFEB) 
        cells.erase(std::next(cells.begin(), m_maxCellsPerFEB), cells.end());
 
    return StatusCode::SUCCESS;
  }

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()

virtual void AthCommonReentrantAlgorithm< Gaudi::Algorithm >::setFilterPassed ( bool  state, const EventContext &  ctx  ) const

inlinevirtualinherited

Definition at line 100 of file AthCommonReentrantAlgorithm.h.

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

sysExecute()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::sysExecute ( const EventContext &  ctx )

overridevirtualinherited

Execute an algorithm.

We override this in order to work around an issue with the Algorithm base class storing the event context in a member variable that can cause crashes in MT jobs.

Definition at line 85 of file AthCommonReentrantAlgorithm.cxx.

{
  return BaseAlg::sysExecute (ctx);
}

sysInitialize()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::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 InputMakerBase, and HypoBase.

Definition at line 61 of file AthCommonReentrantAlgorithm.cxx.

                                                               {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<BaseAlg>>::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_caloCellsKey

SG::ReadHandleKey<CaloCellContainer> GlobalSim::LArCellPreparationAlg::m_caloCellsKey {this, "caloCells", "AllCalo", "key to read in a CaloCell container"}

private

Key to the CaloCell container.

Definition at line 71 of file LArCellPreparationAlg.h.

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_eventInfo

SG::ReadHandleKey<xAOD::EventInfo> GlobalSim::LArCellPreparationAlg::m_eventInfo {this, "EventInfo", "EventInfo", "Key for the EventInfo container"}

private

Key for the EventInfo object.

Definition at line 59 of file LArCellPreparationAlg.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 AthCommonReentrantAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects

privateinherited

Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.

Empty if no symlinks were found.

Definition at line 114 of file AthCommonReentrantAlgorithm.h.

m_gblLArCellContainerTemplate

std::unique_ptr<GlobalSim::GlobalLArCellContainer> GlobalSim::LArCellPreparationAlg::m_gblLArCellContainerTemplate

private

GlobalLArCellContainer template which is constructed in initialize and used in execute.

Definition at line 56 of file LArCellPreparationAlg.h.

m_gblLArCellMap

std::map<int,GlobalSim::GlobalLArCell> GlobalSim::LArCellPreparationAlg::m_gblLArCellMap = {}

private

LAr cell map where the key is the offline cell ID.

Definition at line 54 of file LArCellPreparationAlg.h.

m_LArCellContainerKey

SG::WriteHandleKey<GlobalSim::GlobalLArCellContainer> GlobalSim::LArCellPreparationAlg::m_LArCellContainerKey {this, "GlobalLArCellsKey", "GlobalLArCells", "Key for the output container of the LAr cells sent to Global"}

private

Key to writing the GlobalLArCellContainer to StoreGate.

Definition at line 77 of file LArCellPreparationAlg.h.

m_LArCellMap

Gaudi::Property<std::string> GlobalSim::LArCellPreparationAlg::m_LArCellMap

private

Initial value:

{this, "LArCellMapFile", "UpgradePerformanceFunctions/LAr_Cell_Map_offlineID_1.csv",
      "File associating LAr cells with readout FEBs and connection technology"}

Path to the LAr cell map in the CVMFS GroupData space.

Definition at line 67 of file LArCellPreparationAlg.h.

m_maxCellsPerFEB

unsigned GlobalSim::LArCellPreparationAlg::m_maxCellsPerFEB = -1

private

maximum number of cells that can be send to Global for each FEB2

Definition at line 51 of file LArCellPreparationAlg.h.

m_numberOfEnergyBits

Gaudi::Property<int> GlobalSim::LArCellPreparationAlg::m_numberOfEnergyBits {this, "numberOfEnergyBits", 6, "Number of bits reserved for the multilinear energy encoding"}

private

Parameters defining the multilinear energy encoding scheme.

Definition at line 62 of file LArCellPreparationAlg.h.

m_readoutRanges

int GlobalSim::LArCellPreparationAlg::m_readoutRanges[5] = {-1,-1,-1,-1,-1}

private

array holding the energy edges of the multilinear encoding

Definition at line 47 of file LArCellPreparationAlg.h.

m_stepsPerRange

int GlobalSim::LArCellPreparationAlg::m_stepsPerRange = -1

private

number of discrete values per multilinear energy encoding range

Definition at line 49 of file LArCellPreparationAlg.h.

m_totalNoiseKey

SG::ReadCondHandleKey<CaloNoise> GlobalSim::LArCellPreparationAlg::m_totalNoiseKey {this, "totalNoiseKey", "totalNoise", "SG Key of CaloNoise data object"}

private

Key to the total noise used for each CaloCell.

Definition at line 74 of file LArCellPreparationAlg.h.

m_valueGainFactor

Gaudi::Property<int> GlobalSim::LArCellPreparationAlg::m_valueGainFactor {this, "valueGainFactor", 4, "Value of the gain factor of the multilinear energey encoding"}

private

Definition at line 64 of file LArCellPreparationAlg.h.

m_valueLSB

Gaudi::Property<int> GlobalSim::LArCellPreparationAlg::m_valueLSB {this, "valueLeastSignificantBit", 40, "Value of the least significant bit in MeV"}

private

Definition at line 63 of file LArCellPreparationAlg.h.

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.

---

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

• LArCellPreparationAlg.h
• LArCellPreparationAlg.cxx