HGTD::TrackTimeDefAndQualityAlg Class Reference

#include <TrackTimeDefAndQualityAlg.h>

Inheritance diagram for HGTD::TrackTimeDefAndQualityAlg:

Collaboration diagram for HGTD::TrackTimeDefAndQualityAlg:

Classes
struct	Hit
struct	CleaningResult

Public Member Functions
	TrackTimeDefAndQualityAlg (const std::string &name, ISvcLocator *pSvcLocator)
virtual	~TrackTimeDefAndQualityAlg ()
virtual StatusCode	initialize () override final
virtual StatusCode	execute (const EventContext &ctx) const override final
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::pair< float, float >	getRadiusAndZ (const xAOD::TrackParticle &track_particle) const
CleaningResult	runTimeConsistencyCuts (const std::vector< float > &times, const std::vector< char > &has_clusters, const std::vector< int > &hit_classification) const
std::array< Hit, s_hgtd_layers >	getValidHits (const std::vector< float > &times, const std::vector< char > &has_clusters, const std::vector< int > &hit_classification) const
float	calculateChi2 (const std::array< Hit, s_hgtd_layers > &hits) const
	Calculates the chi2 of the hit times given their resolution.
bool	passesDeltaT (const std::array< Hit, s_hgtd_layers > &hits) const
	Checks two hits for time compatibility.
float	meanTime (const std::array< Hit, s_hgtd_layers > &hits) const
	Calculates the arithmetic mean of the valid hit times;.
float	trackTimeResolution (const std::array< Hit, s_hgtd_layers > &hits) const
	Calculates the combined resolution.
short	findLayerWithBadChi2 (std::array< Hit, s_hgtd_layers > hits) const
	Identifies time outliers by finding the layer within which a hit contributes negatively to the overall chi2 value and returns the layer number.
void	setLayerAsInvalid (std::array< Hit, s_hgtd_layers > &hits, short layer) const
	Given a layer number, the hit sitting on this layer is flagged as invalid.
short	getValidPattern (const std::array< Hit, s_hgtd_layers > &hits) const
	Returns the pattern of valid hits in HGTD as a 4-bit bitfield, where a 1 encodes that a valid hit was found, while a 0 means no valid hit found.
bool	lastHitIsOnLastSurface (const xAOD::TrackParticle &track_particle) const
	Checks if the last hit on track was found on a pre-specified set of Pixel and Strip layers close to the HGTD surfaces.
const Trk::TrackParameters *	getLastHitOnTrack (const Trk::Track &track) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
const short	m_recoed_ptrn_sft = 0
const short	m_exp_ptrn_sft = 4
const short	m_comp_ptrn_sft = 8
const short	m_holes_ptrn_sft = 12
const short	m_primes_ptrn_sft = 16
SG::ReadHandleKey< xAOD::TrackParticleContainer >	m_trackParticleContainerKey
SG::ReadDecorHandleKey< xAOD::TrackParticleContainer >	m_layerHasExtensionKey
SG::ReadDecorHandleKey< xAOD::TrackParticleContainer >	m_holesHGTDKey
SG::ReadDecorHandleKey< xAOD::TrackParticleContainer >	m_layerClusterTimeKey
SG::ReadDecorHandleKey< xAOD::TrackParticleContainer >	m_layerClusterTruthClassKey
SG::WriteDecorHandleKey< xAOD::TrackParticleContainer >	m_time_dec_key
SG::WriteDecorHandleKey< xAOD::TrackParticleContainer >	m_time_res_dec_key
SG::WriteDecorHandleKey< xAOD::TrackParticleContainer >	m_hasValidTime_dec_key
SG::WriteDecorHandleKey< xAOD::TrackParticleContainer >	m_summarypattern_dec_key
FloatProperty	m_chi2_threshold
FloatProperty	m_deltat_cut
FloatProperty	m_default_time
FloatProperty	m_default_time_res
BooleanProperty	m_doActs
BooleanProperty	m_doTruth
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 63 of file TrackTimeDefAndQualityAlg.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

TrackTimeDefAndQualityAlg()

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

Definition at line 27 of file TrackTimeDefAndQualityAlg.cxx.

    : AthReentrantAlgorithm(name, pSvcLocator) {}

~TrackTimeDefAndQualityAlg()

virtual HGTD::TrackTimeDefAndQualityAlg::~TrackTimeDefAndQualityAlg ( )

inlinevirtual

Definition at line 75 of file TrackTimeDefAndQualityAlg.h.

{}

Member Function Documentation

calculateChi2()

float HGTD::TrackTimeDefAndQualityAlg::calculateChi2 ( const std::array< Hit, s_hgtd_layers > & hits ) const

private

Calculates the chi2 of the hit times given their resolution.

Parameters

[in]

hits

Array of hits.

Returns

Chi2 value.

Definition at line 257 of file TrackTimeDefAndQualityAlg.cxx.

                                                    {
 
  float mean = meanTime(hits);
 
  float chi2 = 0.;
  for (const auto& hit : hits) {
    if (hit.m_isvalid) {
      chi2 += (hit.m_time - mean) * (hit.m_time - mean) /
              (hit.m_resolution * hit.m_resolution);
    }
  }
  return chi2;
}

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

finaloverridevirtual

Definition at line 49 of file TrackTimeDefAndQualityAlg.cxx.

                                                                           {
 
  const xAOD::TrackParticleContainer* track_particles{nullptr};
  ATH_CHECK(SG::get(track_particles, m_trackParticleContainerKey, ctx));
 
  SG::WriteDecorHandle<xAOD::TrackParticleContainer, float> time_handle(
      m_time_dec_key, ctx);
  SG::WriteDecorHandle<xAOD::TrackParticleContainer, float> timeres_handle(
      m_time_res_dec_key, ctx);
  SG::WriteDecorHandle<xAOD::TrackParticleContainer, uint8_t> hasValidTime_handle(
      m_hasValidTime_dec_key, ctx);
  SG::WriteDecorHandle<xAOD::TrackParticleContainer, uint32_t> summary_handle(
      m_summarypattern_dec_key, ctx);
 
  SG::ReadDecorHandle<xAOD::TrackParticleContainer, std::vector<float>>
    layerClusterTimeHandle(m_layerClusterTimeKey, ctx);
  ATH_CHECK(layerClusterTimeHandle.isValid());
 
  SG::ReadDecorHandle<xAOD::TrackParticleContainer, std::vector<char>>
      layerHasExtensionHandle(m_layerHasExtensionKey, ctx);
  ATH_CHECK(layerHasExtensionHandle.isValid());
 
  static const std::vector<char> s_no_holes(s_hgtd_layers, false);
  std::optional<SG::ReadDecorHandle<xAOD::TrackParticleContainer, std::vector<char>>>
      holesHGTDHandle;
  if (!m_doActs) {
    holesHGTDHandle.emplace(m_holesHGTDKey, ctx);
    ATH_CHECK(holesHGTDHandle->isValid());
  }
 
  static const std::vector<int> s_no_truth(s_hgtd_layers, 0);
  std::optional<SG::ReadDecorHandle<xAOD::TrackParticleContainer, std::vector<int>>>
      layerClusterTruthClass;
  if (m_doTruth) {
    layerClusterTruthClass.emplace(m_layerClusterTruthClassKey, ctx);
    ATH_CHECK(layerClusterTruthClass->isValid());
  }
 
  for (const auto* track_ptkl : *track_particles) {
    // runs the time consistency checks
    // if no hits are found in HGTD, returns a default time
    const std::vector<float>& times = layerClusterTimeHandle(*track_ptkl);
    const std::vector<char>& has_clusters = layerHasExtensionHandle(*track_ptkl);
    const std::vector<int>& hit_classification = m_doTruth ? (*layerClusterTruthClass)(*track_ptkl) : s_no_truth;
    const std::vector<char>& holes_HGTD = m_doActs ? s_no_holes : (*holesHGTDHandle)(*track_ptkl);
 
    CleaningResult res = runTimeConsistencyCuts(times,
                        has_clusters,
                        hit_classification);
 
    // check if the last hit on track was within the predefined area
    if (lastHitIsOnLastSurface(*track_ptkl)) {
      res.m_field |= (0b0000 << m_holes_ptrn_sft);
    } else {
      res.m_field |= (0b0001 << m_holes_ptrn_sft);
    }
    
    // keep which of the hits associated in reco were primary hits (truth info!)
    short prime_pattern = 0x0;
    for (short i = 0; i < s_hgtd_layers; i++) {
      if (res.m_hits.at(i).m_isprime) {
        prime_pattern |= (1 << i);
      }
    }
    res.m_field |= (prime_pattern << m_primes_ptrn_sft);
 
    // expected pattern : 'on which HGTD layer a hit was expected?' which means extrapolation has
    // reached an active sensor, whether a matching cluster was found or not. 
    // So ‘expected = has_cluster OR HGTD_holes’. 
    short expected_pattern = 0x0;
    for (short i = 0; i < s_hgtd_layers; i++) {
      if (has_clusters.at(i) || holes_HGTD.at(i))  {
        expected_pattern |= (1 << i);
      }
    }
    res.m_field |= (expected_pattern << m_exp_ptrn_sft);
 
    // decorate the track again with this info
    time_handle(*track_ptkl) = res.m_time;
    timeres_handle(*track_ptkl) = res.m_resolution;
    hasValidTime_handle(*track_ptkl) = res.m_hasValidTime;
    summary_handle(*track_ptkl) = res.m_field;
  }
  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();
  }

findLayerWithBadChi2()

short HGTD::TrackTimeDefAndQualityAlg::findLayerWithBadChi2 ( std::array< Hit, s_hgtd_layers > hits ) const

private

Identifies time outliers by finding the layer within which a hit contributes negatively to the overall chi2 value and returns the layer number.

Copies the hits, since they have to be invalidated one by one.

Parameters

[in]

hits

Array of hits.

Returns

Layer with outlier time, value between 0 and 3.

Definition at line 323 of file TrackTimeDefAndQualityAlg.cxx.

                                                                      {
  short remove_layer = -1;
  float local_min_chi2 = 999999;
  for (auto& hit : hits) {
    // "turn off" hits one after the other to test their impact on the chi2
    bool validbuff = hit.m_isvalid;
    hit.m_isvalid = false;
    float local_chi2 = calculateChi2(hits);
    hit.m_isvalid = validbuff;
    if (local_chi2 < local_min_chi2) {
      local_min_chi2 = local_chi2;
      remove_layer = hit.m_layer;
    }
  }
  return remove_layer;
}

getLastHitOnTrack()

const Trk::TrackParameters * HGTD::TrackTimeDefAndQualityAlg::getLastHitOnTrack ( const Trk::Track & track ) const

private

Definition at line 352 of file TrackTimeDefAndQualityAlg.cxx.

                                                                        {
 
  const Trk::TrackStates* tsos =
      track.trackStateOnSurfaces();
  if (not tsos) {
    ATH_MSG_ERROR("Failed to retrieve track state on surfaces");
    return nullptr;
  }
  // loop over the associated hits in ITk in reverse order, since we want to
  // select the one closest to HGTD to start the extrapolation
  for (auto i = tsos->rbegin(); i != tsos->rend(); ++i) {
    const auto* curr_last_tsos = *i;
    if (not curr_last_tsos) {
      continue;
    }
    
    if (curr_last_tsos->type(Trk::TrackStateOnSurface::Measurement) and
        curr_last_tsos->trackParameters() and
        curr_last_tsos->measurementOnTrack()) {
      return curr_last_tsos->trackParameters();
    }
  }
  
  return nullptr;
}

getRadiusAndZ()

std::pair< float, float > HGTD::TrackTimeDefAndQualityAlg::getRadiusAndZ ( const xAOD::TrackParticle & track_particle ) const

private

Definition at line 378 of file TrackTimeDefAndQualityAlg.cxx.

{
  float radius = 0.f;
  float abs_z = 0.f;
 
  if (not m_doActs) {
    const Trk::Track* track = track_particle.track();
    if (not track) throw std::runtime_error("Cannot retrieve Trk track from Track Particle");
    const Trk::TrackParameters* last_hit_param = getLastHitOnTrack(*track);
    if (not last_hit_param) throw std::runtime_error("Cannot retrieve Trk track parameters from Trk track");
 
    radius = std::hypot(last_hit_param->position().x(),
            last_hit_param->position().y());
    abs_z = std::abs(last_hit_param->position().z());
  } else {
    // ACTS
    static const SG::ConstAccessor< ElementLink<ActsTrk::TrackContainer> > actsTrackLink("actsTrack");
    if (not actsTrackLink.isAvailable(track_particle)) throw std::runtime_error("Track particle does not have link to acts track");
 
    ElementLink<ActsTrk::TrackContainer> link_to_track = actsTrackLink(track_particle);
    if (not link_to_track.isValid()) throw std::runtime_error("Element link to acts track is not valid");
 
    std::optional<ActsTrk::TrackContainer::ConstTrackProxy> optional_track = *link_to_track;
    if (not optional_track.has_value()) throw std::runtime_error("Link to acts track has no value");
 
    const ActsTrk::TrackContainer::ConstTrackProxy& track = optional_track.value();
    const auto lastMeasurementState = Acts::findLastMeasurementState(track);
    const auto state = lastMeasurementState.value();
 
    const xAOD::UncalibratedMeasurement *cluster = ActsTrk::detail::xAODUncalibMeasCalibrator::unpack(state.getUncalibratedSourceLink());
    xAOD::UncalibMeasType clusterType = cluster->type();
 
    switch (clusterType) {
    case xAOD::UncalibMeasType::PixelClusterType:
      {
        auto glob = static_cast<const xAOD::PixelCluster*>(cluster)->globalPosition();
        radius = glob.perp();
        abs_z = std::abs(glob.z());
      }
      break;
    case xAOD::UncalibMeasType::StripClusterType:
      {
        auto glob = static_cast<const xAOD::StripCluster*>(cluster)->globalPosition();
        radius = glob.perp();
        abs_z = std::abs(glob.z());
      }
      break;
    case xAOD::UncalibMeasType::HGTDClusterType:
      // return some default numbers
      return std::make_pair(700, 3000);
    default:
      return std::make_pair(radius, abs_z);
    }; // switch
  } // acts
 
  return std::make_pair(radius, abs_z);
}

getValidHits()

std::array< TrackTimeDefAndQualityAlg::Hit, s_hgtd_layers > HGTD::TrackTimeDefAndQualityAlg::getValidHits ( const std::vector< float > & times, const std::vector< char > & has_clusters, const std::vector< int > & hit_classification ) const

private

Definition at line 227 of file TrackTimeDefAndQualityAlg.cxx.

                                                                    {
  std::array<Hit, s_hgtd_layers> valid_hits {};
 
  for (size_t i = 0; i < s_hgtd_layers; i++) {
    Hit& newhit = valid_hits[i];
    if (has_clusters.at(i)) {
      newhit.m_time = times.at(i);
      newhit.m_isprime = hit_classification.at(i) == 1;
      newhit.m_isvalid = true;
    }
    newhit.m_layer = i;
  }
 
  return valid_hits;
}

getValidPattern()

short HGTD::TrackTimeDefAndQualityAlg::getValidPattern ( const std::array< Hit, s_hgtd_layers > & hits ) const

private

Returns the pattern of valid hits in HGTD as a 4-bit bitfield, where a 1 encodes that a valid hit was found, while a 0 means no valid hit found.

The LSB carries the hit information for the layer closest to the IP.

Parameters

[in]

hits

Array of hits.

Returns

Bit pattern encoding valid hits in layers.

Definition at line 245 of file TrackTimeDefAndQualityAlg.cxx.

          {
  short pattern = 0x0;
  for (short i = 0; i < s_hgtd_layers; i++) {
    if (hits.at(i).m_isvalid) {
      pattern |= (1 << i);
    }
  }
  return pattern;
}

initialize()

StatusCode HGTD::TrackTimeDefAndQualityAlg::initialize ( )

finaloverridevirtual

Definition at line 31 of file TrackTimeDefAndQualityAlg.cxx.

                                                 {
 
  ATH_CHECK(m_trackParticleContainerKey.initialize());
  ATH_CHECK(m_layerHasExtensionKey.initialize());
  ATH_CHECK(m_holesHGTDKey.initialize(!m_doActs)); //HGTD_holes not produced in ActsHGTDTrackExtensionAlg for now so make it optional
  ATH_CHECK(m_layerClusterTimeKey.initialize());
  ATH_CHECK(m_layerClusterTruthClassKey.initialize(m_doTruth)); //Only initialize if truth information is available
  ATH_CHECK(m_time_dec_key.initialize());
  ATH_CHECK(m_time_res_dec_key.initialize());
  ATH_CHECK(m_hasValidTime_dec_key.initialize());
  ATH_CHECK(m_summarypattern_dec_key.initialize());
 
  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;
  }

lastHitIsOnLastSurface()

bool HGTD::TrackTimeDefAndQualityAlg::lastHitIsOnLastSurface ( const xAOD::TrackParticle & track_particle ) const

private

Checks if the last hit on track was found on a pre-specified set of Pixel and Strip layers close to the HGTD surfaces.

FIXME: should not be hardcoded. To be exchanged by a hole search at a later point.

Parameters

[in]

track_particle

Track reconstructed in ITk.

Returns

True if the last hit on track was within the specified volume.

Definition at line 436 of file TrackTimeDefAndQualityAlg.cxx.

                                                   {
  auto [radius, abs_z] = getRadiusAndZ(track_particle);
 
  if (abs_z > 2700) {
    return true;
  }
  if (radius < 350 and abs_z > 2400) {
    return true;
  }
  // region 2
  if (radius > 205 and radius < 350 and abs_z > 2100) {
    return true;
  }
  // region 3
  if (radius < 220 and abs_z > 2200) {
    return true;
  }
 
  if (radius < 140 and abs_z > 1890) {
    return true;
  }
 
  return false;
}

meanTime()

float HGTD::TrackTimeDefAndQualityAlg::meanTime ( const std::array< Hit, s_hgtd_layers > & hits ) const

private

Calculates the arithmetic mean of the valid hit times;.

Parameters

[in]

hits

Array of hits.

Returns

Returns true if the times were in agreement.

Definition at line 295 of file TrackTimeDefAndQualityAlg.cxx.

          {
  float sum = 0.;
  short n = 0;
  for (const auto& hit : hits) {
    if (hit.m_isvalid) {
      sum += hit.m_time;
      n++;
    }
  }
  return n == 0 ? m_default_time.value() : sum / (float)n;
}

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.

passesDeltaT()

bool HGTD::TrackTimeDefAndQualityAlg::passesDeltaT ( const std::array< Hit, s_hgtd_layers > & hits ) const

private

Checks two hits for time compatibility.

Parameters

[in]

hits

Array of hits.

Returns

Returns true if the times were in agreement.

Definition at line 272 of file TrackTimeDefAndQualityAlg.cxx.

          {
  // don't trust the user here.
  short n_valid = std::count_if(hits.begin(), hits.end(),
                                [](const Hit& hit) { return hit.m_isvalid; });
  if (n_valid != 2) {
    return false;
  }
  // FIXME this should be doable in a simpler manner...
  std::vector<float> times;
  std::vector<float> res;
  for (const auto& hit : hits) {
    if (hit.m_isvalid) {
      times.push_back(hit.m_time);
      res.push_back(hit.m_resolution);
    }
  }
  // pass if the distance in units of the resolution passes the cut
  return std::abs(times.at(0) - times.at(1)) <
         m_deltat_cut * hypot(res.at(0), res.at(1));
}

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

runTimeConsistencyCuts()

TrackTimeDefAndQualityAlg::CleaningResult HGTD::TrackTimeDefAndQualityAlg::runTimeConsistencyCuts ( const std::vector< float > & times, const std::vector< char > & has_clusters, const std::vector< int > & hit_classification ) const

private

Definition at line 139 of file TrackTimeDefAndQualityAlg.cxx.

                                                                          {
  // get all available hits (see the struct Hit) in a first step
  std::array<Hit, s_hgtd_layers> valid_hits = getValidHits(times,
                               has_clusters,
                               hit_classification);
 
  CleaningResult result;
  result.m_hits = valid_hits;
  result.m_field = 0x0;
  result.m_time = m_default_time;
  result.m_resolution = m_default_time_res;
  result.m_hasValidTime = 0;
 
  short recoed_pattern = getValidPattern(valid_hits);
  // stored the pattern of hits as retrieved from the iterative extension
  result.m_field |= (recoed_pattern << m_recoed_ptrn_sft);
 
  short nhits = std::count_if(valid_hits.begin(), valid_hits.end(),
                              [](const Hit& hit) { return hit.m_isvalid; });
  if (nhits < 2) {
    // fill the patern with the 1 hit (or none) and return
    result.m_field |= (recoed_pattern << m_comp_ptrn_sft);
    result.m_time = meanTime(valid_hits);
    result.m_resolution = trackTimeResolution(valid_hits);
    result.m_hasValidTime = recoed_pattern ? 1 : 0;
    return result;
  } else if (nhits == 2) {
    // if the deltaT cut is  passed, the pattern stays the same, otherwise set
    // to 0 as no hit passes
    // TODO: find better way to treat this!
    if (passesDeltaT(valid_hits)) {
      result.m_field |= (recoed_pattern << m_comp_ptrn_sft); // stays the same
      result.m_time = meanTime(valid_hits);
      result.m_resolution = trackTimeResolution(valid_hits);
      result.m_hasValidTime = 1;
      return result;
    } else {
      result.m_field |= (0b0000 << m_comp_ptrn_sft); // no hit passes
      result.m_time = m_default_time; // TODO should I just use the mean?
      result.m_resolution = m_default_time_res;
      return result;
    }
 
  } else {
    // for 3 or 4 hits, remove hit(s) with worst chi2 if needed
    float chi2 = calculateChi2(valid_hits);
    // if the chi2 is below the threshold, keep all hits
    bool searching = chi2 > m_chi2_threshold;
    while (searching) {
      short remove_layer = findLayerWithBadChi2(valid_hits);
      setLayerAsInvalid(valid_hits, remove_layer);
      float new_chi2 = calculateChi2(valid_hits);
      nhits = std::count_if(valid_hits.begin(), valid_hits.end(),
                            [](const Hit& hit) { return hit.m_isvalid; });
      if (new_chi2 <= m_chi2_threshold or nhits < 3) {
        searching = false;
      }
    } // while loop ended
 
    short chi2_rej_pattern = getValidPattern(valid_hits);
 
    if (nhits == 2) {
      if (passesDeltaT(valid_hits)) {
        result.m_field |= (chi2_rej_pattern << m_comp_ptrn_sft);
        result.m_time = meanTime(valid_hits);
        result.m_resolution = trackTimeResolution(valid_hits);
        result.m_hasValidTime = 1;
        return result;
      } else {
        result.m_field |= (0b0000 << m_comp_ptrn_sft); // no hit passes
        result.m_time = m_default_time; // TODO should I just use the mean?
        result.m_resolution = m_default_time_res;
        return result;
      }
    } else {
      // 3 or 4 hits, chi2 passed
      result.m_field |= (chi2_rej_pattern << m_comp_ptrn_sft);
      result.m_time = meanTime(valid_hits);
      result.m_resolution = trackTimeResolution(valid_hits);
      result.m_hasValidTime = 1;
      return result;
    }
  }
}

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

setLayerAsInvalid()

void HGTD::TrackTimeDefAndQualityAlg::setLayerAsInvalid ( std::array< Hit, s_hgtd_layers > & hits, short layer ) const

private

Given a layer number, the hit sitting on this layer is flagged as invalid.

Used for outlier removal.

Parameters

[in]	hits	Array of hits.
[in]	layer	The layer that should be masked.

Definition at line 341 of file TrackTimeDefAndQualityAlg.cxx.

                       {
  for (auto& hit : hits) {
    if (hit.m_layer == layer) {
      hit.m_isvalid = false;
    }
  }
}

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.

trackTimeResolution()

float HGTD::TrackTimeDefAndQualityAlg::trackTimeResolution ( const std::array< Hit, s_hgtd_layers > & hits ) const

private

Calculates the combined resolution.

Definition at line 309 of file TrackTimeDefAndQualityAlg.cxx.

          {
 
  float sum = 0.;
  for (const auto& hit : hits) {
    if (hit.m_isvalid) {
      sum += 1. / (hit.m_resolution * hit.m_resolution);
    }
  }
  return sum == 0. ? m_default_time_res.value()
                   : static_cast<float>(std::sqrt(1. / sum));
}

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_chi2_threshold

FloatProperty HGTD::TrackTimeDefAndQualityAlg::m_chi2_threshold

private

Initial value:

{
      this, "Chi2Threshold", 1.5,
      "Quality cut for decision to keep hits compatible in time"}

Definition at line 131 of file TrackTimeDefAndQualityAlg.h.

                                {
      this, "Chi2Threshold", 1.5,
      "Quality cut for decision to keep hits compatible in time"};

m_comp_ptrn_sft

const short HGTD::TrackTimeDefAndQualityAlg::m_comp_ptrn_sft = 8

private

Definition at line 69 of file TrackTimeDefAndQualityAlg.h.

m_default_time

FloatProperty HGTD::TrackTimeDefAndQualityAlg::m_default_time

private

Initial value:

{
      this, "DefaultTime", 0.0,
      "Default time used for tracks without HGTD timing info"}

Definition at line 137 of file TrackTimeDefAndQualityAlg.h.

                              {
      this, "DefaultTime", 0.0,
      "Default time used for tracks without HGTD timing info"};

m_default_time_res

FloatProperty HGTD::TrackTimeDefAndQualityAlg::m_default_time_res

private

Initial value:

{
      this, "DefaultTimeRes", 50. / std::sqrt(12.),
      "Default time resolution used for tracks without HGTD timing info"}

Definition at line 142 of file TrackTimeDefAndQualityAlg.h.

                                  {
      this, "DefaultTimeRes", 50. / std::sqrt(12.),
      "Default time resolution used for tracks without HGTD timing info"};

m_deltat_cut

FloatProperty HGTD::TrackTimeDefAndQualityAlg::m_deltat_cut

private

Initial value:

{this, "DeltaTCut", 2.0,
                             "Upper limit for a cluster delta t cut"}

Definition at line 134 of file TrackTimeDefAndQualityAlg.h.

                            {this, "DeltaTCut", 2.0,
                             "Upper limit for a cluster delta t cut"};

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_doActs

BooleanProperty HGTD::TrackTimeDefAndQualityAlg::m_doActs

private

Initial value:

{this, "doActs", false,
      "Use ACTS track representation for last-hit extraction"}

Definition at line 146 of file TrackTimeDefAndQualityAlg.h.

                          {this, "doActs", false,
      "Use ACTS track representation for last-hit extraction"};

m_doTruth

BooleanProperty HGTD::TrackTimeDefAndQualityAlg::m_doTruth

private

Initial value:

{this, "doTruth", false,
    "Use Truth information"}

Definition at line 149 of file TrackTimeDefAndQualityAlg.h.

                           {this, "doTruth", false,
    "Use Truth information"};

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_exp_ptrn_sft

const short HGTD::TrackTimeDefAndQualityAlg::m_exp_ptrn_sft = 4

private

Definition at line 68 of file TrackTimeDefAndQualityAlg.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_hasValidTime_dec_key

SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> HGTD::TrackTimeDefAndQualityAlg::m_hasValidTime_dec_key

private

Initial value:

{
    this, "hasValidTime", m_trackParticleContainerKey, "hasValidTime", "Time assigned to this track is valid"}

Definition at line 106 of file TrackTimeDefAndQualityAlg.h.

                                                                          {
    this, "hasValidTime", m_trackParticleContainerKey, "hasValidTime", "Time assigned to this track is valid"};

m_holes_ptrn_sft

const short HGTD::TrackTimeDefAndQualityAlg::m_holes_ptrn_sft = 12

private

Definition at line 70 of file TrackTimeDefAndQualityAlg.h.

m_holesHGTDKey

SG::ReadDecorHandleKey<xAOD::TrackParticleContainer> HGTD::TrackTimeDefAndQualityAlg::m_holesHGTDKey

private

Initial value:

{
    this, "HGTD_holes", m_trackParticleContainerKey, "HGTD_holes",
      "deco with a handle for HGTD holes"}

Definition at line 89 of file TrackTimeDefAndQualityAlg.h.

                                                                 {
    this, "HGTD_holes", m_trackParticleContainerKey, "HGTD_holes",
      "deco with a handle for HGTD holes"};

m_layerClusterTimeKey

SG::ReadDecorHandleKey<xAOD::TrackParticleContainer> HGTD::TrackTimeDefAndQualityAlg::m_layerClusterTimeKey

private

Initial value:

{
    this, "HGTD_cluster_time", m_trackParticleContainerKey, "HGTD_cluster_time",
      "deco with a handle for cluster time"}

Definition at line 92 of file TrackTimeDefAndQualityAlg.h.

                                                                        {
    this, "HGTD_cluster_time", m_trackParticleContainerKey, "HGTD_cluster_time",
      "deco with a handle for cluster time"};

m_layerClusterTruthClassKey

SG::ReadDecorHandleKey<xAOD::TrackParticleContainer> HGTD::TrackTimeDefAndQualityAlg::m_layerClusterTruthClassKey

private

Initial value:

{
    this, "HGTD_cluster_truth_class", m_trackParticleContainerKey,
          "HGTD_cluster_truth_class",
          "deco with a handle for a truth time"}

Definition at line 96 of file TrackTimeDefAndQualityAlg.h.

                                 {
    this, "HGTD_cluster_truth_class", m_trackParticleContainerKey,
          "HGTD_cluster_truth_class",
          "deco with a handle for a truth time"};

m_layerHasExtensionKey

SG::ReadDecorHandleKey<xAOD::TrackParticleContainer> HGTD::TrackTimeDefAndQualityAlg::m_layerHasExtensionKey

private

Initial value:

{
    this, "HGTD_has_extension", m_trackParticleContainerKey, "HGTD_has_extension",
      "deco with a handle for an extension"}

Definition at line 86 of file TrackTimeDefAndQualityAlg.h.

                                                                         {
    this, "HGTD_has_extension", m_trackParticleContainerKey, "HGTD_has_extension",
      "deco with a handle for an extension"};

m_primes_ptrn_sft

const short HGTD::TrackTimeDefAndQualityAlg::m_primes_ptrn_sft = 16

private

Definition at line 71 of file TrackTimeDefAndQualityAlg.h.

m_recoed_ptrn_sft

const short HGTD::TrackTimeDefAndQualityAlg::m_recoed_ptrn_sft = 0

private

Definition at line 67 of file TrackTimeDefAndQualityAlg.h.

m_summarypattern_dec_key

SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> HGTD::TrackTimeDefAndQualityAlg::m_summarypattern_dec_key

private

Initial value:

{this, "HGTD_summaryinfo", m_trackParticleContainerKey,
                               "HGTD_summaryinfo",
                               "Bitfield for working point definition"}

Definition at line 109 of file TrackTimeDefAndQualityAlg.h.

                          {this, "HGTD_summaryinfo", m_trackParticleContainerKey,
                               "HGTD_summaryinfo",
                               "Bitfield for working point definition"};

m_time_dec_key

SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> HGTD::TrackTimeDefAndQualityAlg::m_time_dec_key

private

Initial value:

{
    this, "time", m_trackParticleContainerKey, "time", "Time assigned to this track"}

Definition at line 101 of file TrackTimeDefAndQualityAlg.h.

                                                                  {
    this, "time", m_trackParticleContainerKey, "time", "Time assigned to this track"};

m_time_res_dec_key

SG::WriteDecorHandleKey<xAOD::TrackParticleContainer> HGTD::TrackTimeDefAndQualityAlg::m_time_res_dec_key

private

Initial value:

{
    this, "timeResolution", m_trackParticleContainerKey, "timeResolution",
      "Time resolution assigned to this track"}

Definition at line 103 of file TrackTimeDefAndQualityAlg.h.

                                                                      {
    this, "timeResolution", m_trackParticleContainerKey, "timeResolution",
      "Time resolution assigned to this track"};

m_trackParticleContainerKey

SG::ReadHandleKey<xAOD::TrackParticleContainer> HGTD::TrackTimeDefAndQualityAlg::m_trackParticleContainerKey

private

Initial value:

{
      this, "TrackParticleContainerName", "InDetTrackParticles",
      "Name of the TrackParticle container"}

Definition at line 83 of file TrackTimeDefAndQualityAlg.h.

                                                                         {
      this, "TrackParticleContainerName", "InDetTrackParticles",
      "Name of the TrackParticle container"};

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:

• TrackTimeDefAndQualityAlg.h
• TrackTimeDefAndQualityAlg.cxx