#include <LArOFFCRawChannelBuilder.h>

Inheritance diagram for LArOFFCRawChannelBuilder:

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 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
	Get filter decision:
virtual void	setFilterPassed (bool state, const EventContext &ctx) const
	Set filter decision:
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
std::vector< double >	convolvePulse (const ILArShape::ShapeRef_t &shape, const ILArOFC::OFCRef_t &ofc) const
double	computeOFFC (const std::vector< short > &samples, int firstSample, const ILArOFC::OFCRef_t &ofc, const ILArShape::ShapeRef_t &shape, double pedestal) const
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
SG::ReadCondHandleKey< LArADC2MeV >	m_adc2MeVKey
SG::ReadCondHandleKey< ILArOFC >	m_ofcKey
SG::ReadCondHandleKey< ILArShape >	m_shapeKey
SG::ReadCondHandleKey< LArOnOffIdMapping >	m_cablingKey
SG::ReadCondHandleKey< LArDSPThresholdsComplete >	m_run1DSPThresholdsKey
SG::ReadCondHandleKey< AthenaAttributeList >	m_run2DSPThresholdsKey
Gaudi::Property< float >	m_eCutFortQ
Gaudi::Property< bool >	m_absECutFortQ
Gaudi::Property< bool >	m_useShapeDer
Gaudi::Property< bool >	m_useDBFortQ
Gaudi::Property< int >	m_firstSample
Gaudi::Property< double >	m_belowThreshold
	The OFFC algorithm extends the standard optimal filtering by identifying in-time pulses and subtracting their expected contribution from future samples.
Gaudi::Property< int >	m_belowTillReset
	Number of consecutive below-threshold samples required before the forward-subtraction cache is reset.
Gaudi::Property< int >	m_nPulse
	Maximum number of overlapping pulses that can be tracked simultaneously.
Gaudi::Property< double >	m_Q3cut
	Quality cut used for pulse acceptance.
Gaudi::Property< double >	m_filterThreshold
	Minimum filtered amplitude required to consider a sample as a pulse peak.
const LArOnlineID *	m_onlineId = nullptr
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 26 of file LArOFFCRawChannelBuilder.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

◆ computeOFFC()

double LArOFFCRawChannelBuilder::computeOFFC	(	const std::vector< short > &	samples,
		int	firstSample,
		const ILArOFC::OFCRef_t &	ofc,
		const ILArShape::ShapeRef_t &	shape,
		double	pedestal ) const

private

Definition at line 51 of file LArOFFCRawChannelBuilder.cxx.

                                                                    {
  // OFFC parameters (configured via job options)
  // belowThreshold   : ADC threshold to detect quiet regions
  // belowTillReset   : consecutive quiet samples before cache reset
  // npulse           : max number of overlapping pulses tracked
  // Q3cut            : shape-consistency cut for pulse acceptance
  // filterThreshold  : minimum filtered amplitude to seed a pulse
 
  const int nSamples = samples.size();
  const int ofcLen = ofc.size();
 
  // Pedestal subtraction
  std::vector<double> samp_no_ped(nSamples);
  for (int i = 0; i < nSamples; ++i)
    samp_no_ped[i] = samples[i] - pedestal;
 
  std::vector<double> filtered(nSamples, 0.0);
  std::vector<double> reco(nSamples, 0.0);
 
  // Precompute convolved pulse
  std::vector<double> convPulse = convolvePulse(shape, ofc);
  const int convSize = convPulse.size();
  std::vector<double> cache(convSize, 0.0);
 
  // Index of pulse maximum in reference shape
  auto it = std::ranges::max_element(shape);
  int shapemax = std::distance(shape.begin(), it);
 
  // Determine how many pulses stored
  std::vector<int> context(m_nPulse, 0);
  int belowCounter = 0;
 
  const int loopEnd = std::max(0, nSamples - ofcLen);
 
  for (int i = 0; i < loopEnd; ++i) {
 
    // Reset correction cache after extended quiet region
    if (std::abs(samp_no_ped[i]) < m_belowThreshold) {
      if (++belowCounter == m_belowTillReset) {
        belowCounter = 0;
        std::fill(cache.begin(), cache.end(), 0.0);
      }
    } else {
      belowCounter = 0;
    }
 
    // Standard OF filtering
    for (int j = 0; j < ofcLen; ++j)
      filtered[i] += samp_no_ped[i + j] * ofc[j];
 
    if (i > 4) {
      // Apply  forward correction
      reco[i - 1] = filtered[i - 1] + cache[2];
      const double A = reco[i - 1];
 
      // Local maximum + amplitude cut
      if (A > m_filterThreshold && filtered[i - 1] > filtered[i - 2] &&
          filtered[i - 1] > filtered[i]) {
 
        // Shape-consistency (Q3) test
        auto shapeVal = [&](int k) {
          return (k >= 0 && k < (int)shape.size()) ? shape[k] : 0.0;
        };
 
        double Q3 = 0.0;
        Q3 += std::abs(filtered[i - 2] - A * shapeVal(shapemax - 1));
        Q3 += std::abs(filtered[i - 1] - A * shapeVal(shapemax));
        Q3 += std::abs(filtered[i] - A * shapeVal(shapemax + 1));
        Q3 += std::abs(filtered[i - 3] - A * shapeVal(shapemax - 2));
 
        // Accept pulse and subtract its forward correction
        if (Q3 < m_Q3cut) {
          for (int& c : context) {
            if (c == 0) {
              for (int k = 0; k < convSize; ++k)
                cache[k] -= convPulse[k] * A;
              c = convSize;
              break;
            }
          }
        }
      }
    }
 
    // Advance correction cache in time
    std::rotate(cache.begin(), cache.begin() + 1, cache.end());
    cache.back() = 0.0;
 
    for (int& c : context)
      if (c > 0)
        --c;
  }
 
  // Return reconstructed amplitude at requested sample
  return reco[firstSample + 1];
}

◆ convolvePulse()

std::vector< double > LArOFFCRawChannelBuilder::convolvePulse	(	const ILArShape::ShapeRef_t &	shape,
		const ILArOFC::OFCRef_t &	ofc ) const

private

Definition at line 24 of file LArOFFCRawChannelBuilder.cxx.

                                                                        {
  // Convolve pulse shape with time-reversed OFC to build forward-correction
  // template
 
  const int shapeSize = shape.size();
  const int ofcSize = ofc.size();
 
  std::vector<double> ofcRev(ofcSize);
  for (int i = 0; i < ofcSize; ++i)
    ofcRev[i] = ofc[ofcSize - 1 - i];
 
  const int fullLen = shapeSize + ofcSize - 1;
  std::vector<double> fullConv(fullLen, 0.0);
 
  for (int i = 0; i < shapeSize; ++i)
    for (int j = 0; j < ofcSize; ++j)
      fullConv[i + j] += shape[i] * ofcRev[j];
 
  // Drop early samples to align correction with trigger window
  const int startIndex = 2;
  if (startIndex >= fullLen)
    return {};
 
  return std::vector<double>(fullConv.begin() + startIndex, fullConv.end());
}

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

override

Definition at line 187 of file LArOFFCRawChannelBuilder.cxx.

                                                                          {
 
  ATH_MSG_VERBOSE("Executing LArOFFCRawChannelBuilder::execute");
 
  // Get event inputs from read handles:
  const LArDigitContainer* inputContainer{};
  ATH_CHECK(SG::get(inputContainer, m_digitKey, ctx));
 
  // Write output via write handle
  auto outputContainer = std::make_unique<LArRawChannelContainer>();
 
  // Get Conditions input
  const ILArPedestal* peds{};
  ATH_CHECK(SG::get(peds, m_pedestalKey, ctx));
 
  const LArADC2MeV* adc2MeVs{};
  ATH_CHECK(SG::get(adc2MeVs, m_adc2MeVKey, ctx));
 
  const ILArOFC* ofcs{nullptr};
  ATH_CHECK(SG::get(ofcs, m_ofcKey, ctx));
 
  const ILArShape* shapes{};
  ATH_CHECK(SG::get(shapes, m_shapeKey, ctx));
  
  const LArOnOffIdMapping* cabling{};
  ATH_CHECK(SG::get(cabling, m_cablingKey, ctx));
 
  std::unique_ptr<LArDSPThresholdsFlat> run2DSPThresh;
  const LArDSPThresholdsComplete* run1DSPThresh = nullptr;
  ATH_CHECK(SG::get(run1DSPThresh, m_run1DSPThresholdsKey, ctx));
  if (m_useDBFortQ) {
    if (!m_run2DSPThresholdsKey.empty()) {
      SG::ReadCondHandle<AthenaAttributeList> dspThrshAttr(
          m_run2DSPThresholdsKey, ctx);
      run2DSPThresh = std::make_unique<LArDSPThresholdsFlat>(*dspThrshAttr);
      if (ATH_UNLIKELY(!run2DSPThresh->good())) {
        ATH_MSG_ERROR(
            "Failed to initialize LArDSPThresholdFlat from attribute list "
            "loaded from "
            << m_run2DSPThresholdsKey.key() << ". Aborting.");
        return StatusCode::FAILURE;
      }
    } else if (!m_run1DSPThresholdsKey.empty()) {
      SG::ReadCondHandle<LArDSPThresholdsComplete> dspThresh(
          m_run1DSPThresholdsKey, ctx);
      run1DSPThresh = dspThresh.cptr();
    } else {
      ATH_MSG_ERROR("No DSP threshold configured.");
      return StatusCode::FAILURE;
    }
  }
 
  // Loop over digits:
  for (const LArDigit* digit : *inputContainer) {
 
    size_t firstSample = m_firstSample;
 
    const HWIdentifier id = digit->hardwareID();
 
    const bool connected = cabling->isOnlineConnected(id);
 
    const std::vector<short>& samples = digit->samples();
    const int gain = digit->gain();
    const float p = peds->pedestal(id, gain);
 
    // The following autos will resolve either into vectors or vector-proxies
    const auto& ofca = ofcs->OFC_a(id, gain);
    const auto& adc2mev = adc2MeVs->ADC2MEV(id, gain);
    const size_t nOFC = ofca.size();
 
    // Sanity check on input conditions data:
    //  ensure that the size of the samples vector is compatible with ofc_a size
    //  when preceeding samples are saved
    const size_t nSamples = samples.size() - firstSample;
    if (nSamples < nOFC) {
      ATH_MSG_ERROR("effective sample size: "
                    << nSamples << ", must be >= OFC_a size: " << ofca.size());
      return StatusCode::FAILURE;
    }
 
    if (ATH_UNLIKELY(p == 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;
    }
 
    // Apply OFFC to get amplitude
    //  Evaluate sums in double-precision to get consistent results
    //  across platforms.
 
    bool saturated = false;
    // Check saturation AND discount pedestal
    std::vector<double> samp_no_ped(nOFC, 0.0);
    for (size_t i = 0; i < nOFC; ++i) {
      if (samples[i + firstSample] == 4096 || samples[i + firstSample] == 0)
        saturated = true;
      samp_no_ped[i] = samples[i + firstSample] - p;
    }
 
    uint16_t iquaShort = 0;
    float tau = 0;
 
    uint16_t prov = 0xa5;  // Means all constants from DB
    if (saturated)
      prov |= 0x0400;
 
    float ecut(0.);
    if (m_useDBFortQ) {
      if (run2DSPThresh) {
        ecut = run2DSPThresh->tQThr(id);
      } else if (run1DSPThresh) {
        ecut = run1DSPThresh->tQThr(id);
      } else {
        ATH_MSG_ERROR("DSP threshold problem");
        return StatusCode::FAILURE;
      }
    } else {
      ecut = m_eCutFortQ;
    }
 
    const auto& fullShape = shapes->Shape(id, gain);
 
    double A = computeOFFC(samples, firstSample, ofca, fullShape, p);
 
    const float E = adc2mev[0] + A * adc2mev[1];
 
    const float E1 = m_absECutFortQ.value() ? std::fabs(E) : E;
 
    if (E1 > ecut) {
      ATH_MSG_VERBOSE("Channel " << m_onlineId->channel_name(id) << " gain "
                                 << gain
                                 << " above threshold for tQ computation");
      prov |= 0x2000;  //  fill bit in provenance that time+quality information
                       //  are available
 
      // Get time by applying OFC-b coefficients:
      const auto& ofcb = ofcs->OFC_b(id, gain);
      double At = 0;
      for (size_t i = 0; i < nOFC; ++i) {
        At += static_cast<double>(samp_no_ped[i]) * ofcb[i];
      }
 
      // At = m_offcTool->compute(samples, firstSample, ofcb, fullShape,
      // ecutadc, p);
      // Divide A*t/A to get time
      tau = (std::fabs(A) > 0.1) ? At / A : 0.0;
 
      // Get Q-factor
      // fixing HEC to move +1 in case of 4 samples and firstSample 0 (copied
      // from old LArRawChannelBuilder)
      const size_t nSamples = samples.size();
      if (fullShape.size() > nSamples && nSamples == 4 && m_firstSample == 0) {
        if (m_onlineId->isHECchannel(id)) {
          firstSample = 1;
        }
      }
 
      if (ATH_UNLIKELY(fullShape.size() < nOFC + firstSample)) {
        if (!connected)
          continue;  // No conditions for disconnected channel, who cares?
        ATH_MSG_ERROR("No valid shape for channel "
                      << m_onlineId->channel_name(id) << " gain " << gain);
        ATH_MSG_ERROR("Got size " << fullShape.size() << ", expected at least "
                                  << nSamples + firstSample);
        return StatusCode::FAILURE;
      }
 
      std::span<const float> shape(fullShape.data() + firstSample, fullShape.size() - firstSample);
 
      double q = 0;
      if (m_useShapeDer) {
        const auto& fullshapeDer = shapes->ShapeDer(id, gain);
        if (ATH_UNLIKELY(fullshapeDer.size() < nOFC + firstSample)) {
          ATH_MSG_ERROR("No valid shape derivative for channel "
                        << m_onlineId->channel_name(id) << " gain " << gain);
          ATH_MSG_ERROR("Got size " << fullshapeDer.size()
                                    << ", expected at least "
                                    << nOFC + firstSample);
          return StatusCode::FAILURE;
        }
 
        std::span<const float> shapeDer(fullshapeDer.data() + firstSample, fullshapeDer.size() - firstSample);
 
        
        for (size_t i = 0; i < nOFC; ++i) {
          q += std::pow((A * (shape[i] - tau * shapeDer[i]) - (samp_no_ped[i])),
                        2);
        }
      }  // end if useShapeDer
      else {
        // Q-factor w/o shape derivative
        for (size_t i = 0; i < nOFC; ++i) {
          q += std::pow((A * shape[i] - (samp_no_ped[i])), 2);
        }
      }
 
      int iqua = std::min(static_cast<int>(q), 0xFFFF);
 
      iquaShort = static_cast<uint16_t>(iqua & 0xFFFF);
 
      tau -= ofcs->timeOffset(id, gain);
      tau *= (Gaudi::Units::nanosecond /
              Gaudi::Units::picosecond);  // Convert time to ps
    }  // end if above cut
 
    outputContainer->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> outputHandle(m_rawChannelKey, ctx);
  ATH_CHECK(outputHandle.record(std::move(outputContainer)));
 
  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 & AthCommonAlgorithm< 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 89 of file AthCommonAlgorithm.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 AthCommonAlgorithm< Gaudi::Algorithm >::filterPassed ( const EventContext & ctx ) const

inlinevirtualinherited

Get filter decision:

Definition at line 93 of file AthCommonAlgorithm.h.

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

◆ initialize()

StatusCode LArOFFCRawChannelBuilder::initialize ( )

override

Definition at line 152 of file LArOFFCRawChannelBuilder.cxx.

                                                {
  ATH_CHECK(m_digitKey.initialize());
  ATH_CHECK(m_rawChannelKey.initialize());
  ATH_CHECK(m_pedestalKey.initialize());
  ATH_CHECK(m_adc2MeVKey.initialize());
  ATH_CHECK(m_ofcKey.initialize());
  ATH_CHECK(m_shapeKey.initialize());
  ATH_CHECK(m_cablingKey.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 Run1... nor Run2... initialized.");
      return StatusCode::FAILURE;
    }
  }
 
  ATH_CHECK(detStore()->retrieve(m_onlineId, "LArOnlineID"));
 
  if (m_firstSample < 5) { 
    ATH_MSG_ERROR("firstSample must be >= 5 to allow for OFFC processing");
    return StatusCode::FAILURE;
  }
 
  const std::string cutmsg = m_absECutFortQ.value() ? " fabs(E) < " : " E < ";
  ATH_MSG_INFO("Energy cut for time and quality computation: "
               << cutmsg << " taken from COOL folder "
               << m_run1DSPThresholdsKey.key() << " (run1) "
               << m_run2DSPThresholdsKey.key() << " (run2) ");
 
  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()

virtual bool AthCommonAlgorithm< Gaudi::Algorithm >::isClonable ( ) const

inlineoverridevirtualinherited

Specify if the algorithm is clonable.

Only relevant for non-reentrant algorithms. Actual number of clones needs to be set via the "Cardinality" property.

Reimplemented in AFP_DigiTop, AlgB, AlgT, BCM_Digitization, CscDigitBuilder, CscDigitToCscRDO, G4AtlasAlg, G4RunAlg, HGTD_Digitization, HiveAlgBase, InDet::GNNSeedingTrackMaker, InDet::SCT_Clusterization, InDet::SiSPGNNTrackMaker, InDet::SiSPSeededTrackFinder, InDet::SiTrackerSpacePointFinder, ISF::SimKernelMT, ITk::StripDigitization, ITkPixelCablingAlg, ITkStripCablingAlg, LArHitEMapMaker, LArTTL1Maker, LUCID_DigiTop, LVL1::L1TopoSimulation, MergeCalibHits, MergeGenericMuonSimHitColl, MergeHijingPars, MergeMcEventCollection, MergeTrackRecordCollection, MergeTruthJets, MergeTruthParticles, MuonDigitizer, PileUpMTAlg, PixelDigitization, RoIBResultToxAOD, SCT_ByteStreamErrorsTestAlg, SCT_CablingCondAlgFromCoraCool, SCT_CablingCondAlgFromText, SCT_ConditionsParameterTestAlg, SCT_ConditionsSummaryTestAlg, SCT_ConfigurationConditionsTestAlg, SCT_Digitization, 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, SGInputLoader, Simulation::BeamEffectsAlg, TileHitVecToCnt, TileMuonFitter, TilePulseForTileMuonReceiver, TileRawChannelMaker, TRTDigitization, and ZDC_DigiTop.

Definition at line 68 of file AthCommonAlgorithm.h.

                                           {
    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 AthCommonAlgorithm< Gaudi::Algorithm >::setFilterPassed	(	bool	state,
		const EventContext &	ctx ) const

inlinevirtualinherited

Set filter decision:

Reimplemented in AthFilterAlgorithm.

Definition at line 99 of file AthCommonAlgorithm.h.

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

◆ sysExecute()

StatusCode AthCommonAlgorithm< 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.

Reimplemented in AthAnalysisAlgorithm.

Definition at line 80 of file AthCommonAlgorithm.cxx.

{
  return BaseAlg::sysExecute (ctx);
}

◆ sysInitialize()

StatusCode AthCommonAlgorithm< 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 AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, HypoBase, InputMakerBase, and PyAthena::Alg.

Definition at line 60 of file AthCommonAlgorithm.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_absECutFortQ

Gaudi::Property<bool> LArOFFCRawChannelBuilder::m_absECutFortQ

private

Initial value:

{

this, "absECut", true, "Cut on fabs(E) for Q and t computation"}

Definition at line 69 of file LArOFFCRawChannelBuilder.h.

69 {

70 this, "absECut", true, "Cut on fabs(E) for Q and t computation"};

◆ m_adc2MeVKey

SG::ReadCondHandleKey<LArADC2MeV> LArOFFCRawChannelBuilder::m_adc2MeVKey

private

Initial value:

{

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

Definition at line 48 of file LArOFFCRawChannelBuilder.h.

48 {

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

◆ m_belowThreshold

Gaudi::Property<double> LArOFFCRawChannelBuilder::m_belowThreshold

private

Initial value:

{
      this, "BelowThreshold", 0,
      "ADC threshold below which samples are treated as noise"}

The OFFC algorithm extends the standard optimal filtering by identifying in-time pulses and subtracting their expected contribution from future samples.

This mitigates out-of-time pileup by iteratively removing pulse shapes that are consistent with the detector response.

The algorithm operates on pedestal-subtracted ADC samples and applies:

an optimal filter convolution,
a local-maximum pulse-finding criterion,
an optional shape-consistency (Q3) quality cut,
and a forward subtraction using the OFC–shape convolution.

The parameters below control noise suppression, pulse acceptance, and the handling of overlapping pulses. ADC threshold below which samples are considered noise. Consecutive samples below this threshold increment a counter used to decide when to reset the forward-subtraction cache.

Definition at line 100 of file LArOFFCRawChannelBuilder.h.

                                        {
      this, "BelowThreshold", 0,
      "ADC threshold below which samples are treated as noise"};

◆ m_belowTillReset

Gaudi::Property<int> LArOFFCRawChannelBuilder::m_belowTillReset

private

Initial value:

{
      this, "BelowTillReset", 0,
      "Number of consecutive noise samples before cache reset"}

Number of consecutive below-threshold samples required before the forward-subtraction cache is reset.

This prevents stale pulse contributions from persisting indefinitely in quiet regions of the readout.

Definition at line 108 of file LArOFFCRawChannelBuilder.h.

                                     {
      this, "BelowTillReset", 0,
      "Number of consecutive noise samples before cache reset"};

◆ m_cablingKey

SG::ReadCondHandleKey<LArOnOffIdMapping> LArOFFCRawChannelBuilder::m_cablingKey

private

Initial value:

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

Definition at line 55 of file LArOFFCRawChannelBuilder.h.

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

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

private

Initial value:

{

this, "LArDigitKey", "FREE", "SG Key of LArDigitContainer"}

Definition at line 36 of file LArOFFCRawChannelBuilder.h.

36 {

37 this, "LArDigitKey", "FREE", "SG Key of LArDigitContainer"};

◆ m_eCutFortQ

Gaudi::Property<float> LArOFFCRawChannelBuilder::m_eCutFortQ

private

Initial value:

{this, "ECutFortQ", 256.0,
                                     "Time and Quality will be computed only "
                                     "for channels with E above this value"}

Definition at line 66 of file LArOFFCRawChannelBuilder.h.

                                  {this, "ECutFortQ", 256.0,
                                     "Time and Quality will be computed only "
                                     "for channels with E above this value"};

◆ 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 AthCommonAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects

privateinherited

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

Empty if no symlinks were found.

Definition at line 108 of file AthCommonAlgorithm.h.

◆ m_filterThreshold

Gaudi::Property<double> LArOFFCRawChannelBuilder::m_filterThreshold

private

Initial value:

{
      this, "FilterThreshold", 0,
      "Minimum filtered amplitude for pulse finding"}

Minimum filtered amplitude required to consider a sample as a pulse peak.

This suppresses spurious pulse finding due to noise fluctuations.

Definition at line 127 of file LArOFFCRawChannelBuilder.h.

                                         {
      this, "FilterThreshold", 0,
      "Minimum filtered amplitude for pulse finding"};

◆ m_firstSample

Gaudi::Property<int> LArOFFCRawChannelBuilder::m_firstSample

private

Initial value:

{
      this, "firstSample", 0,
      "First of the 32 samples of the MC shape to be used"}

Definition at line 76 of file LArOFFCRawChannelBuilder.h.

                                  {
      this, "firstSample", 0,
      "First of the 32 samples of the MC shape to be used"};

◆ m_nPulse

Gaudi::Property<int> LArOFFCRawChannelBuilder::m_nPulse

private

Initial value:

{

this, "NPulse", 0, "Maximum number of overlapping pulses to subtract"}

Maximum number of overlapping pulses that can be tracked simultaneously.

Each accepted pulse occupies a context slot for the duration of the OFC–shape convolution window.

Definition at line 115 of file LArOFFCRawChannelBuilder.h.

115 {

116 this, "NPulse", 0, "Maximum number of overlapping pulses to subtract"};

◆ m_ofcKey

SG::ReadCondHandleKey<ILArOFC> LArOFFCRawChannelBuilder::m_ofcKey

private

Initial value:

{this, "OFCKey", "LArOFC",

"SG Key of OFC conditions object"}

Definition at line 50 of file LArOFFCRawChannelBuilder.h.

50 {this, "OFCKey", "LArOFC",

51 "SG Key of OFC conditions object"};

◆ m_onlineId

const LArOnlineID* LArOFFCRawChannelBuilder::m_onlineId = nullptr

private

Definition at line 132 of file LArOFFCRawChannelBuilder.h.

◆ m_pedestalKey

SG::ReadCondHandleKey<ILArPedestal> LArOFFCRawChannelBuilder::m_pedestalKey

private

Initial value:

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

Definition at line 45 of file LArOFFCRawChannelBuilder.h.

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

◆ m_Q3cut

Gaudi::Property<double> LArOFFCRawChannelBuilder::m_Q3cut

private

Initial value:

{

this, "Q3Cut", 0, "Shape-consistency quality cut for pulse acceptance"}

Quality cut used for pulse acceptance.

Q3 is computed as the sum of absolute residuals between the filtered samples and the expected pulse shape around the peak. Pulses with Q3 below this threshold are accepted and subtracted.

Definition at line 122 of file LArOFFCRawChannelBuilder.h.

122 {

123 this, "Q3Cut", 0, "Shape-consistency quality cut for pulse acceptance"};

◆ m_rawChannelKey

SG::WriteHandleKey<LArRawChannelContainer> LArOFFCRawChannelBuilder::m_rawChannelKey

private

Initial value:

{
      this, "LArRawChannelKey", "LArRawChannels",
      "SG key of the output LArRawChannelContainer"}

Definition at line 40 of file LArOFFCRawChannelBuilder.h.

                                                          {
      this, "LArRawChannelKey", "LArRawChannels",
      "SG key of the output LArRawChannelContainer"};

◆ m_run1DSPThresholdsKey

SG::ReadCondHandleKey<LArDSPThresholdsComplete> LArOFFCRawChannelBuilder::m_run1DSPThresholdsKey

private

Initial value:

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

Definition at line 58 of file LArOFFCRawChannelBuilder.h.

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

◆ m_run2DSPThresholdsKey

SG::ReadCondHandleKey<AthenaAttributeList> LArOFFCRawChannelBuilder::m_run2DSPThresholdsKey

private

Initial value:

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

Definition at line 61 of file LArOFFCRawChannelBuilder.h.

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

◆ m_shapeKey

SG::ReadCondHandleKey<ILArShape> LArOFFCRawChannelBuilder::m_shapeKey

private

Initial value:

{

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

Definition at line 52 of file LArOFFCRawChannelBuilder.h.

52 {

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

◆ m_useDBFortQ

Gaudi::Property<bool> LArOFFCRawChannelBuilder::m_useDBFortQ

private

Initial value:

{this, "useDB", true,

"Use DB for cut on t,Q"}

Definition at line 74 of file LArOFFCRawChannelBuilder.h.

74 {this, "useDB", true,

75 "Use DB for cut on t,Q"};

◆ m_useShapeDer

Gaudi::Property<bool> LArOFFCRawChannelBuilder::m_useShapeDer

private

Initial value:

{
      this, "useShapeDer", true,
      "Use shape derivative in Q-factor computation"}

Definition at line 71 of file LArOFFCRawChannelBuilder.h.

                                   {
      this, "useShapeDer", true,
      "Use shape derivative in Q-factor computation"};

◆ 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

◆ computeOFFC()

◆ convolvePulse()

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

◆ m_adc2MeVKey

◆ m_belowThreshold

◆ m_belowTillReset

◆ m_cablingKey

◆ m_detStore

◆ m_digitKey

◆ m_eCutFortQ

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_filterThreshold

◆ m_firstSample

◆ m_nPulse

◆ m_ofcKey

◆ m_onlineId

◆ m_pedestalKey

◆ m_Q3cut

◆ m_rawChannelKey

◆ m_run1DSPThresholdsKey

◆ m_run2DSPThresholdsKey

◆ m_shapeKey

◆ m_useDBFortQ

◆ m_useShapeDer

◆ m_varHandleArraysDeclared

◆ m_vhka