#include <LArNNRawChannelBuilder.h>

Inheritance diagram for LArNNRawChannelBuilder:

Public Member Functions
StatusCode	initialize () override
StatusCode	execute (const EventContext &ctx) const override
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual bool	isClonable () const override
	Specify if the algorithm is clonable.
virtual unsigned int	cardinality () const override
	Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.
virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
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`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

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

Private Attributes
SG::ReadHandleKey< LArDigitContainer >	m_digitKey
SG::WriteHandleKey< LArRawChannelContainer >	m_rawChannelKey
SG::ReadCondHandleKey< ILArPedestal >	m_pedestalKey {this, "PedestalKey", "LArPedestal", "SG Key of Pedestal conditions object"}
SG::ReadCondHandleKey< LArADC2MeV >	m_adc2MeVKey {this, "ADC2MeVKey", "LArADC2MeV", "SG Key of ADC2MeV conditions object"}
SG::ReadCondHandleKey< LArOnOffIdMapping >	m_cablingKey {this, "CablingKey", "LArOnOffIdMap", "SG Key of LArOnOffIdMapping object"}
SG::ReadCondHandleKey< ILArOFC >	m_ofcKey {this,"OFCKey","LArOFC","SG Key of OFC conditions object"}
SG::ReadCondHandleKey< ILArShape >	m_shapeKey {this,"ShapeKey","LArShape","SG Key of Shape conditions object"}
SG::ReadCondHandleKey< LArDSPThresholdsComplete >	m_run1DSPThresholdsKey {this, "Run1DSPThresholdsKey","", "SG Key for thresholds to compute time and quality, run 1"}
SG::ReadCondHandleKey< AthenaAttributeList >	m_run2DSPThresholdsKey {this, "Run2DSPThresholdsKey","", "SG Key for thresholds to compute time and quality, run 2"}
SG::ReadCondHandleKey< CondAttrListCollection >	m_nnClustersDb {this, "nnClustersDbFolder","/LAR/IdentifierOfl/OnnxMap","Folder name for the NN clustering map"}
ServiceHandle< AthOnnx::IOnnxRuntimeSvc >	m_onnxRuntimeSvc {this, "OnnxRuntimeSvc", "AthOnnx::OnnxRuntimeSvc/OnnxRuntimeSvc", "The Onnx runtime service"}
Gaudi::Property< int >	m_firstSample {this, "firstSample", 0, "first of the 32 sampels of the MC shape to be used"}
const LArOnlineID *	m_onlineId = nullptr
const CaloCell_ID *	m_calocellID = nullptr
Gaudi::Property< bool >	m_useDBFortQ {this,"useDB",true,"Use DB for cut on t,Q"}
DataObjIDColl	m_extendedExtraObjects
	Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.
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

Definition at line 33 of file LArNNRawChannelBuilder.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 ( ) const

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.

Definition at line 75 of file AthCommonReentrantAlgorithm.cxx.

{
  return 0;
}

◆ 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 LArNNRawChannelBuilder::execute ( const EventContext & ctx ) const

override

Definition at line 59 of file LArNNRawChannelBuilder.cxx.

                                                                        {
  Ort::MemoryInfo memory_info = Ort::MemoryInfo::CreateCpu(OrtArenaAllocator, OrtMemTypeDefault);
  Ort::SessionOptions session_options;
  session_options.SetIntraOpNumThreads(1);
 
  std::vector<int> hashIdToCluster;
  std::vector<std::shared_ptr<Ort::Session>> clusterToOnnx;
 
  const CondAttrListCollection *catr{nullptr};
  ATH_CHECK(SG::get(catr, m_nnClustersDb, ctx));
 
  if(!catr){
    ATH_MSG_ERROR("CondAttrListCollection can't be opened");
    return StatusCode::FAILURE;
  }
 
  CondAttrListCollection::const_iterator chanIt=catr->begin();
  const coral::Blob& bls = chanIt->second["clusters"].data<coral::Blob>();
  const unsigned char* blobData = static_cast<const unsigned char*>(bls.startingAddress());
 
  // Reading BLOB part by part
  int blob_ctr = 0;
  // Nb of IDs encoded as 3 bytes
  int nHash = static_cast<unsigned char>(blobData[blob_ctr]) << 16 |
                static_cast<unsigned char>(blobData[blob_ctr+1]) << 8 |
                static_cast<unsigned char>(blobData[blob_ctr+2]);
  blob_ctr += 3;
  hashIdToCluster.resize(nHash,-1);
 
  // Nb of clusters encoded as 2 bytes
  int nCluster = static_cast<unsigned char>(blobData[blob_ctr]) << 8 | 
                    static_cast<unsigned char>(blobData[blob_ctr+1]);
  blob_ctr += 2;
  clusterToOnnx.resize(nCluster,nullptr);
 
  // Reading clusters for each ID
  for(int i=0; i<nHash;i++){
    int cluster;
    cluster = static_cast<unsigned char>(blobData[blob_ctr]) << 8 | 
                static_cast<unsigned char>(blobData[blob_ctr+1]);
    blob_ctr += 2;
    hashIdToCluster[i] = cluster;
  }
 
  // Creating ONNX model instances
  for(int i=0; i<nCluster; i++){
    // Size of the instance written in the BLOB
    int nnInstanceSize = static_cast<unsigned char>(blobData[blob_ctr]) << 16 |
                    static_cast<unsigned char>(blobData[blob_ctr+1]) << 8 |
                    static_cast<unsigned char>(blobData[blob_ctr+2]);
    blob_ctr += 3;
    std::vector<char> nnInstanceContent(blobData + blob_ctr, blobData + blob_ctr + nnInstanceSize);
    blob_ctr += nnInstanceSize;
    // One session per model
    clusterToOnnx[i] = std::make_shared<Ort::Session>(m_onnxRuntimeSvc->env(), nnInstanceContent.data(), nnInstanceContent.size(), session_options);
  }
  //Get event inputs from read handles:
  SG::ReadHandle<LArDigitContainer>inputContainer(m_digitKey, ctx);
  ATH_CHECK(inputContainer.isValid());
  //Write output via write handle
  auto outputContainerLRPtr = std::make_unique<LArRawChannelContainer>();
  //Get Conditions input
  SG::ReadCondHandle<ILArPedestal>pedHdl(m_pedestalKey, ctx);
  ATH_CHECK(pedHdl.isValid());
  const ILArPedestal* peds = *pedHdl;
   const LArADC2MeV* adc2MeVs{nullptr};
   ATH_CHECK(SG::get(adc2MeVs, m_adc2MeVKey, ctx));
  SG::ReadCondHandle<LArOnOffIdMapping>cabling(m_cablingKey, ctx);
  ATH_CHECK(cabling.isValid());
 
  // Same instance of input tensors are used
  std::vector<Ort::Value> input_tensors;
  // inputSamples variable memory is being used for the input tensors --> modify inputSamples to modify what's inside the inout tensors
  std::vector<std::vector<float>> inputSamples(24, std::vector<float>(1, 0.0f));
  // Same shapes should be provided for every neural networks
  std::vector<std::vector<int64_t>> inputShape;
  // Same input and output names sould be provided for every neural networks
  std::vector<char*> input_names;
  std::vector<const char*> output_names;
  // Indices are sorted differently with the ORT, so it's needed to keep in memory to go faster than reading for each cell
  std::vector<int> indicesOrder(24,-1);
  // Boolean for the first iteration
  int firstIter = 1;
  //Loop over digits:
  for (const LArDigit* digit : *inputContainer) {
    const HWIdentifier id = digit->hardwareID();
    Identifier idCell;
    try {
        idCell = (*cabling)->cnvToIdentifier(id);
    } catch ( LArID_Exception & except ) {
        ATH_MSG_DEBUG( "A Cabling exception was caught for channel 0x!" 
                    << MSG::hex << id.get_compact() << MSG::dec  );
        continue ;
    }
    const IdentifierHash oflHash=m_calocellID->calo_cell_hash(idCell);
    const bool connected = (*cabling)->isOnlineConnected(id);
 
    ATH_MSG_VERBOSE("Working on channel " << m_onlineId->channel_name(id));
    const std::vector<short>& samples = digit->samples();
    const int gain = digit->gain();
    const float pedestal_value = peds->pedestal(id, gain);
    const int clusterFromHash = hashIdToCluster[oflHash];
    if (clusterFromHash<0){
      ATH_MSG_ERROR("LArNNRawChannelBuilder::execute: clusterFromHash returned"<<clusterFromHash);
      return StatusCode::FAILURE;
    
    }
    unsigned nnNumInputs = clusterToOnnx[clusterFromHash]->GetInputCount();
    unsigned nnNumOutputs = clusterToOnnx[clusterFromHash]->GetOutputCount();
 
    if(firstIter==1){
      inputShape.resize(nnNumInputs);
      indicesOrder.resize(nnNumInputs);
      input_names.resize(nnNumInputs);
      for(unsigned int i = 0; i < nnNumInputs; i++){
        auto type_info = clusterToOnnx[clusterFromHash]->GetInputTypeInfo(i);
        auto tensor_info = type_info.GetTensorTypeAndShapeInfo();
        Ort::AllocatedStringPtr nnVariableNameStrPtr = clusterToOnnx[clusterFromHash]->GetInputNameAllocated(i, Ort::AllocatorWithDefaultOptions());
        // Retrieving the ownership of the unique_ptr that was keeping the variable name
        char * nnVariableName = nnVariableNameStrPtr.release();
        input_names[i] = nnVariableName;
        inputSamples.resize(static_cast<int>(nnNumInputs));
        if(std::strlen(nnVariableName) <= 7){
          ATH_MSG_ERROR("Input name must starts with \"sample_\", then \"m\" (< 0) or \"p\" (>= 0) and end with an index (example : sample_m2)");
          return StatusCode::FAILURE;
        }
        if(!(std::strncmp(nnVariableName, "sample_", 7) == 0)){
          ATH_MSG_ERROR("Input name must starts with \"sample_\", then \"m\" (< 0) or \"p\" (>= 0) and end with an index (example : sample_m2)");
          return StatusCode::FAILURE;
        }
        char index_sign = nnVariableName[7];
        int index = std::atoi(nnVariableName + 8);
        if(index_sign == 'm'){
          index*=-1;
        }
        else if(index_sign != 'p'){
          ATH_MSG_ERROR("Wrong sign used, you have to use \"m\" (< 0) or \"p\" (>= 0)");
          return StatusCode::FAILURE;
        }
        indicesOrder[i] = index;
        for(auto el : tensor_info.GetShape()){
          inputShape[i].push_back((int) abs(el));
        }
        input_tensors.push_back(Ort::Value::CreateTensor<float>(memory_info, inputSamples[i].data(), inputSamples[i].size(), inputShape[i].data(), inputShape[i].size()));
      }
      for(unsigned int i = 0; i < nnNumOutputs; i++){
        auto outputName = clusterToOnnx[clusterFromHash]->GetOutputNameAllocated(i, Ort::AllocatorWithDefaultOptions());
        output_names.push_back(outputName.release());
      }
    }
 
    firstIter = 0;
    for(unsigned int i = 0; i < nnNumInputs; i++){
      char index_sign = input_names[i][7];
      int index = std::atoi(input_names[i] + 8);
      if(index_sign == 'm'){
        index*=-1;
      }
      else if(index_sign != 'p'){
        ATH_MSG_ERROR("Wrong sign used, you have to use \"m\" (< 0) or \"p\" (>= 0)");
        return StatusCode::FAILURE;
      }
      inputSamples[i][0] = ((samples[index+m_firstSample]-pedestal_value)/(4096.0-pedestal_value));
    }
    //The following autos will resolve either into vectors or vector-proxies
    const auto& adc2mev = adc2MeVs->ADC2MEV(id, gain);
 
    if (ATH_UNLIKELY(pedestal_value == ILArPedestal::ERRORCODE)) {
      if (!connected) continue;       //No conditions for disconencted channel, who cares?
      ATH_MSG_ERROR("No valid pedestal for connected channel " << m_onlineId->channel_name(id)
                                                               << " gain " << gain);
      return StatusCode::FAILURE;
    }
 
    if (ATH_UNLIKELY(adc2mev.size() < 2)) {
      if (!connected) continue;       //No conditions for disconencted channel, who cares?
      ATH_MSG_ERROR("No valid ADC2MeV for connected channel " << m_onlineId->channel_name(id)
                                                              << " gain " << gain);
      return StatusCode::FAILURE;
    }
 
    // Compute amplitude
    float An = 0;
    float A = 0;
    bool saturated = false;
    // Check saturation AND discount pedestal on samples used by the NN
    std::vector<float>samp_no_ped(nnNumInputs, 0.0);
    for (unsigned int i = 0; i < nnNumInputs; i++) {
      int index = indicesOrder[i]+m_firstSample;
      if (samples[index] == 4096 || samples[index] == 0) saturated = true;
      samp_no_ped[i] = samples[index]-pedestal_value;
    }
 
    std::vector<Ort::Value> outputs;
         
    outputs = clusterToOnnx[clusterFromHash]->Run(Ort::RunOptions{nullptr}, input_names.data(), input_tensors.data(), input_tensors.size(), output_names.data(), output_names.size());
 
    //normalised output
    An = outputs.front().GetTensorMutableData<float>()[0];
 
    //taking the normalisation into account
    A = An*(4096.0-pedestal_value);
 
    //Apply Ramp
    const float E = adc2mev[0]+A*adc2mev[1];
 
    uint16_t iquaShort = 0;
    float tau = 0;
 
 
    uint16_t prov = LArProv::PEAKNN | LArProv::RAMPDB | LArProv::PEDDB;
    if (saturated) prov |= LArProv::SATURATED;
 
 
    outputContainerLRPtr->emplace_back(id, static_cast<int>(std::floor(E+0.5)),
                                        static_cast<int>(std::floor(tau+0.5)),
                                        iquaShort, prov, (CaloGain::CaloGain)gain);
    
  }
 
  SG::WriteHandle<LArRawChannelContainer>outputContainer(m_rawChannelKey, ctx);
  
  for(auto el : input_names){
    delete el;
  }
 
  for(auto el : output_names){
    delete el;
  }
  ATH_CHECK(outputContainer.record(std::move(outputContainerLRPtr) ) );
  
  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 ( ) const

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 LArNNRawChannelBuilder::initialize ( )

override

Definition at line 32 of file LArNNRawChannelBuilder.cxx.

                                              {
  ATH_CHECK(m_digitKey.initialize());
  ATH_CHECK(m_rawChannelKey.initialize());
  ATH_CHECK(m_pedestalKey.initialize());
  ATH_CHECK(m_adc2MeVKey.initialize());
  ATH_CHECK(m_cablingKey.initialize() );
  ATH_CHECK(m_ofcKey.initialize());     
  ATH_CHECK(m_shapeKey.initialize());
  ATH_CHECK(m_run1DSPThresholdsKey.initialize(SG::AllowEmpty) );
  ATH_CHECK(m_run2DSPThresholdsKey.initialize(SG::AllowEmpty) );
  if (m_useDBFortQ) {
    if (m_run1DSPThresholdsKey.empty() && m_run2DSPThresholdsKey.empty()) {
      ATH_MSG_ERROR ("useDB requested but neither Run1DSPThresholdsKey nor Run2DSPThresholdsKey initialized.");
      return StatusCode::FAILURE;
    }
  }
  ATH_CHECK(m_nnClustersDb.initialize());
 
  ATH_CHECK(detStore()->retrieve(m_onlineId,"LArOnlineID"));
  ATH_CHECK(detStore()->retrieve(m_calocellID,"CaloCell_ID"));
  
  ATH_CHECK(m_onnxRuntimeSvc.retrieve());
 
  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 ( ) const

overridevirtualinherited

Specify if the algorithm is clonable.

Reentrant algorithms are clonable.

Reimplemented in InDet::GNNSeedingTrackMaker, InDet::SCT_Clusterization, InDet::SiSPGNNTrackMaker, InDet::SiSPSeededTrackFinder, InDet::SiTrackerSpacePointFinder, ITkPixelCablingAlg, ITkStripCablingAlg, RoIBResultToxAOD, SCT_ByteStreamErrorsTestAlg, SCT_CablingCondAlgFromCoraCool, SCT_CablingCondAlgFromText, SCT_ConditionsParameterTestAlg, SCT_ConditionsSummaryTestAlg, SCT_ConfigurationConditionsTestAlg, SCT_FlaggedConditionTestAlg, SCT_LinkMaskingTestAlg, SCT_MajorityConditionsTestAlg, SCT_ModuleVetoTestAlg, SCT_MonitorConditionsTestAlg, SCT_PrepDataToxAOD, SCT_RawDataToxAOD, SCT_ReadCalibChipDataTestAlg, SCT_ReadCalibDataTestAlg, SCT_RODVetoTestAlg, SCT_SensorsTestAlg, SCT_SiliconConditionsTestAlg, SCT_StripVetoTestAlg, SCT_TdaqEnabledTestAlg, SCT_TestCablingAlg, SCTEventFlagWriter, SCTRawDataProvider, SCTSiLorentzAngleTestAlg, SCTSiPropertiesTestAlg, and Simulation::BeamEffectsAlg.

Definition at line 68 of file AthCommonReentrantAlgorithm.cxx.

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

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

◆ 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 HypoBase, and InputMakerBase.

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_adc2MeVKey

SG::ReadCondHandleKey<LArADC2MeV> LArNNRawChannelBuilder::m_adc2MeVKey {this, "ADC2MeVKey", "LArADC2MeV", "SG Key of ADC2MeV conditions object"}

private

Definition at line 51 of file LArNNRawChannelBuilder.h.

51{this, "ADC2MeVKey", "LArADC2MeV", "SG Key of ADC2MeV conditions object"};

◆ m_cablingKey

SG::ReadCondHandleKey<LArOnOffIdMapping> LArNNRawChannelBuilder::m_cablingKey {this, "CablingKey", "LArOnOffIdMap", "SG Key of LArOnOffIdMapping object"}

private

Definition at line 52 of file LArNNRawChannelBuilder.h.

52{this, "CablingKey", "LArOnOffIdMap", "SG Key of LArOnOffIdMapping object"};

◆ m_calocellID

const CaloCell_ID* LArNNRawChannelBuilder::m_calocellID = nullptr

private

Definition at line 65 of file LArNNRawChannelBuilder.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_digitKey

SG::ReadHandleKey<LArDigitContainer> LArNNRawChannelBuilder::m_digitKey

private

Initial value:

{this, "LArDigitKey", "FREE",

"SG Key of LArDigitContaiiner"}

Definition at line 44 of file LArNNRawChannelBuilder.h.

44 {this, "LArDigitKey", "FREE",

45 "SG Key of LArDigitContaiiner"};

◆ 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_firstSample

Gaudi::Property<int> LArNNRawChannelBuilder::m_firstSample {this, "firstSample", 0, "first of the 32 sampels of the MC shape to be used"}

private

Definition at line 61 of file LArNNRawChannelBuilder.h.

61{this, "firstSample", 0, "first of the 32 sampels of the MC shape to be used"};

◆ m_nnClustersDb

SG::ReadCondHandleKey<CondAttrListCollection> LArNNRawChannelBuilder::m_nnClustersDb {this, "nnClustersDbFolder","/LAR/IdentifierOfl/OnnxMap","Folder name for the NN clustering map"}

private

Definition at line 57 of file LArNNRawChannelBuilder.h.

57{this, "nnClustersDbFolder","/LAR/IdentifierOfl/OnnxMap","Folder name for the NN clustering map"};

◆ m_ofcKey

SG::ReadCondHandleKey<ILArOFC> LArNNRawChannelBuilder::m_ofcKey {this,"OFCKey","LArOFC","SG Key of OFC conditions object"}

private

Definition at line 53 of file LArNNRawChannelBuilder.h.

53{this,"OFCKey","LArOFC","SG Key of OFC conditions object"};

◆ m_onlineId

const LArOnlineID* LArNNRawChannelBuilder::m_onlineId = nullptr

private

Definition at line 64 of file LArNNRawChannelBuilder.h.

◆ m_onnxRuntimeSvc

ServiceHandle<AthOnnx::IOnnxRuntimeSvc> LArNNRawChannelBuilder::m_onnxRuntimeSvc {this, "OnnxRuntimeSvc", "AthOnnx::OnnxRuntimeSvc/OnnxRuntimeSvc", "The Onnx runtime service"}

private

Definition at line 58 of file LArNNRawChannelBuilder.h.

58{this, "OnnxRuntimeSvc", "AthOnnx::OnnxRuntimeSvc/OnnxRuntimeSvc", "The Onnx runtime service"};

◆ m_pedestalKey

SG::ReadCondHandleKey<ILArPedestal> LArNNRawChannelBuilder::m_pedestalKey {this, "PedestalKey", "LArPedestal", "SG Key of Pedestal conditions object"}

private

Definition at line 50 of file LArNNRawChannelBuilder.h.

50{this, "PedestalKey", "LArPedestal", "SG Key of Pedestal conditions object"};

◆ m_rawChannelKey

SG::WriteHandleKey<LArRawChannelContainer> LArNNRawChannelBuilder::m_rawChannelKey

private

Initial value:

{this, "LArRawChannelKey", "LArRawChannels",

"SG key of the output LArRawChannelContainer"}

Definition at line 47 of file LArNNRawChannelBuilder.h.

47 {this, "LArRawChannelKey", "LArRawChannels",

48 "SG key of the output LArRawChannelContainer"};

◆ m_run1DSPThresholdsKey

SG::ReadCondHandleKey<LArDSPThresholdsComplete> LArNNRawChannelBuilder::m_run1DSPThresholdsKey {this, "Run1DSPThresholdsKey","", "SG Key for thresholds to compute time and quality, run 1"}

private

Definition at line 55 of file LArNNRawChannelBuilder.h.

55{this, "Run1DSPThresholdsKey","", "SG Key for thresholds to compute time and quality, run 1"};

◆ m_run2DSPThresholdsKey

SG::ReadCondHandleKey<AthenaAttributeList> LArNNRawChannelBuilder::m_run2DSPThresholdsKey {this, "Run2DSPThresholdsKey","", "SG Key for thresholds to compute time and quality, run 2"}

private

Definition at line 56 of file LArNNRawChannelBuilder.h.

56{this, "Run2DSPThresholdsKey","", "SG Key for thresholds to compute time and quality, run 2"};

◆ m_shapeKey

SG::ReadCondHandleKey<ILArShape> LArNNRawChannelBuilder::m_shapeKey {this,"ShapeKey","LArShape","SG Key of Shape conditions object"}

private

Definition at line 54 of file LArNNRawChannelBuilder.h.

54{this,"ShapeKey","LArShape","SG Key of Shape conditions object"};

◆ m_useDBFortQ

Gaudi::Property<bool> LArNNRawChannelBuilder::m_useDBFortQ {this,"useDB",true,"Use DB for cut on t,Q"}

private

Definition at line 69 of file LArNNRawChannelBuilder.h.

69{this,"useDB",true,"Use DB for cut on t,Q"};

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Member Function Documentation

◆ cardinality()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ filterPassed()

◆ initialize()

◆ inputHandles()

◆ isClonable()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ setFilterPassed()

◆ sysExecute()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_adc2MeVKey

◆ m_cablingKey

◆ m_calocellID

◆ m_detStore

◆ m_digitKey

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_firstSample

◆ m_nnClustersDb

◆ m_ofcKey

◆ m_onlineId

◆ m_onnxRuntimeSvc

◆ m_pedestalKey

◆ m_rawChannelKey

◆ m_run1DSPThresholdsKey

◆ m_run2DSPThresholdsKey

◆ m_shapeKey

◆ m_useDBFortQ

◆ m_varHandleArraysDeclared

◆ m_vhka