ITk::StripClusterOnTrackTool Class Reference

creates SCT_ClusterOnTrack objects allowing to calibrate cluster position and error using a given track hypothesis. More...

#include <ITkStripClusterOnTrackTool.h>

Inheritance diagram for ITk::StripClusterOnTrackTool:

Collaboration diagram for ITk::StripClusterOnTrackTool:

Public Member Functions
	StripClusterOnTrackTool (const std::string &, const std::string &, const IInterface *)
	AlgTool constructor. More...
virtual	~StripClusterOnTrackTool ()=default
virtual StatusCode	initialize () override
	AlgTool initialisation. More...
virtual InDet::SCT_ClusterOnTrack *	correct (const Trk::PrepRawData &, const Trk::TrackParameters &) const override
	produces an SCT_ClusterOnTrack for ITk strip clusters using the measured SCT_Cluster and the track prediction. More...
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc. More...
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm. More...
virtual StatusCode	sysStart () override
	Handle START transition. More...
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
MsgStream &	msg (const MSG::Level lvl) const
bool	msgLvl (const MSG::Level lvl) const

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	The AlgTool InterfaceID. More...

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...
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. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
SG::ReadCondHandleKey< RIO_OnTrackErrorScaling >	m_stripErrorScalingKey {this,"ErrorScalingKey", "/Indet/TrkErrorScalingITkStrip", "Key for ITkStrip error scaling conditions data."}
	toolhandle for central error scaling More...
IntegerProperty	m_option_errorStrategy {this, "ErrorStrategy", -1, "if ErrorStrategy < 0, keep previous errors else recompute"}
IntegerProperty	m_option_correctionStrategy {this, "CorrectionStrategy", -1, "if CorrectionStrategy >= 0, apply correction to position"}
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

creates SCT_ClusterOnTrack objects allowing to calibrate cluster position and error using a given track hypothesis.

See doxygen of Trk::RIO_OnTrackCreator for details. Different strategies to calibrate the cluster error can be chosen by job Option. Also the handle to the general hit-error scaling is implemented.

Definition at line 34 of file ITkStripClusterOnTrackTool.h.

Member Typedef Documentation

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

StripClusterOnTrackTool()

ITk::StripClusterOnTrackTool::StripClusterOnTrackTool	(	const std::string &	t,
		const std::string &	n,
		const IInterface *	p
	)

AlgTool constructor.

Definition at line 30 of file ITkStripClusterOnTrackTool.cxx.

                                                                :
  AthAlgTool(t, n, p) {
  declareInterface<IRIO_OnTrackCreator>(this);
}

~StripClusterOnTrackTool()

virtual ITk::StripClusterOnTrackTool::~StripClusterOnTrackTool ( )

virtualdefault

Member Function Documentation

correct()

InDet::SCT_ClusterOnTrack * ITk::StripClusterOnTrackTool::correct ( const Trk::PrepRawData &  rio, const Trk::TrackParameters &  trackPar  ) const

overridevirtual

produces an SCT_ClusterOnTrack for ITk strip clusters using the measured SCT_Cluster and the track prediction.

This method is a factory, so the client has to take care of management/deletion of the SCT_ClusterOnTrack.

Implements Trk::IRIO_OnTrackCreator.

Definition at line 82 of file ITkStripClusterOnTrackTool.cxx.

                                                                        {
  const InDet::SCT_Cluster *cluster = nullptr;
 
  if (!(cluster = dynamic_cast<const InDet::SCT_Cluster *> (&rio))) {
    ATH_MSG_WARNING("Attempt to correct RIO which is not SCT_Cluster with ITk::StripClusterOnTrackTool: returning nullptr");
    return nullptr;
  }
 
  ATH_MSG_VERBOSE("STARTING CLUSTER ON TRACK CORRECTION... " << __func__ << "  " << __LINE__);
  ATH_MSG_VERBOSE(" DUMPING CLUSTER POSITION / COVARIANCE: ");
  ATH_MSG_VERBOSE("STRIP CLUSTER POS --> " << cluster->localPosition()[0] << ", " << cluster->localPosition()[1]);
  ATH_MSG_VERBOSE("STRIP CLUSTER COV --> " << cluster->localCovariance()(0, 0) << ", " << cluster->localCovariance()(0, 1));
  ATH_MSG_VERBOSE("STRIP CLUSTER COV --> " << cluster->localCovariance()(1, 0) << ", " << cluster->localCovariance()(1, 1));
  ATH_MSG_VERBOSE("STRIP CLUSTER GLOBAL POSITION = " << cluster->globalPosition().x() << ", " << cluster->globalPosition().y() << ", " << cluster->globalPosition().z());
 
  // Get pointer to detector element
  //
  const InDetDD::SiDetectorElement *detectorElement = cluster->detectorElement();
  if (!detectorElement) {
    return nullptr;
  }
 
  // Get local position of track
  //
  Amg::Vector2D loct = trackPar.localPosition();
  double sinAlpha = detectorElement->sinStereoLocal(cluster->localPosition());
  double cosAlpha = std::sqrt(1 - sinAlpha * sinAlpha);
  Amg::Vector3D localstripdir(-sinAlpha, cosAlpha, 0.);
  ATH_MSG_VERBOSE("STRIP DIRECTION = " << localstripdir[0] << ", " << localstripdir[1]);
  Amg::Vector3D globalstripdir = trackPar.associatedSurface().transform().linear() * localstripdir;
 
  // Evaluate distance between cluster and estimated track parameters
  // used later on to estimate the corrected cluster position
  double distance = (trackPar.position() - cluster->globalPosition()).mag();
 
  ATH_MSG_VERBOSE(" DUMPING TRACK PARAMETER POSITION / COVARIANCE: ");
  ATH_MSG_VERBOSE("TRACK PAR LOCAL POS = " << loct[0] << ", " << loct[1]);
  ATH_MSG_VERBOSE("TRACK PAR GLOBAL POSITION = " << trackPar.position().x() << ", " << trackPar.position().y() << ", " << trackPar.position().z());
 
  // phi pitch in radians, for endcap modules
  double phiPitchInRad = 0.;
 
  // barrel or endcap treatment
  if (detectorElement->isBarrel()) {
    // barrel treatment:
    // get the module half length from the associated surface bounds
    const Trk::SurfaceBounds *bounds = &trackPar.associatedSurface().bounds();
    double boundsy = (static_cast<const Trk::RectangleBounds *>(bounds))->halflengthY();
    ATH_MSG_VERBOSE("BARREL ====>>>> DISTANCE*COSALPHA / HALF LENGTH --> " << distance*cosAlpha << " / " << boundsy);
    // Check if distance between track parameter local position
    // and cluster position is larger than surface bounds (including local stereo angle).
    // If so, set distance to maximum (- tolerance)
    if (distance*cosAlpha > boundsy){
      ATH_MSG_VERBOSE("DISTANCE TO LARGE COMPARED TO BOUNDS, SETTING TO MAXIMUM");
      distance = boundsy/cosAlpha - 1.; // use 1 mm as tolerance parameter
      // if local position is negative, also the distance has to be negative
      if (loct.y() < 0)
        distance = -distance;
    }
  } else {
    // endcap treatment:
    // for annuli do something different, since we already have in-sensor
    // stereo rotations which strip length accounts for
    const InDetDD::StripStereoAnnulusDesign * design =
      static_cast<const InDetDD::StripStereoAnnulusDesign *> (&detectorElement->design());
    const InDetDD::SiCellId & siCellId = detectorElement->cellIdOfPosition(cluster->localPosition());
    double striphalflength = design->stripLength(siCellId) / 2.0;
    ATH_MSG_VERBOSE("ENDCAP ====>>>> DISTANCE / STRIP HALF LENGTH --> " << distance << " / " << striphalflength);
    // caching phi pitch in radians
    phiPitchInRad = design->phiWidth()/design->diodesInRow(0);
    // Check if distance between track parameter local position
    // and cluster position is larger than strip length.
    // If so, set distance to maximum (- tolerance)
    if (distance > striphalflength) {
      ATH_MSG_VERBOSE("DISTANCE TO LARGE COMPARED TO BOUNDS, SETTING TO MAXIMUM");
      distance = striphalflength - 1.; // use 1 mm as tolerance parameter
    }
  }
 
  Amg::MatrixX prevCov = cluster->localCovariance();
  // Local position and error matrix production
  //
  constexpr double ONE_TWELFTH= 1.0/12.;
  if (m_option_errorStrategy > -1) {
    Amg::MatrixX mat(2, 2);
    mat.setZero();
    const InDet::SiWidth width = cluster->width();
    switch (m_option_errorStrategy) {
    case 0:
      // apply width/sqrt(12) as errors
      mat(0, 0) = std::pow(width.phiR(), 2) * ONE_TWELFTH;
      mat(1, 1) = std::pow(width.z(), 2) * ONE_TWELFTH;
      break;
 
    default:
      // don't do anything....
      break;
    }
 
    ATH_MSG_VERBOSE("CLUSTER ON TRACK COVARIANCE = " << mat(0, 0) << ", " << mat(0, 1) );
    ATH_MSG_VERBOSE("                              " << mat(1, 0) << ", " << mat(1, 1) );
 
    // error matrix rotation for endcap clusters
    if (not detectorElement->isBarrel()) {
      // the cluster covariance is expressed in the module
      // frame and needs to be rotated into the strip frame.
      // This rotation is done using the jacobian:
      //
      //  J = (  cos(alpha)     sin(alpha)
      //         -sin(alpha)    cos(alpha)  )
      //
      // The rotated covariance becomes
      // C = J C_{0} J^T
      //
      // where C_{0} is the cluster covariance,
      // and alpha is the local stereo angle.
      //
      // C_{0} = ( var_{0}^2     0
      //              0      var_{1}^2  )
      //
      // var_{0} also accounts for the pitch scaling.
      //
      double sinAlpha = detectorElement->sinStereoLocal(cluster->localPosition());
      double sinAlpha2 = sinAlpha * sinAlpha;
      double cosAlpha2 = (1. - sinAlpha) * (1. + sinAlpha);;
      double weight = detectorElement->phiPitch(cluster->localPosition()) / detectorElement->phiPitch();
      double v0 = mat(0, 0) * weight * weight;
      double v1 = mat(1, 1);
      mat(0, 0) = (cosAlpha2 * v0 + sinAlpha2 * v1);
      mat(1, 0) = (sinAlpha * std::sqrt(cosAlpha2) * (v0 - v1));
      mat(0, 1) = mat(1, 0);
      mat(1, 1) = (sinAlpha2 * v0 + cosAlpha2 * v1);
 
      ATH_MSG_VERBOSE(" ROTATION OF ENDCAP STRIP CLUSTER COVARIANCE");
      ATH_MSG_VERBOSE("sinAlpha / sinAlpha2 / cosAlpha2 / weight = " << sinAlpha << " / " << sinAlpha2 << " / " << cosAlpha2 << " / " << weight);
      ATH_MSG_VERBOSE("v0 / v1 = " << v0 << " / " << v1);
      ATH_MSG_VERBOSE("ROTATED CLUSTER COVARIANCE = " << mat(0, 0) << ", " << mat(0, 1) );
      ATH_MSG_VERBOSE("                             " << mat(1, 0) << ", " << mat(1, 1) );
 
    }
    // updating covariance
    prevCov = mat;
  }
 
  Trk::LocalParameters localParameters;
  Amg::MatrixX covariance(prevCov);
  Amg::Vector3D globalPosition(cluster->globalPosition() + distance * globalstripdir);
 
  // construction of the local parameters to build cluster on track
  if (detectorElement->isBarrel()) {
    Trk::DefinedParameter lpos1dim(cluster->localPosition().x(), Trk::locX);
    localParameters = Trk::LocalParameters(lpos1dim);
    covariance = Amg::MatrixX(1, 1);
    covariance(0, 0) = prevCov(0, 0);
    // scaling errors if required
    if (!m_stripErrorScalingKey.key().empty()) {
      SG::ReadCondHandle<RIO_OnTrackErrorScaling> error_scaling( m_stripErrorScalingKey );
      covariance = Trk::ErrorScalingCast<SCTRIO_OnTrackErrorScaling>(*error_scaling)
                     ->getScaledCovariance(std::move(covariance), false, 0.0);
    }
  } else {
    localParameters = Trk::LocalParameters(cluster->localPosition());
    // scaling errors if required
    if (!m_stripErrorScalingKey.key().empty()) {
      SG::ReadCondHandle<RIO_OnTrackErrorScaling> error_scaling(m_stripErrorScalingKey);
      covariance = Trk::ErrorScalingCast<SCTRIO_OnTrackErrorScaling>(*error_scaling)
                     ->getScaledCovariance(std::move(covariance), true,
                                           detectorElement->sinStereoLocal(cluster->localPosition()));
    }
 
    // For endcap strip clusters, the error matrix needs to be scaled
    // accordingly to the strip pitch (in mm) at the estimated track parameter.
    // The scaling term is evaluated in the strip frame and
    // transformed in the module frame.
    double sinAlpha = detectorElement->sinStereoLocal(cluster->localPosition());
    double sinAlpha2 = sinAlpha * sinAlpha;
    double cosAlpha2 = (1. - sinAlpha) * (1. + sinAlpha);
    double sinAlphaCosAlpha = sinAlpha * std::sqrt(cosAlpha2);
    // Weight factor to express the strip pitch (in mm) from the module center to the
    // estimated track parameter position.
    double radiusAtLocPos = std::hypot(loct.x(), loct.y());
    double phiPitchAtLocPos = phiPitchInRad*radiusAtLocPos;
    double weight = phiPitchAtLocPos / detectorElement->phiPitch();
    // Error matrix scaling term, this is expressend in the module frame.
    // It is evaluated using the same jacobian used above.
    double dV0 = (cosAlpha2 * covariance(0, 0) + sinAlpha2 * covariance(1, 1) +
                  2. * sinAlphaCosAlpha * covariance(1, 0)) * (weight * weight - 1.);
 
    // The final covariance matrix, which also accounts for the scaling:
    // Scaling and rotation are done with the same transformation:
    //
    // C = J C_{0} J^T
    //
    // where C_{0} is also includes the scaling term dV0:
    //
    // C_{0} = ( var_{0}^2 + dV0     0
    //              0            var_{1}^2  )
    //
    // The scaling terms are then added to the previously evaluated matrix:
    covariance(0, 0) += (cosAlpha2 * dV0);
    covariance(1, 0) += (sinAlphaCosAlpha * dV0);
    covariance(0, 1) = covariance(1, 0);
    covariance(1, 1) += (sinAlpha2 * dV0);
 
    ATH_MSG_VERBOSE(" SCALING OF ENDCAP STRIP CLUSTER COVARIANCE");
    ATH_MSG_VERBOSE("sinAlpha / sinAlpha2 / cosAlpha2 / weight = " << sinAlpha << " / " << sinAlpha2 << " / " << cosAlpha2 << " / " << weight );
    ATH_MSG_VERBOSE("dV0 = (" << cosAlpha2 * covariance(0, 0) << " + "
                              << sinAlpha2 * covariance(1, 1) << " + "
                              << 2. * sinAlphaCosAlpha * covariance(1, 0)
                              << " ) * " << (weight * weight - 1.) << " = "
                              << dV0);
    ATH_MSG_VERBOSE("SCALED CLUSTER COVARIANCE = " << covariance(0, 0) << ", "
                                                   << covariance(0, 1));
    ATH_MSG_VERBOSE("                            " << covariance(1, 0) << ", " << covariance(1, 1) );
  }
  // final construction of clustr of track
  bool isbroad = m_option_errorStrategy == 0;
  return new InDet::SCT_ClusterOnTrack(cluster, std::move(localParameters), std::move(covariance),
                                       detectorElement->identifyHash(), globalPosition, isbroad);
}

declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl, const SG::VarHandleKeyArrayType &    )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  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());
 
  }

declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl, const SG::VarHandleType &    )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
  }

declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  t, const SG::NotHandleType &    )

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(t);
  }

declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleBase &  hndl, const std::string &  doc, const SG::VarHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

  {
    this->declare(hndl.vhKey());
    hndl.vhKey().setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleKey &  hndl, const std::string &  doc, const SG::VarHandleKeyType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

  {
    this->declare(hndl);
    hndl.setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleKeyArray &  hndArr, const std::string &  doc, const SG::VarHandleKeyArrayType &    )

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

  {
 
    // std::ostringstream ost;
    // ost << Algorithm::name() << " VHKA declareProp: " << name 
    //     << " size: " << hndArr.keys().size() 
    //     << " mode: " << hndArr.mode() 
    //     << "  vhka size: " << m_vhka.size()
    //     << "\n";
    // debug() << ost.str() << endmsg;
 
    hndArr.setOwner(this);
    m_vhka.push_back(&hndArr);
 
    Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
    if (p != 0) {
      p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
    } else {
      ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                    << name);
    }
 
    return p;
 
  }

declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc, const SG::NotHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(name, property, doc);
  }

declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc = "none"  )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

  {
    typedef typename SG::HandleClassifier<T>::type htype;
    return declareProperty (name, property, doc, htype());
  }

declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T > &  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< AlgTool > >::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() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::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; }

evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( ) const

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

{ return m_evtStore; }

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::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

initialize()

StatusCode ITk::StripClusterOnTrackTool::initialize ( )

overridevirtual

AlgTool initialisation.

Definition at line 41 of file ITkStripClusterOnTrackTool.cxx.

                                       {
  StatusCode sc = AlgTool::initialize();
 
  ATH_MSG_DEBUG("Error strategy set to ");
  switch (m_option_errorStrategy) {
  case -1:  ATH_MSG_DEBUG("keep the PRD errors");
    break;
 
  case  0:  ATH_MSG_DEBUG("apply width/sqrt(12) as errors");
    break;
 
  default:  ATH_MSG_ERROR(" -- NO, UNKNOWN. Pls check jobOptions!");
    return StatusCode::FAILURE;
  }
  ATH_MSG_DEBUG(" will be applied during ITkStripClusterOnTrack making");
 
 ATH_MSG_DEBUG("Position correction strategy set to ");
  switch (m_option_correctionStrategy) {
  case -1:  ATH_MSG_DEBUG("keep the global position as evaluated");
    break;
 
  default:  ATH_MSG_ERROR(" -- NO, UNKNOWN. Pls check jobOptions!");
    return StatusCode::FAILURE;
  }
  ATH_MSG_DEBUG(" will be applied during ITkStripClusterOnTrack making");
 
 
  // get the error scaling tool
  if (!m_stripErrorScalingKey.key().empty()) {
    ATH_CHECK(m_stripErrorScalingKey.initialize());
    ATH_MSG_DEBUG("Detected need for scaling ITkStrip errors.");
  }
 
  return sc;
}

inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::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.

interfaceID()

static const InterfaceID& Trk::IRIO_OnTrackCreator::interfaceID ( )

inlinestaticinherited

The AlgTool InterfaceID.

Definition at line 41 of file IRIO_OnTrackCreator.h.

msg() [1/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level  lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                  {
    return this->msgStream(lvl);
  }

msgLvl()

bool AthCommonMsg< AlgTool >::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< AlgTool > >::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< AlgTool > >::renounce ( T &  h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray &  handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::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_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_option_correctionStrategy

IntegerProperty ITk::StripClusterOnTrackTool::m_option_correctionStrategy {this, "CorrectionStrategy", -1, "if CorrectionStrategy >= 0, apply correction to position"}

private

Definition at line 68 of file ITkStripClusterOnTrackTool.h.

m_option_errorStrategy

IntegerProperty ITk::StripClusterOnTrackTool::m_option_errorStrategy {this, "ErrorStrategy", -1, "if ErrorStrategy < 0, keep previous errors else recompute"}

private

Definition at line 67 of file ITkStripClusterOnTrackTool.h.

m_stripErrorScalingKey

SG::ReadCondHandleKey<RIO_OnTrackErrorScaling> ITk::StripClusterOnTrackTool::m_stripErrorScalingKey {this,"ErrorScalingKey", "/Indet/TrkErrorScalingITkStrip", "Key for ITkStrip error scaling conditions data."}

private

toolhandle for central error scaling

Definition at line 65 of file ITkStripClusterOnTrackTool.h.

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

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

• ITkStripClusterOnTrackTool.h
• ITkStripClusterOnTrackTool.cxx