MuonCalibR4::MdtAnalyticRtCalibAlg Class Reference

#include <MdtAnalyticRtCalibAlg.h>

Inheritance diagram for MuonCalibR4::MdtAnalyticRtCalibAlg:

Collaboration diagram for MuonCalibR4::MdtAnalyticRtCalibAlg:

Public Types
enum class	PolyType { ChebyChev , Legendre , Simple }
using	RtRelationPtr = MuonCalib::MdtFullCalibData::RtRelationPtr

Public Member Functions
virtual	~MdtAnalyticRtCalibAlg ()=default
virtual StatusCode	initialize () override final
virtual StatusCode	execute (const EventContext &ctx) const override final
virtual bool	isReEntrant () const override
	Avoid scheduling algorithm multiple times.
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
void	drawRt (const EventContext &ctx, const Identifier &detId, const std::vector< MuonCalib::SamplePoint > &rtPoints, const MuonCalib::MdtRtRelation &inRel) const
void	drawResoFunc (const EventContext &ctx, const Identifier &detId, const std::vector< MuonCalib::SamplePoint > &resoPoints, const MuonCalib::IRtResolution &inReso) const
RtRelationPtr	translateRt (const EventContext &ctx, const Identifier &detId, const MuonCalib::MdtRtRelation &inRel) const
	Translates the rt / tr & resolution relation from a look-up table into the requested polynomial type.
std::vector< Identifier >	tubeIds (const Identifier &chId) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
ServiceHandle< Muon::IMuonIdHelperSvc >	m_idHelperSvc {this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"}
ServiceHandle< MuonValR4::IRootVisualizationService >	m_visualSvc {this, "VisualSvc", "MuonValR4::RootVisualizationService"}
	Service handle of the visualization service.
MuonValR4::IRootVisualizationService::ClientToken	m_clientToken {}
	Token to be presented to the visualization service.
SG::ReadCondHandleKey< MuonCalib::MdtCalibDataContainer >	m_readKey {this, "ReadKey", "MdtCalibConstantsR4"}
SG::WriteCondHandleKey< MuonCalib::MdtCalibDataContainer >	m_writeKey
Gaudi::Property< unsigned >	m_maxOrder {this, "maxOrder", 12}
	Maximum order of the polynomial in use.
Gaudi::Property< int >	m_polyTypeRt {this, "PolyTypeRt", Acts::toUnderlying(PolyType::ChebyChev)}
	Toggle the polynomial for the Rt-relation: ChebyChev or Legendre.
Gaudi::Property< int >	m_polyTypeTr {this, "PolyTypeTr", Acts::toUnderlying(PolyType::Legendre)}
	Toggle the polynomial for the Rt-relation: ChebyChev or Legendre.
Gaudi::Property< bool >	m_fitRtReso {this, "FitRtReso", true}
	Toggle whether the resolution shall be also converted into a polynomial.
Gaudi::Property< double >	m_relUncReso {this, "RelUncertOnReso", 0.01}
	Assignment of the relative uncertainty on each resolution data point.
Gaudi::Property< unsigned >	m_maxOrderReso {this, "maxOrderReso", 25}
	Maximal order to use for the resolution.
Gaudi::Property< float >	m_chiCutOff {this,"chi2CutOff", 0.05}
	Stop incrementing the order once the chi2CutOff is reached.
Gaudi::Property< bool >	m_saveDiagnostic {this, "saveDiagnosticHist", true}
	Save diagnostic histograms.
Gaudi::Property< std::string >	m_outStream {this, "OutStream", "MDTANALYTICRTS"}
	StreamName of the diagnostic histograms.
Gaudi::Property< unsigned >	m_precCutOff {this,"precCutOff", 6}
	Precision cut-off to treat two incoming rt-relations as equivalent.
Gaudi::Property< bool >	m_fillMissingCh {this, "fillMissingCh", true}
	At the end of the translation, it's checked whether all channels have been assigned.
Gaudi::Property< float >	m_missingT0 {this, "missingT0", 5.4597301}
	Default t0 constant to use, in case there's.
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 27 of file MdtAnalyticRtCalibAlg.h.

Member Typedef Documentation

RtRelationPtr

using MuonCalibR4::MdtAnalyticRtCalibAlg::RtRelationPtr = MuonCalib::MdtFullCalibData::RtRelationPtr

Definition at line 40 of file MdtAnalyticRtCalibAlg.h.

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Enumeration Documentation

PolyType

enum class MuonCalibR4::MdtAnalyticRtCalibAlg::PolyType

strong

Enumerator
ChebyChev
Legendre
Simple

Definition at line 35 of file MdtAnalyticRtCalibAlg.h.

                           {
            ChebyChev,
            Legendre,
            Simple
        };

Constructor & Destructor Documentation

~MdtAnalyticRtCalibAlg()

virtual MuonCalibR4::MdtAnalyticRtCalibAlg::~MdtAnalyticRtCalibAlg ( )

virtualdefault

Member Function Documentation

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

drawResoFunc()

void MuonCalibR4::MdtAnalyticRtCalibAlg::drawResoFunc ( const EventContext & ctx, const Identifier & detId, const std::vector< MuonCalib::SamplePoint > & resoPoints, const MuonCalib::IRtResolution & inReso ) const

private

Definition at line 306 of file MdtAnalyticRtCalibAlg.cxx.

                                                                               {
 
        const std::string chName = std::format("{:}{:d}{:}{:d}M{:1d}",
                                               m_idHelperSvc->stationNameString(detId),
                                               std::abs(m_idHelperSvc->stationEta(detId)),
                                               m_idHelperSvc->stationEta(detId)> 0? 'A' : 'C',
                                               m_idHelperSvc->stationPhi(detId),
                                               m_idHelperSvc->mdtIdHelper().multilayer(detId));
 
        auto canvas = m_visualSvc->prepareCanvas(ctx, m_clientToken, std::format("RtReso_{:}", chName) );
        canvas->setAxisTitles("drift time [ns]", "#sigma(r_{drift}) [mm]");
        auto dataGraph = std::make_unique<TGraphErrors>();
        for (const SamplePoint& dataPoint : resoPoints) {
            dataGraph->SetPoint(dataGraph->GetN(), dataPoint.x1(), dataPoint.x2());
            dataGraph->SetPointError(dataGraph->GetN()-1, 0., dataPoint.error());
            canvas->expandPad(dataPoint.x1(), dataPoint.x2());
        }
        auto resoGraph = std::make_unique<TGraph>();
        const auto [tLow, tHigh] = interval(resoPoints);
        const auto [resoLow, resoHigh] = minMax(resoPoints);
        canvas->expandPad(tLow, resoLow);
        canvas->expandPad(tHigh, resoHigh);
        double driftTime{tLow};
        while (driftTime <= tHigh) {
            const double evalReso = inReso.resolution(driftTime);
            resoGraph->SetPoint(resoGraph->GetN(), driftTime, evalReso);
            driftTime+=0.5;
        }
        canvas->add(std::move(dataGraph), "P");
        canvas->add(std::move(resoGraph), "C");
 
        const double chi2 = calculateChi2(resoPoints, inReso) / (resoPoints.size() - inReso.nDoF());
        canvas->add(MuonValR4::drawLabel(std::format("{:}, {:}, order: {:1d}  #chi^{{2}}: {:.3f}", chName, inReso.name(), 
                                                        inReso.nDoF(), chi2), 0.2, 0.8));
    } 

drawRt()

void MuonCalibR4::MdtAnalyticRtCalibAlg::drawRt ( const EventContext & ctx, const Identifier & detId, const std::vector< MuonCalib::SamplePoint > & rtPoints, const MuonCalib::MdtRtRelation & inRel ) const

private

Populate the rt & tr relation graphs

Definition at line 244 of file MdtAnalyticRtCalibAlg.cxx.

                                                                         {
        if (!m_saveDiagnostic) {
            return;
        }
        const std::string chName = std::format("{:}{:d}{:}{:d}M{:1d}",
                                               m_idHelperSvc->stationNameString(detId),
                                               std::abs(m_idHelperSvc->stationEta(detId)),
                                               m_idHelperSvc->stationEta(detId)> 0? 'A' : 'C',
                                               m_idHelperSvc->stationPhi(detId),
                                               m_idHelperSvc->mdtIdHelper().multilayer(detId));
        auto canvas = m_visualSvc->prepareCanvas(ctx, m_clientToken, std::format("RtRelation_{:}", chName) );
        canvas->setAxisTitles("drift time [ns]", "drift radius [mm]");
        auto dataGraph = std::make_unique<TGraphErrors>();
        for (const SamplePoint& dataPoint : rtPoints) {
            dataGraph->SetPoint(dataGraph->GetN(), dataPoint.x1(), dataPoint.x2());
            dataGraph->SetPointError(dataGraph->GetN()-1, 0., dataPoint.error());
            canvas->expandPad(dataPoint.x1(), dataPoint.x2());
        }

        auto rtGraph = std::make_unique<TGraph>();
        auto trGraph = std::make_unique<TGraph>();
 
        double driftTime{inRel.rt()->tLower()};
        while (driftTime <= inRel.rt()->tUpper()) {
            const double radius = inRel.rt()->radius(driftTime);
            const double backRadius = std::clamp(radius,inRel.tr()->minRadius(), inRel.tr()->maxRadius());
            const double backTime = inRel.tr()->driftTime(backRadius).value_or(-666.);
            rtGraph->SetPoint(rtGraph->GetN(), driftTime, radius);
            trGraph->SetPoint(trGraph->GetN(), backTime, radius);
            canvas->expandPad(driftTime, radius);
            canvas->expandPad(backTime, radius);
            driftTime+=1.;
        }
       
        const unsigned rtNDoF= rtPoints.size() - inRel.rt()->nDoF();
        const unsigned trNDoF= rtPoints.size() - inRel.tr()->nDoF();
        const double rtChi2 = calculateChi2(rtPoints, *inRel.rt())/ rtNDoF;
        const double trChi2 = calculateChi2(swapCoordinates(rtPoints, *inRel.rt()), *inRel.tr())/ trNDoF;
 
        auto legend = std::make_unique<TLegend>(0.2,0.7,0.6, 0.9,chName.c_str());
        legend->SetFillStyle(0);
        legend->SetBorderSize(0);
        legend->AddEntry(rtGraph.get(),std::format("{:}, order: {:d}, #chi^{{2}}: {:.3f}({:d})",
                                                        inRel.rt()->name(), inRel.rt()->nDoF(), rtChi2, rtNDoF).c_str(),"L");
 
        legend->AddEntry(trGraph.get(),std::format("{:}, order: {:d}, #chi^{{2}}: {:.3f}({:d})",
                                                        inRel.tr()->name(), inRel.tr()->nDoF(), trChi2, trNDoF).c_str(),"L");
 
        dataGraph->SetMarkerSize(0);
        rtGraph->SetLineColor(kRed);
        trGraph->SetLineColor(kBlue);
 
        canvas->add(std::move(dataGraph), "P");
        canvas->add(std::move(rtGraph), "C");
        canvas->add(std::move(trGraph), "C");
        canvas->add(std::move(legend));
    }

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

finaloverridevirtual

Setup the conditions handle to convert the calibration constants

Output conditions object

Start the loop

Check whether all tubes are complete

Copy the calibration constants for T0 & the corrections

Definition at line 39 of file MdtAnalyticRtCalibAlg.cxx.

                                                                           {
      SG::WriteCondHandle writeHandle{m_writeKey, ctx};
      if(writeHandle.isValid()) {
          ATH_MSG_DEBUG("CondHandle " << writeHandle.fullKey() << " is already valid.");
          return StatusCode::SUCCESS;
      }
      SG::ReadCondHandle readHandle{m_readKey, ctx};
      ATH_CHECK(readHandle.isValid());
      writeHandle.addDependency(readHandle);
      auto writeCdo = std::make_unique<MdtCalibDataContainer>(m_idHelperSvc.get(), readHandle->granularity());
      const MdtIdHelper& idHelper{m_idHelperSvc->mdtIdHelper()};
      std::map<RtRelationPtr, RtRelationPtr, CalibParamSorter> translatedRts{CalibParamSorter{std::pow(0.1, m_precCutOff)}};
      
      RtRelationPtr dummyFillerRt{};
      MdtFullCalibData::CorrectionPtr dummyFillerCorr{};
      std::unordered_set<Identifier> missedElements{};
      for (auto itr = idHelper.detectorElement_begin(); itr != idHelper.detectorElement_end(); ++itr){
          const Identifier& detId{*itr};
          if (!readHandle->hasDataForChannel(detId, msgStream())){
              ATH_MSG_VERBOSE("There's no calibration data available for "<<m_idHelperSvc->toStringDetEl(detId));
              missedElements.insert(detId);
              continue;
          }
          const MdtFullCalibData* copyMe = readHandle->getCalibData(detId, msgStream());
          
          if (copyMe->corrections && !writeCdo->storeData(detId, copyMe->corrections, msgStream())) {
            return StatusCode::FAILURE;
          }
          const std::vector<Identifier> tubes = tubeIds(detId);
          if (std::ranges::none_of(tubes, [copyMe](const Identifier& tubeId){
                return !copyMe->tubeCalib->getCalib(tubeId);
          })) {
            if (!writeCdo->storeData(detId, copyMe->tubeCalib, msgStream())) {
                return StatusCode::FAILURE;
            }
          } else {
            ATH_MSG_VERBOSE("Tube calibration constants invalid for: "<<m_idHelperSvc->toStringDetEl(detId));
            missedElements.insert(detId);
          }
 
          RtRelationPtr& translated = translatedRts[copyMe->rtRelation];
          if (!translated) {
              translated = translateRt(ctx, detId, *copyMe->rtRelation);
          }
          if (!dummyFillerRt) {
            dummyFillerRt = translated;
            dummyFillerCorr = copyMe->corrections;
          }
          if (!writeCdo->storeData(detId, translated, msgStream())) {
            ATH_MSG_FATAL("Failed to store rt relation for "<<m_idHelperSvc->toStringDetEl(detId));
            return StatusCode::FAILURE;
          }
      }
      if (!m_fillMissingCh) {
        missedElements.clear();
      }
      for (const Identifier& detId: missedElements) {
        ATH_MSG_WARNING("Initial container did not contain any constants for "<<m_idHelperSvc->toString(detId)
                        <<". Insert instead the first translated rt-relation for those channels");
        const bool fillRt = !writeCdo->hasDataForChannel(detId, msgStream()) || 
                            !writeCdo->getCalibData(detId, msgStream())->rtRelation;
        if(fillRt) {
            if (!writeCdo->storeData(detId, dummyFillerRt, msgStream())) {
                ATH_MSG_FATAL("Failed to store rt relation for "<<m_idHelperSvc->toStringDetEl(detId));
                return StatusCode::FAILURE;
            }
            if (dummyFillerCorr && !writeCdo->storeData(detId, dummyFillerCorr, msgStream())) {
                return StatusCode::FAILURE;
            }
        }
        if (writeCdo->getCalibData(detId, msgStream())->tubeCalib) {
            continue;
        }
        MdtCalibDataContainer::TubeContainerPtr dummyT0cont = std::make_unique<MdtTubeCalibContainer>(m_idHelperSvc.get(), detId);
        MdtTubeCalibContainer::SingleTubeCalib dummyT0Calib{};
        dummyT0Calib.t0 = m_missingT0;
        for (const Identifier& tubeId : tubeIds(detId)) {
            if (!dummyT0cont->setCalib(dummyT0Calib, tubeId, msgStream())) {
                return StatusCode::FAILURE;
            } 
        }
        if (!writeCdo->storeData(detId, std::move(dummyT0cont), msgStream())) {
            return StatusCode::FAILURE;
        }
      }
      ATH_CHECK(writeHandle.record(std::move(writeCdo)));
      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 MuonCalibR4::MdtAnalyticRtCalibAlg::initialize ( )

finaloverridevirtual

Definition at line 27 of file MdtAnalyticRtCalibAlg.cxx.

                                                 {
        ATH_CHECK(m_idHelperSvc.retrieve());
        ATH_CHECK(m_readKey.initialize());
        ATH_CHECK(m_writeKey.initialize());
        if (m_saveDiagnostic) {
            ATH_CHECK(m_visualSvc.retrieve());
            m_clientToken.canvasLimit = -1;
            m_clientToken.preFixName = "AnalyticMdtCalib";
            ATH_CHECK(m_visualSvc->registerClient(m_clientToken));
       }
       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;
  }

isReEntrant()

virtual bool AthCondAlgorithm::isReEntrant ( ) const

inlineoverridevirtualinherited

Avoid scheduling algorithm multiple times.

With multiple concurrent events, conditions objects often expire simultaneously for all slots. To avoid that the scheduler runs the CondAlg in each slot, we declare it as "non-reentrant". This ensures that the conditions objects are only created once.

In case a particular CondAlg should behave differently, it can override this method again and return true.

See also

ATEAM-836

Definition at line 39 of file AthCondAlgorithm.h.

{ return false; }

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.

translateRt()

MdtAnalyticRtCalibAlg::RtRelationPtr MuonCalibR4::MdtAnalyticRtCalibAlg::translateRt ( const EventContext & ctx, const Identifier & detId, const MuonCalib::MdtRtRelation & inRel ) const

private

Translates the rt / tr & resolution relation from a look-up table into the requested polynomial type.

If translation fails, a nullptr is returned

Parameters

ctx	EventContext mainly used for visualization
detId	Identifier of the associated Mdt multilayer (visualization)
inRel	Pointer to the input rt relation to translate

Reject bad fits

Definition at line 147 of file MdtAnalyticRtCalibAlg.cxx.

                                                                             {
        
        const std::vector<SamplePoint> rtPoints = fetchDataPoints(*inRel.rt(), *inRel.rtRes());
        IRtRelationPtr rt{};
        ITrRelationPtr tr{};
        unsigned int order{0};
        while (order++ <= m_maxOrder && !rt) {
            ATH_MSG_DEBUG("Attempt to fit rt relation for "<<m_idHelperSvc->toStringDetEl(detId)
                        <<" using a polynomial of order  "<<order);
            switch(m_polyTypeRt) {
                case toUnderlying(PolyType::ChebyChev):
                    rt = RtFromPoints::getRtChebyshev(rtPoints, order);
                    break;
                case toUnderlying(PolyType::Legendre): 
                    rt = RtFromPoints::getRtLegendre(rtPoints, order);
                    break;
                case toUnderlying(PolyType::Simple): 
                    rt = RtFromPoints::getRtSimplePoly(rtPoints, order);
                    break;
                default:
                    break;
            }
            const unsigned rtNdoF = rtPoints.size() - rt->nDoF();
            const double rtChi2 = calculateChi2(rtPoints, *rt) / rtNdoF;
            ATH_MSG_VERBOSE("Fit has a chi2 of "<<rtChi2<<". Cut off at "<<m_chiCutOff);
            if (rtChi2  > m_chiCutOff) {
                rt.reset();
            }
        }
        if (!rt) {
            ATH_MSG_ERROR("Failed to fit rt relation for "<<m_idHelperSvc->toStringDetEl(detId));
            return nullptr;
        }
        const std::vector<SamplePoint> trPoints = swapCoordinates(rtPoints, *rt);
        order = 0;
        while (order++ <= m_maxOrder && !tr) {
            ATH_MSG_DEBUG("Now continue with tr fit for "<<m_idHelperSvc->toStringDetEl(detId)
                        <<" using a polynomial of order  "<<order);
            switch(m_polyTypeTr) {
                case toUnderlying(PolyType::Legendre): 
                    tr = RtFromPoints::getTrLegendre(trPoints, order);
                    break;
                case toUnderlying(PolyType::ChebyChev):
                    tr = RtFromPoints::getTrChebyshev(trPoints, order);
                    break;
                case toUnderlying(PolyType::Simple): 
                    tr = RtFromPoints::getTrSimplePoly(trPoints, order);
                    break;
                default:
                    break;
            }
            const unsigned trNdoF = rtPoints.size() - tr->nDoF();
            const double trChi2 = calculateChi2(trPoints, *tr) / trNdoF; 
            ATH_MSG_VERBOSE("T-R fit resulted in a chi2/nDoF for tr: "<<trChi2<<" ("<<trNdoF<<")");
            if (trChi2 > m_chiCutOff) {
                tr.reset();
            }
        }        
        if (!tr) {
            ATH_MSG_FATAL("Failed to fit tr relation for "<<m_idHelperSvc->toStringDetEl(detId));
            return nullptr;
        }
        auto rtReso = inRel.smartReso();
        if (m_fitRtReso) {
            std::unique_ptr<IRtResolution> fittedReso{};
            std::vector<SamplePoint> rtResoPoints = fetchResolution(rtPoints, m_relUncReso);
            order = 0;
            while (order++ <= m_maxOrderReso && !fittedReso) {
                ATH_MSG_VERBOSE("Finally fit the resolution function "<<m_idHelperSvc->toStringDetEl(detId)
                        <<" using a polynomial of order  "<<order);
                fittedReso = RtFromPoints::getResoChebyshev(rtPoints, rt, m_relUncReso, order);
                const unsigned nDoF = rtResoPoints.size() - fittedReso->nDoF();
                const double chi2 = calculateChi2(rtResoPoints, *fittedReso) / nDoF;
                ATH_MSG_VERBOSE("Fit has a chi2 of "<<chi2<<". Cut off at "<<m_chiCutOff);
                if (chi2  > m_chiCutOff) {
                    if (order == m_maxOrderReso) {
                        drawResoFunc(ctx, detId, rtResoPoints, *fittedReso);
                    }
                    fittedReso.reset();
                }
            }
 
            if (fittedReso) {
                drawResoFunc(ctx, detId, rtResoPoints, *fittedReso);
                rtReso = std::move(fittedReso);
            } else {
                ATH_MSG_WARNING("Despite of having a "<<m_maxOrderReso
                            <<" no rt resolution function could be fitted for "<<m_idHelperSvc->toStringDetEl(detId));
            }
        }
        auto finalRt = std::make_unique<MdtRtRelation>(std::move(rt), rtReso, std::move(tr)); 
        drawRt(ctx, detId, rtPoints, *finalRt);
        return finalRt;
    }

tubeIds()

std::vector< Identifier > MuonCalibR4::MdtAnalyticRtCalibAlg::tubeIds ( const Identifier & chId ) const

private

Definition at line 132 of file MdtAnalyticRtCalibAlg.cxx.

                                                                                     {
        std::vector<Identifier> tubes{};
         const MdtIdHelper& idHelper{m_idHelperSvc->mdtIdHelper()};
        for (int ml = 1; ml <= idHelper.multilayerMax(chId); ++ml) {
            const Identifier detId = idHelper.multilayerID(chId, ml);
            for (int layer = 1; layer <= idHelper.tubeLayerMax(detId); ++layer) {
                for (int tube = 1; tube <= idHelper.tubeMax(detId); ++tube) {
                    tubes.emplace_back(idHelper.channelID(detId, ml, layer, tube));
                }
            }
        }
        return tubes;
    }

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_chiCutOff

Gaudi::Property<float> MuonCalibR4::MdtAnalyticRtCalibAlg::m_chiCutOff {this,"chi2CutOff", 0.05}

private

Stop incrementing the order once the chi2CutOff is reached.

Definition at line 89 of file MdtAnalyticRtCalibAlg.h.

{this,"chi2CutOff", 0.05};

m_clientToken

MuonValR4::IRootVisualizationService::ClientToken MuonCalibR4::MdtAnalyticRtCalibAlg::m_clientToken {}

private

Token to be presented to the visualization service.

Definition at line 70 of file MdtAnalyticRtCalibAlg.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 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_fillMissingCh

Gaudi::Property<bool> MuonCalibR4::MdtAnalyticRtCalibAlg::m_fillMissingCh {this, "fillMissingCh", true}

private

At the end of the translation, it's checked whether all channels have been assigned.

Definition at line 98 of file MdtAnalyticRtCalibAlg.h.

{this, "fillMissingCh", true};

m_fitRtReso

Gaudi::Property<bool> MuonCalibR4::MdtAnalyticRtCalibAlg::m_fitRtReso {this, "FitRtReso", true}

private

Toggle whether the resolution shall be also converted into a polynomial.

Definition at line 83 of file MdtAnalyticRtCalibAlg.h.

{this, "FitRtReso", true};

m_idHelperSvc

ServiceHandle<Muon::IMuonIdHelperSvc> MuonCalibR4::MdtAnalyticRtCalibAlg::m_idHelperSvc {this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"}

private

Definition at line 66 of file MdtAnalyticRtCalibAlg.h.

{this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"};

m_maxOrder

Gaudi::Property<unsigned> MuonCalibR4::MdtAnalyticRtCalibAlg::m_maxOrder {this, "maxOrder", 12}

private

Maximum order of the polynomial in use.

Definition at line 77 of file MdtAnalyticRtCalibAlg.h.

{this, "maxOrder", 12};

m_maxOrderReso

Gaudi::Property<unsigned> MuonCalibR4::MdtAnalyticRtCalibAlg::m_maxOrderReso {this, "maxOrderReso", 25}

private

Maximal order to use for the resolution.

Definition at line 87 of file MdtAnalyticRtCalibAlg.h.

{this, "maxOrderReso", 25};

m_missingT0

Gaudi::Property<float> MuonCalibR4::MdtAnalyticRtCalibAlg::m_missingT0 {this, "missingT0", 5.4597301}

private

Default t0 constant to use, in case there's.

Definition at line 100 of file MdtAnalyticRtCalibAlg.h.

{this, "missingT0", 5.4597301};

m_outStream

Gaudi::Property<std::string> MuonCalibR4::MdtAnalyticRtCalibAlg::m_outStream {this, "OutStream", "MDTANALYTICRTS"}

private

StreamName of the diagnostic histograms.

Definition at line 94 of file MdtAnalyticRtCalibAlg.h.

{this, "OutStream", "MDTANALYTICRTS"};

m_polyTypeRt

Gaudi::Property<int> MuonCalibR4::MdtAnalyticRtCalibAlg::m_polyTypeRt {this, "PolyTypeRt", Acts::toUnderlying(PolyType::ChebyChev)}

private

Toggle the polynomial for the Rt-relation: ChebyChev or Legendre.

Definition at line 79 of file MdtAnalyticRtCalibAlg.h.

{this, "PolyTypeRt", Acts::toUnderlying(PolyType::ChebyChev)};

m_polyTypeTr

Gaudi::Property<int> MuonCalibR4::MdtAnalyticRtCalibAlg::m_polyTypeTr {this, "PolyTypeTr", Acts::toUnderlying(PolyType::Legendre)}

private

Toggle the polynomial for the Rt-relation: ChebyChev or Legendre.

Definition at line 81 of file MdtAnalyticRtCalibAlg.h.

{this, "PolyTypeTr", Acts::toUnderlying(PolyType::Legendre)};

m_precCutOff

Gaudi::Property<unsigned> MuonCalibR4::MdtAnalyticRtCalibAlg::m_precCutOff {this,"precCutOff", 6}

private

Precision cut-off to treat two incoming rt-relations as equivalent.

Definition at line 96 of file MdtAnalyticRtCalibAlg.h.

{this,"precCutOff", 6};

m_readKey

SG::ReadCondHandleKey<MuonCalib::MdtCalibDataContainer> MuonCalibR4::MdtAnalyticRtCalibAlg::m_readKey {this, "ReadKey", "MdtCalibConstantsR4"}

private

Definition at line 72 of file MdtAnalyticRtCalibAlg.h.

{this, "ReadKey", "MdtCalibConstantsR4"};

m_relUncReso

Gaudi::Property<double> MuonCalibR4::MdtAnalyticRtCalibAlg::m_relUncReso {this, "RelUncertOnReso", 0.01}

private

Assignment of the relative uncertainty on each resolution data point.

Definition at line 85 of file MdtAnalyticRtCalibAlg.h.

{this, "RelUncertOnReso", 0.01};

m_saveDiagnostic

Gaudi::Property<bool> MuonCalibR4::MdtAnalyticRtCalibAlg::m_saveDiagnostic {this, "saveDiagnosticHist", true}

private

Save diagnostic histograms.

Definition at line 92 of file MdtAnalyticRtCalibAlg.h.

{this, "saveDiagnosticHist", true};

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.

m_visualSvc

ServiceHandle<MuonValR4::IRootVisualizationService> MuonCalibR4::MdtAnalyticRtCalibAlg::m_visualSvc {this, "VisualSvc", "MuonValR4::RootVisualizationService"}

private

Service handle of the visualization service.

Definition at line 68 of file MdtAnalyticRtCalibAlg.h.

{this, "VisualSvc", "MuonValR4::RootVisualizationService"};

m_writeKey

SG::WriteCondHandleKey<MuonCalib::MdtCalibDataContainer> MuonCalibR4::MdtAnalyticRtCalibAlg::m_writeKey

private

Initial value:

{this, "WriteKey", "MdtCalibConstants",
                                                                                            "Conditions object containing the calibrations"}

Definition at line 73 of file MdtAnalyticRtCalibAlg.h.

                                                                         {this, "WriteKey", "MdtCalibConstants",
                                                                                            "Conditions object containing the calibrations"};   

---

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

• MdtAnalyticRtCalibAlg.h
• MdtAnalyticRtCalibAlg.cxx