LArSCL1Maker Class Reference

The aim of this algorithm is the simulation of the LAr analogue Super-Cell sums. More...

#include <LArSCL1Maker.h>

Inheritance diagram for LArSCL1Maker:

Public Member Functions
	LArSCL1Maker (const std::string &name, ISvcLocator *pSvcLocator)
	constructor
	~LArSCL1Maker ()
	destructor
StatusCode	initialize ()
	Read ascii files for auxiliary data (puslse shapes, noise, etc...)
StatusCode	execute (const EventContext &context) const
	Create LArSCL1 object save in TES (2 containers: 1 EM, 1 hadronic)
StatusCode	finalize ()
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
template<class T>
const T *	retrieve (const EventContext &context, const SG::ReadCondHandleKey< T > &handleKey) const
std::vector< float >	computeSignal (const Identifier towerId, const int Ieta, const int specialCase, std::vector< float > visEnergy, const int refTime) const
	initialize hit map
std::vector< float >	computeNoise (const Identifier towerId, const int Ieta, std::vector< float > &inputV)
void	printConditions (const HWIdentifier &hwSC)
	Method to print SuperCell Conditions.
void	ConvertHits2Samples (const EventContext &context, const HWIdentifier &hwSC, CaloGain::CaloGain igain, const std::vector< std::pair< float, float > > &TimeE, std::vector< float > &samples) const
	Method for converting Hits from samples (simplified version of the same method in LarPileUpTool)
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
SG::ReadCondHandleKey< LArOnOffIdMapping >	m_cablingKeySC
SG::ReadCondHandleKey< ILArShape >	m_shapesKey
	Property: Pulse shape (conditions input).
SG::ReadCondHandleKey< ILArfSampl >	m_fracSKey
	Property: Fraction of Energy Sampled (conditions input).
SG::ReadCondHandleKey< ILArPedestal >	m_pedestalSCKey
	Property: Pedestal offset (conditions input).
SG::ReadCondHandleKey< ILArNoise >	m_noiseSCKey
	Property: Electronics Noise (conditions input).
SG::ReadCondHandleKey< LArAutoCorrNoise >	m_autoCorrNoiseSCKey
	Property: AutoCorr Noise (conditions input).
SG::ReadCondHandleKey< LArADC2MeV >	m_adc2mevSCKey
	Property: ADC2MeV conversion (conditions input).
IChronoStatSvc *	m_chronSvc
Gaudi::Property< std::string >	m_randomStreamName
ServiceHandle< IAthRNGSvc >	m_atRndmGenSvc {this, "RndmSvc", "AthRNGSvc", ""}
Gaudi::Property< uint32_t >	m_randomSeedOffset {this, "RandomSeedOffset", 2, ""}
Gaudi::Property< bool >	m_useLegacyRandomSeeds
bool	m_useTriggerTime
	Alorithm property: use trigger time or not.
int	m_BeginRunPriority
	pointer to the TriggerTimeTool
ToolHandle< ICaloSuperCellIDTool >	m_scidtool
const CaloCell_SuperCell_ID *	m_scHelper
	pointer to the offline TT helper
const CaloCell_ID *	m_OflHelper = nullptr
	pointer to the offline id helper
const LArOnline_SuperCellID *	m_OnlSCHelper
	pointer to the online LAr helper
ServiceHandle< IIncidentSvc >	m_incSvc
std::vector< std::vector< float > >	m_autoCorrHec
	auxiliary HEC data: auto-correlation matrix
SG::ReadHandleKey< LArHitEMap >	m_hitMapKey
	hit map
SG::ReadHandleKey< LArDigitContainer >	m_bkgDigitsKey {this, "BkgDigitKey", ""}
	Background Digit Overlay, default key is Bkg_LArDigitSCL2.
SG::WriteHandleKey< LArDigitContainer >	m_sLArDigitsContainerKey
	output Lar Digits SC container
std::vector< std::string >	m_HitContainer
	list of hit containers
std::string	m_SubDetectors
	algorithm property: sub-detectors to be simulated
bool	m_NoiseOnOff
	algorithm property: noise (in all sub-detectors) is on if true
bool	m_PileUp
	algorithm property: pile up or not
bool	m_noEmCalibMode
	algorithm property: no calibration mode for EM towers
bool	m_noHadCalibMode
	algorithm property: no calibration mode for had towers
bool	m_chronoTest
	algorithm property: switch chrono on
unsigned int	m_nSamples
	output number of samples
unsigned int	m_firstSample
	output first samples
std::string	m_saveHitsContainer
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

Static Private Attributes
static const short	s_NBDEPTHS = 4
	number of sampling (in depth)
static const short	s_NBSAMPLES = 7
	number of samples in TTL1s
static const short	s_MAXSAMPLES = 24
	max number of samples in pulse shape
static const short	s_PEAKPOS = 3
	peak position
static const short	s_NBETABINS = 15
	number of eta bins
static const short	s_NBENERGIES = 12
	number of energies at which saturation is described (em)

Detailed Description

The aim of this algorithm is the simulation of the LAr analogue Super-Cell sums.

It includes correct allocation of cells to Super-Cell, pulse profile as a function of time, saturation, appropriate noise addition, pile-up.
The resulting signals are an input to the Preprocessor (which in turn performs digitization, filtering, bunch crossing id., noise suppression,...)
Since it needs hits, the simulation only takes "simul" datasets as input, NOT digitized datasets.

Warning

although the output is not digitized, LArSCL1Maker is part of the digitization simulation.

Author

Denis O. Damazio (BNL)

Definition at line 60 of file LArSCL1Maker.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

LArSCL1Maker()

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

constructor

Definition at line 59 of file LArSCL1Maker.cxx.

    : AthReentrantAlgorithm(name, pSvcLocator)
      //, p_triggerTimeTool()
      ,
      m_scidtool("CaloSuperCellIDTool"),
      m_scHelper(nullptr),
      m_OnlSCHelper(nullptr),
      m_incSvc("IncidentSvc", name) {
  //
  // ........ default values of private data
  //
 
  m_chronSvc = nullptr;
  m_useTriggerTime = false;
  // m_triggerTimeToolName   = "CosmicTriggerTimeTool";
 
  m_BeginRunPriority = 100;
 
  // m_ttSvc                 = 0;
  m_scHelper = nullptr;
 
  m_NoiseOnOff = true;
  m_PileUp = false;
  m_noEmCalibMode = false;
  m_noHadCalibMode = false;
  m_chronoTest = false;
 
  //
  // ........ declare the private data as properties
  //
 
  declareProperty("SubDetectors", m_SubDetectors = "LAr_All");
 
  declareProperty("NoiseOnOff", m_NoiseOnOff);
 
  declareProperty("PileUp", m_PileUp);
  declareProperty("UseTriggerTime", m_useTriggerTime);
  // declareProperty("TriggerTimeTool",p_triggerTimeTool);
 
  declareProperty("FirstSample", m_firstSample = -1);
  declareProperty("NSamples", m_nSamples = 7);
 
  declareProperty("ChronoTest", m_chronoTest);
 
  declareProperty("TruthHitsContainer", m_saveHitsContainer = "",
                  "Specify to save hits");
  //
  return;
}

~LArSCL1Maker()

LArSCL1Maker::~LArSCL1Maker

(

)

destructor

SCL1 Maker destructor

Definition at line 109 of file LArSCL1Maker.cxx.

                            {
 
  return;
}

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

computeNoise()

std::vector< float > LArSCL1Maker::computeNoise ( const Identifier towerId, const int Ieta, std::vector< float > & inputV )

private

computeSignal()

std::vector< float > LArSCL1Maker::computeSignal ( const Identifier towerId, const int Ieta, const int specialCase, std::vector< float > visEnergy, const int refTime ) const

private

initialize hit map

ConvertHits2Samples()

void LArSCL1Maker::ConvertHits2Samples ( const EventContext & context, const HWIdentifier & hwSC, CaloGain::CaloGain igain, const std::vector< std::pair< float, float > > & TimeE, std::vector< float > & samples ) const

private

Method for converting Hits from samples (simplified version of the same method in LarPileUpTool)

Definition at line 473 of file LArSCL1Maker.cxx.

                                     {
  // Converts  hits of a particular LAr cell into energy samples
  // declarations
 
  int nsamples;
  int nsamples_der;
  int i;
  int j;
  float energy;
  float time;
 
  // ........ retrieve data (1/2) ................................
  //
  const auto* shapes = this->retrieve(context, m_shapesKey);
  ILArShape::ShapeRef_t Shape = shapes->Shape(hwSC, igain);
  ILArShape::ShapeRef_t ShapeDer = shapes->ShapeDer(hwSC, igain);
 
  nsamples = Shape.size();
  nsamples_der = ShapeDer.size();
 
  if (nsamples == 0) {
    std::cout << " No samples for cell = " << hwSC << std::endl;
    return;
  }
 
  std::vector<std::pair<float, float> >::const_iterator first = TimeE.begin();
  std::vector<std::pair<float, float> >::const_iterator last = TimeE.end();
  samples.clear();
  samples.assign(m_nSamples, 0);
  // m_firstSample=0;
 
  while (first != last) {
    energy = (*first).first;
    time = (*first).second;
 
    // Atlas like mode where we use 25ns binned pulse shape and derivative to
    // deal with time offsets
    // shift between reference shape and this time
    int ishift = (int)(rint(time * (1. / 25)));
    double dtime = time - 25. * ((double)(ishift));
 
    for (i = 0; i < (int)m_nSamples; i++) {
      j = i - ishift + m_firstSample;
      if (j >= 0 && j < nsamples) {
        if (j < nsamples_der && std::fabs(ShapeDer[j]) < 10.)
          samples[i] += (Shape[j] - ShapeDer[j] * dtime) * energy;
        else
          samples[i] += Shape[j] * energy;
      }
    }
 
    ++first;
  }  // loop over hits
 
  return;
}

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.

{ return m_detStore; }

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.

{ return m_evtStore; }

execute()

StatusCode LArSCL1Maker::execute

(

const EventContext &

context

)

const

Create LArSCL1 object save in TES (2 containers: 1 EM, 1 hadronic)

Definition at line 222 of file LArSCL1Maker.cxx.

                                                                  {
 
  ATH_MSG_DEBUG("Begining of execution");
 
  //
  // ....... fill the LArHitEMap
  //
  SG::ReadHandle<LArHitEMap> hitmap(m_hitMapKey, context);
  const LArHitEMap* hitmapPtr = hitmap.cptr();
 
  bool addBkg(false);
  const LArDigitContainer* bkgDigitsPtr = nullptr;
  std::map<HWIdentifier, size_t> IDtoIndexMap;
  if (!m_bkgDigitsKey.empty()) {
    addBkg = true;
    SG::ReadHandle<LArDigitContainer> bkgDigits(m_bkgDigitsKey, context);
    bkgDigitsPtr = bkgDigits.cptr();
    unsigned int digitCount(0);
    for (const auto* const bkgDigit : *bkgDigitsPtr) {
      IDtoIndexMap.insert({bkgDigit->channelID(), digitCount});
      digitCount++;
    }
    // check size compatibility with first LArDigit
    if ((unsigned int)bkgDigitsPtr->at(0)->nsamples() != m_nSamples) {
      addBkg = false;  // don't add background
      ATH_MSG_INFO(
          "Uncompatible background and signal LArDigit size : Overlay "
          "requested but will not be performed");
    }
  }  // end of check if the Key is empty
  //
  // .....get the trigger time if requested
  //
  // double trigtime=0;
  /*
    if (m_useTriggerTime && !p_triggerTimeTool.empty()) {
       trigtime = p_triggerTimeTool->time();
    }
    ATH_MSG_DEBUG("Trigger time used : " << trigtime);
  */
 
  const auto* fracS = this->retrieve(context, m_fracSKey);
  const auto* pedestal = this->retrieve(context, m_pedestalSCKey);
  const auto* larnoise = this->retrieve(context, m_noiseSCKey);
  const auto* autoCorrNoise = this->retrieve(context, m_autoCorrNoiseSCKey);
  const auto* adc2mev = this->retrieve(context, m_adc2mevSCKey);
 
  SG::WriteHandle<LArDigitContainer> scContainerHandle(m_sLArDigitsContainerKey,
                                                       context);
  auto scContainer = std::make_unique<LArDigitContainer>();
 
  unsigned int nbSC = (unsigned int)m_scHelper->calo_cell_hash_max();
  scContainer->reserve(nbSC);
 
  // .... get SC cabling map
  //
  const LArOnOffIdMapping* cabling = this->retrieve(context, m_cablingKeySC);
  if (!cabling) {
    ATH_MSG_ERROR("Do not have SC cabling map !!!");
    return StatusCode::FAILURE;
  }
 
  /* Disable HIT recording for the moment
     CaloCellContainer *scHitContainer = 0;
     if(m_saveHitsContainer.size()>0) {
        scHitContainer = new CaloCellContainer;
        ATH_CHECK( evtStore()->record(scHitContainer, m_saveHitsContainer) );
     }
  */
 
  //
  // ... initialise vectors for sums of energy in each TT
  //
  ATH_MSG_DEBUG("Max number of LAr Super-Cell= " << nbSC);
 
  std::vector<std::vector<float> >
      sumEnergy;  // inner index = time slot (from 0 to visEvecSize-1)
  std::vector<std::vector<float> >
      sumTime;  // inner index = time slot (from 0 to visEvecSize-1)
  sumEnergy.resize(nbSC);
  sumTime.resize(nbSC);
  std::vector<float> scSumE;
  int scSumEvecSize = 5;
 
  scSumE.reserve(scSumEvecSize);
  std::vector<std::vector<float> > scFloatContainerTmp;
 
  int it = 0;
  int it_end = hitmapPtr->GetNbCells();
  scContainer->reserve(nbSC);  // container ordered by hash
  const std::vector<float> base_vec(0);
  scFloatContainerTmp.assign(nbSC, base_vec);  // container ordered by hash
  std::vector<bool> alreadyThere;
  alreadyThere.resize(nbSC);
  alreadyThere.assign(nbSC, false);
 
  std::vector<float> truthE;
  truthE.resize(nbSC);
  truthE.assign(nbSC, 0);
 
  std::vector<HWIdentifier> hwid;
  hwid.resize(nbSC);
  hwid.assign(nbSC, HWIdentifier(0));
 
  for (unsigned int i = 0; i < m_OnlSCHelper->channelHashMax(); ++i)
    hwid[i] = m_OnlSCHelper->channel_Id(IdentifierHash(i));
 
  // m_nSamples=5;
  std::vector<float> samples;
  samples.resize(m_nSamples);
  std::vector<short> samplesInt;
  samplesInt.reserve(m_nSamples);
  CaloGain::CaloGain scGain = CaloGain::LARHIGHGAIN;
 
  for (; it != it_end; ++it) {
    const LArHitList& hitlist = hitmapPtr->GetCell(it);
    const std::vector<std::pair<float, float> >& timeE = hitlist.getData();
    if (!timeE.empty()) {
      Identifier cellId = m_OflHelper->cell_id(IdentifierHash(it));
      Identifier scId = m_scidtool->offlineToSuperCellID(cellId);
      IdentifierHash scHash = m_scHelper->calo_cell_hash(scId);
      if (scHash.value() == 999999)
        continue;
      HWIdentifier hwSC = cabling->createSignalChannelID(scId);
      IdentifierHash scHWHash = m_OnlSCHelper->channel_Hash(hwSC);
 
      hwid[scHWHash] = hwSC;
 
      float factor = 1.0;
      if ((adc2mev->ADC2MEV(hwSC, scGain)).size() < 2) {
        continue;
      }
      factor = (adc2mev->ADC2MEV(hwSC, scGain))[1];
      factor = 1.0 / fracS->FSAMPL(hwSC) / factor;
 
      ConvertHits2Samples(context, hwSC, scGain, timeE, samples);
 
      std::vector<float>& vec = scFloatContainerTmp.at(scHWHash);
      if (!alreadyThere[scHWHash]) {
        alreadyThere[scHWHash] = true;
        for (unsigned int i = 0; i < samples.size(); i++) {
          vec.push_back(factor * samples[i]);
        }
      } else {
        for (unsigned int i = 0; i < samples.size(); i++) {
          vec[i] += (factor * samples[i]);
        }
      }
    }
  }  // it end
 
  it = 0;
  it_end = nbSC;
  short MAXADC = 4096;  // 12 bits ADC?
  std::vector<float> noise(m_nSamples);
  double Rndm[32];
  std::vector<float> zeroSamp;
  zeroSamp.assign(m_nSamples, 0);  // for empty channels
  ATHRNG::RNGWrapper* rngWrapper =
      m_atRndmGenSvc->getEngine(this, m_randomStreamName);
  ATHRNG::RNGWrapper::SeedingOptionType seedingmode =
      m_useLegacyRandomSeeds ? ATHRNG::RNGWrapper::MC16Seeding
                             : ATHRNG::RNGWrapper::SeedingDefault;
  rngWrapper->setSeedLegacy(m_randomStreamName, context, m_randomSeedOffset,
                            seedingmode);
  CLHEP::HepRandomEngine* rndmEngine = rngWrapper->getEngine(context);
  for (; it != it_end; ++it) {
    std::vector<float>* vecPtr = &zeroSamp;
    if (alreadyThere[it])
      vecPtr = &(scFloatContainerTmp.at(it));
    std::vector<float>& vec = *vecPtr;
 
    const HWIdentifier id = hwid[it];
    if (id == 0) {
      continue;
    }
 
    // Do I have Overlay
    size_t backGroundIdx = 999999;
    if (addBkg && (IDtoIndexMap.find(id) != IDtoIndexMap.end()))
      backGroundIdx = IDtoIndexMap.find(id)->second;
 
    // reset noise
    noise.assign(m_nSamples, 0);
 
    // noise definition
    if (m_NoiseOnOff && (backGroundIdx == 999999)) {
      float SigmaNoise = (larnoise->noise(id, 0));
      int index;
      const std::vector<float>& CorrGen = (autoCorrNoise->autoCorrSqrt(id, 0));
 
      RandGaussZiggurat::shootArray(rndmEngine, static_cast<int>(m_nSamples),
                                    Rndm, 0., 1.);
 
      for (int i = 0; i < (int)m_nSamples; i++) {
        noise[i] = 0.;
        for (int j = 0; j <= i; j++) {
          index = i * m_nSamples + j;
          noise[i] += Rndm[j] * (CorrGen)[index];
        }
        noise[i] = noise[i] * SigmaNoise;
      }
    }
 
    if (backGroundIdx < 999999) {  // bkgDigits exist and have compatible sizes
                                   // assuming compatible sizes, see above
      const std::vector<short>& bkgSamples =
          bkgDigitsPtr->at(backGroundIdx)->samples();
      samplesInt.assign(bkgSamples.begin(), bkgSamples.end());
    } else {
      int ped = pedestal->pedestal(id, 0);  // DB pedestal
      samplesInt.assign(m_nSamples, ped);
    }
    for (unsigned int i = 0; i < vec.size(); i++) {
      samplesInt[i] += rint(vec[i] + noise[i]);
      if (samplesInt[i] >= MAXADC)
        samplesInt[i] = MAXADC - 1;
      if (samplesInt[i] < 0)
        samplesInt[i] = 0;
    }
    LArDigit* dig = new LArDigit(id, scGain, samplesInt);
    scContainer->push_back(dig);
  }
  // record final output container
  ATH_CHECK(scContainerHandle.record(std::move(scContainer)));
 
  if (addBkg)
    IDtoIndexMap.clear();  // clear event
 
  if (m_chronoTest) {
    m_chronSvc->chronoStop("LArSCL1Mk hit loop ");
    m_chronSvc->chronoPrint("LArSCL1Mk hit loop ");
    m_chronSvc->chronoStart("LArSCL1Mk SC loop ");
  }
 
  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();
  }

finalize()

StatusCode LArSCL1Maker::finalize

(

)

Definition at line 460 of file LArSCL1Maker.cxx.

                                  {
 
  ATH_MSG_INFO(" LArSCL1Maker finalize completed successfully");
  m_chronSvc->chronoPrint("LArSCL1Mk hit loop ");
  m_chronSvc->chronoPrint("LArSCL1Mk TT loop ");
 
  return StatusCode::SUCCESS;
}

initialize()

StatusCode LArSCL1Maker::initialize

(

)

Read ascii files for auxiliary data (puslse shapes, noise, etc...)

Definition at line 115 of file LArSCL1Maker.cxx.

                                    {
  // +======================================================================+
  // +                                                                      +
  // + Author ........: Denis O. Damazio                                    +
  // + Creation date .: 18/11/2013                                          +
  // +                                                                      +
  // +======================================================================+
  //
  // ......... declaration
  //
  m_chronSvc = chronoSvc();
 
  ATH_MSG_INFO("***********************************************");
  ATH_MSG_INFO("* Steering options for LArSCL1Maker algorithm *");
  ATH_MSG_INFO("***********************************************");
 
  //
  // ......... print the noise flag
  //
  if (m_NoiseOnOff) {
    ATH_MSG_INFO(
        "Electronic noise will be added in each SC for selected "
        "sub-detectors.");
  } else {
    ATH_MSG_INFO("No electronic noise added.");
  }
 
  //
  // ......... print the pile-up flag
  //
  if (m_PileUp) {
    ATH_MSG_INFO("take events from PileUp service");
  } else {
    ATH_MSG_INFO("no pile up");
  }
 
  //
  // ......... print the trigger time flag
  //
  //  if (m_useTriggerTime) { ATH_MSG_INFO("use Trigger Time service " <<
  //  p_triggerTimeTool.name()); } else { ATH_MSG_INFO("no Trigger Time used");
  //  }
 
  //
  // .........retrieve tool computing trigger time if requested
  //
  if (m_useTriggerTime && m_PileUp) {
    ATH_MSG_INFO(
        " In case of pileup, the trigger time subtraction is done in "
        "PileUpSvc ");
    ATH_MSG_INFO("  => LArSCL1Maker will not apply Trigger Time ");
    m_useTriggerTime = false;
  }
 
  /*
    if (m_useTriggerTime) {
     if( p_triggerTimeTool.retrieve().isFailure() ) {
        ATH_MSG_ERROR("Unable to retrieve trigger time tool. Disabling Trigger
    time"); m_useTriggerTime=false;
     }
    }
  */
 
  //
  // ..... need LAr and CaloIdManager to retrieve all needed helpers
  //
 
  const CaloIdManager* caloMgr;
 
  CHECK(detStore()->retrieve(caloMgr));
  CHECK(detStore()->retrieve(m_OnlSCHelper));
  CHECK(detStore()->retrieve(m_OflHelper, "CaloCell_ID"));
 
  //
  //..... need of course the LVL1 helper
  //
  m_scHelper = caloMgr->getCaloCell_SuperCell_ID();
  if (!m_scHelper) {
    ATH_MSG_ERROR("Could not access CaloCell_SuperCell_ID helper");
    return StatusCode::FAILURE;
  } else {
    ATH_MSG_DEBUG("Successfully accessed CaloCell_SuperCell_ID helper");
  }
 
  // ..... need cabling services, to get channels associated to each SC
  //
 
  CHECK(m_cablingKeySC.initialize());
  CHECK(m_shapesKey.initialize());
  CHECK(m_fracSKey.initialize());
  CHECK(m_pedestalSCKey.initialize());
  CHECK(m_noiseSCKey.initialize());
  CHECK(m_autoCorrNoiseSCKey.initialize());
  CHECK(m_adc2mevSCKey.initialize());
  CHECK(m_scidtool.retrieve());
  CHECK(m_sLArDigitsContainerKey.initialize());
  CHECK(m_hitMapKey.initialize());
  CHECK(m_bkgDigitsKey.initialize(!m_bkgDigitsKey.empty()));
 
  // Incident Service:
  ATH_MSG_DEBUG("Initialization completed successfully");
 
  CHECK(m_atRndmGenSvc.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.

printConditions()

void LArSCL1Maker::printConditions ( const HWIdentifier & hwSC )

private

Method to print SuperCell Conditions.

Definition at line 469 of file LArSCL1Maker.cxx.

                                                        {
  // will keep it for future implementation
}

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

retrieve()

template<class T>

const T * LArSCL1Maker::retrieve ( const EventContext & context, const SG::ReadCondHandleKey< T > & handleKey ) const

inlineprivate

Definition at line 112 of file LArSCL1Maker.h.

                                                                   {
    SG::ReadCondHandle<T> handle(handleKey, context);
    if (not handle.isValid()) {
      ATH_MSG_ERROR("could not retrieve : " << handle.key());
      return nullptr;
    } else
      return handle.cptr();
  }

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_adc2mevSCKey

SG::ReadCondHandleKey<LArADC2MeV> LArSCL1Maker::m_adc2mevSCKey

private

Initial value:

{
      this, "LArADC2MeVKey", "LArADC2MeVSC", "SGKey of LArADC2MeV object"}

Property: ADC2MeV conversion (conditions input).

Definition at line 108 of file LArSCL1Maker.h.

                                                {
      this, "LArADC2MeVKey", "LArADC2MeVSC", "SGKey of LArADC2MeV object"};

m_atRndmGenSvc

ServiceHandle<IAthRNGSvc> LArSCL1Maker::m_atRndmGenSvc {this, "RndmSvc", "AthRNGSvc", ""}

private

Definition at line 153 of file LArSCL1Maker.h.

{this, "RndmSvc", "AthRNGSvc", ""};

m_autoCorrHec

std::vector<std::vector<float> > LArSCL1Maker::m_autoCorrHec

private

auxiliary HEC data: auto-correlation matrix

Definition at line 190 of file LArSCL1Maker.h.

m_autoCorrNoiseSCKey

SG::ReadCondHandleKey<LArAutoCorrNoise> LArSCL1Maker::m_autoCorrNoiseSCKey

private

Initial value:

{
      this, "LArAutoCorrKey", "LArAutoCorrNoiseSC",
      "SGKey of LArAutoCorrNoise object"}

Property: AutoCorr Noise (conditions input).

Definition at line 103 of file LArSCL1Maker.h.

                                                            {
      this, "LArAutoCorrKey", "LArAutoCorrNoiseSC",
      "SGKey of LArAutoCorrNoise object"};

m_BeginRunPriority

int LArSCL1Maker::m_BeginRunPriority

private

pointer to the TriggerTimeTool

Definition at line 164 of file LArSCL1Maker.h.

m_bkgDigitsKey

SG::ReadHandleKey<LArDigitContainer> LArSCL1Maker::m_bkgDigitsKey {this, "BkgDigitKey", ""}

private

Background Digit Overlay, default key is Bkg_LArDigitSCL2.

Definition at line 196 of file LArSCL1Maker.h.

{this, "BkgDigitKey", ""};

m_cablingKeySC

SG::ReadCondHandleKey<LArOnOffIdMapping> LArSCL1Maker::m_cablingKeySC

private

Initial value:

{
      this, "ScCablingKey", "LArOnOffIdMapSC",
      "SG Key of SC LArOnOffIdMapping object"}

Definition at line 83 of file LArSCL1Maker.h.

                                                       {
      this, "ScCablingKey", "LArOnOffIdMapSC",
      "SG Key of SC LArOnOffIdMapping object"};

m_chronoTest

bool LArSCL1Maker::m_chronoTest

private

algorithm property: switch chrono on

Definition at line 227 of file LArSCL1Maker.h.

m_chronSvc

IChronoStatSvc* LArSCL1Maker::m_chronSvc

private

Definition at line 150 of file LArSCL1Maker.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_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

unsigned int LArSCL1Maker::m_firstSample

private

output first samples

Definition at line 232 of file LArSCL1Maker.h.

m_fracSKey

SG::ReadCondHandleKey<ILArfSampl> LArSCL1Maker::m_fracSKey

private

Initial value:

{
      this, "FracSKey", "LArfSamplSC", "SG Key of fSamplS conditions object"}

Property: Fraction of Energy Sampled (conditions input).

Definition at line 91 of file LArSCL1Maker.h.

                                            {
      this, "FracSKey", "LArfSamplSC", "SG Key of fSamplS conditions object"};

m_HitContainer

std::vector<std::string> LArSCL1Maker::m_HitContainer

private

list of hit containers

Definition at line 202 of file LArSCL1Maker.h.

m_hitMapKey

SG::ReadHandleKey<LArHitEMap> LArSCL1Maker::m_hitMapKey

private

Initial value:

{this, "LArHitEMapKey",
                                            "LArHitEMap"}

hit map

Definition at line 193 of file LArSCL1Maker.h.

                                         {this, "LArHitEMapKey",
                                            "LArHitEMap"};

m_incSvc

ServiceHandle<IIncidentSvc> LArSCL1Maker::m_incSvc

private

Definition at line 174 of file LArSCL1Maker.h.

m_noEmCalibMode

bool LArSCL1Maker::m_noEmCalibMode

private

algorithm property: no calibration mode for EM towers

Definition at line 223 of file LArSCL1Maker.h.

m_noHadCalibMode

bool LArSCL1Maker::m_noHadCalibMode

private

algorithm property: no calibration mode for had towers

Definition at line 225 of file LArSCL1Maker.h.

m_NoiseOnOff

bool LArSCL1Maker::m_NoiseOnOff

private

algorithm property: noise (in all sub-detectors) is on if true

Definition at line 219 of file LArSCL1Maker.h.

m_noiseSCKey

SG::ReadCondHandleKey<ILArNoise> LArSCL1Maker::m_noiseSCKey

private

Initial value:

{
      this, "LArNoiseKey", "LArNoiseSC", "SGKey of LArNoise object"}

Property: Electronics Noise (conditions input).

Definition at line 99 of file LArSCL1Maker.h.

                                             {
      this, "LArNoiseKey", "LArNoiseSC", "SGKey of LArNoise object"};

m_nSamples

unsigned int LArSCL1Maker::m_nSamples

private

output number of samples

Definition at line 230 of file LArSCL1Maker.h.

m_OflHelper

const CaloCell_ID* LArSCL1Maker::m_OflHelper = nullptr

private

pointer to the offline id helper

Definition at line 170 of file LArSCL1Maker.h.

m_OnlSCHelper

const LArOnline_SuperCellID* LArSCL1Maker::m_OnlSCHelper

private

pointer to the online LAr helper

Definition at line 172 of file LArSCL1Maker.h.

m_pedestalSCKey

SG::ReadCondHandleKey<ILArPedestal> LArSCL1Maker::m_pedestalSCKey

private

Initial value:

{
      this, "PedestalKey", "LArPedestalSC", "SGKey of LArPedestal object"}

Property: Pedestal offset (conditions input).

Definition at line 95 of file LArSCL1Maker.h.

                                                   {
      this, "PedestalKey", "LArPedestalSC", "SGKey of LArPedestal object"};

m_PileUp

bool LArSCL1Maker::m_PileUp

private

algorithm property: pile up or not

Definition at line 221 of file LArSCL1Maker.h.

m_randomSeedOffset

Gaudi::Property<uint32_t> LArSCL1Maker::m_randomSeedOffset {this, "RandomSeedOffset", 2, ""}

private

Definition at line 154 of file LArSCL1Maker.h.

{this, "RandomSeedOffset", 2, ""};

m_randomStreamName

Gaudi::Property<std::string> LArSCL1Maker::m_randomStreamName

private

Initial value:

{this, "RandomStreamName",
                                                  "LArSCL1Maker", ""}

Definition at line 151 of file LArSCL1Maker.h.

                                             {this, "RandomStreamName",
                                                  "LArSCL1Maker", ""};

m_saveHitsContainer

std::string LArSCL1Maker::m_saveHitsContainer

private

Definition at line 234 of file LArSCL1Maker.h.

m_scHelper

const CaloCell_SuperCell_ID* LArSCL1Maker::m_scHelper

private

pointer to the offline TT helper

Definition at line 168 of file LArSCL1Maker.h.

m_scidtool

ToolHandle<ICaloSuperCellIDTool> LArSCL1Maker::m_scidtool

private

Definition at line 166 of file LArSCL1Maker.h.

m_shapesKey

SG::ReadCondHandleKey<ILArShape> LArSCL1Maker::m_shapesKey

private

Initial value:

{
      this, "ShapeKey", "LArShapeSC", "SG Key of Shape conditions object"}

Property: Pulse shape (conditions input).

Definition at line 87 of file LArSCL1Maker.h.

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

m_sLArDigitsContainerKey

SG::WriteHandleKey<LArDigitContainer> LArSCL1Maker::m_sLArDigitsContainerKey

private

Initial value:

{
      this, "SCL1ContainerName", "LArDigitSCL1", "Output LArDigit container"}

output Lar Digits SC container

Definition at line 198 of file LArSCL1Maker.h.

                                                              {
      this, "SCL1ContainerName", "LArDigitSCL1", "Output LArDigit container"};

m_SubDetectors

std::string LArSCL1Maker::m_SubDetectors

private

algorithm property: sub-detectors to be simulated

Definition at line 205 of file LArSCL1Maker.h.

m_useLegacyRandomSeeds

Gaudi::Property<bool> LArSCL1Maker::m_useLegacyRandomSeeds

private

Initial value:

{
      this, "UseLegacyRandomSeeds", false,
      "Use MC16-style random number seeding"}

Definition at line 155 of file LArSCL1Maker.h.

                                            {
      this, "UseLegacyRandomSeeds", false,
      "Use MC16-style random number seeding"};

m_useTriggerTime

bool LArSCL1Maker::m_useTriggerTime

private

Alorithm property: use trigger time or not.

Definition at line 160 of file LArSCL1Maker.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.

s_MAXSAMPLES

const short LArSCL1Maker::s_MAXSAMPLES = 24

staticprivate

max number of samples in pulse shape

Definition at line 181 of file LArSCL1Maker.h.

s_NBDEPTHS

const short LArSCL1Maker::s_NBDEPTHS = 4

staticprivate

number of sampling (in depth)

Definition at line 177 of file LArSCL1Maker.h.

s_NBENERGIES

const short LArSCL1Maker::s_NBENERGIES = 12

staticprivate

number of energies at which saturation is described (em)

Definition at line 187 of file LArSCL1Maker.h.

s_NBETABINS

const short LArSCL1Maker::s_NBETABINS = 15

staticprivate

number of eta bins

Definition at line 185 of file LArSCL1Maker.h.

s_NBSAMPLES

const short LArSCL1Maker::s_NBSAMPLES = 7

staticprivate

number of samples in TTL1s

Definition at line 179 of file LArSCL1Maker.h.

s_PEAKPOS

const short LArSCL1Maker::s_PEAKPOS = 3

staticprivate

peak position

Definition at line 183 of file LArSCL1Maker.h.

---

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

• LArSCL1Maker.h
• LArSCL1Maker.cxx