The InDet::SCT_ResidualPullCalculator is an AlgTool to calculate the residual and pull of a measurement and the related track state for the SCT. More...

#include <SCT_ResidualPullCalculator.h>

Inheritance diagram for InDet::SCT_ResidualPullCalculator:

Collaboration diagram for InDet::SCT_ResidualPullCalculator:

Public Member Functions
	SCT_ResidualPullCalculator (const std::string &type, const std::string &name, const IInterface *parent)
	constructor
virtual	~SCT_ResidualPullCalculator ()=default
virtual StatusCode	initialize () override
	initialize
virtual std::optional< Trk::ResidualPull >	residualPull (const Trk::MeasurementBase measurement, const Trk::TrackParameters trkPar, const Trk::ResidualPull::ResidualType resType, const Trk::TrackState::MeasurementType) const override
	This function returns (creates!) a Trk::ResidualPull object, which contains the values of residual and pull for the given measurement and track state.
virtual std::array< double, 5 >	residuals (const Trk::MeasurementBase measurement, const Trk::TrackParameters trkPar, const Trk::ResidualPull::ResidualType resType, const Trk::TrackState::MeasurementType) const override
	This function is a light-weight version of the function above, designed for track fitters where speed is critical.
virtual std::optional< Trk::ResidualPull >	residualPull (const Trk::MeasurementBase , const Trk::TrackParameters , const Trk::ResidualPull::ResidualType, const Trk::TrackState::MeasurementType, const std::vector< const Trk::AlignmentEffectsOnTrack * > &) const
	This function returns (creates!) a Trk::ResidualPull object, which contains the values of residual and pull for the given measurement and track state, and the Alignment effects.
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	sysInitialize () override
	Perform system initialization for an algorithm.
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

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	Interface ID, declared here, and defined below.

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
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Static Private Member Functions
static double	calcPull (const double residual, const double locMesCov, const double locTrkCov, const Trk::ResidualPull::ResidualType &, bool &pullIsValid)
	calc pull in 1 dimension

Private Attributes
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

The InDet::SCT_ResidualPullCalculator is an AlgTool to calculate the residual and pull of a measurement and the related track state for the SCT.

It is called by the Trk::ResidualPullCalculator in the case of SCT measurements. This tools assumes in any cases that the given measurement belongs to the SCT! Normaly it should not be called directly, but through the Trk::ResidualPullCalculator.

Definition at line 35 of file SCT_ResidualPullCalculator.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

◆ SCT_ResidualPullCalculator()

InDet::SCT_ResidualPullCalculator::SCT_ResidualPullCalculator	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

constructor

Definition at line 22 of file SCT_ResidualPullCalculator.cxx.

        : AthAlgTool(type,name,parent) {
    declareInterface<IResidualPullCalculator>(this);
}

◆ ~SCT_ResidualPullCalculator()

virtual InDet::SCT_ResidualPullCalculator::~SCT_ResidualPullCalculator ( )

virtualdefault

Member Function Documentation

◆ calcPull()

double InDet::SCT_ResidualPullCalculator::calcPull	(	const double	residual,
		const double	locMesCov,
		const double	locTrkCov,
		const Trk::ResidualPull::ResidualType &	resType,
		bool &	pullIsValid )

staticprivate

calc pull in 1 dimension

Definition at line 187 of file SCT_ResidualPullCalculator.cxx.

                               {
 
    double ErrorSum;
    if (resType == Trk::ResidualPull::Unbiased) {
      if ((locMesCov + locTrkCov) < 0.) {
        pullIsValid=false;
        return 0;
      }
        ErrorSum = sqrt(locMesCov + locTrkCov);
    } else if (resType == Trk::ResidualPull::Biased) {
      if ((locMesCov - locTrkCov) < 0.) {
        pullIsValid=false;
        return 0;
      }
      ErrorSum = sqrt(locMesCov - locTrkCov);
    } else {
      if (locMesCov < 0.) {
        pullIsValid=false;
        return 0;
      }
      ErrorSum = sqrt(locMesCov);
    }
    if (ErrorSum != 0) {
        return residual/ErrorSum;
    }
    pullIsValid=false;
    return 0;
}

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::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< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

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.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ 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 InDet::SCT_ResidualPullCalculator::initialize ( )

overridevirtual

initialize

Definition at line 30 of file SCT_ResidualPullCalculator.cxx.

                                                       {
    ATH_MSG_DEBUG ("initialise successful in "<<name());
    return StatusCode::SUCCESS;
}

◆ 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()

const InterfaceID & Trk::IResidualPullCalculator::interfaceID ( )

inlinestaticinherited

Interface ID, declared here, and defined below.

Definition at line 84 of file IResidualPullCalculator.h.

                                                                  {
    return IID_IResidualPullCalculator;
}

◆ msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

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

◆ residualPull() [1/2]

virtual std::optional< Trk::ResidualPull > Trk::IResidualPullCalculator::residualPull	(	const Trk::MeasurementBase *	,
		const Trk::TrackParameters *	,
		const Trk::ResidualPull::ResidualType	,
		const Trk::TrackState::MeasurementType	,
		const std::vector< const Trk::AlignmentEffectsOnTrack * > &	) const

inlinevirtual

This function returns (creates!) a Trk::ResidualPull object, which contains the values of residual and pull for the given measurement and track state, and the Alignment effects.

The track state can be an unbiased one (which can be retrieved by the Trk::IUpdator), a biased one (which contains the measurement), or a truth state. The enum residualTyp must be set according to this, otherwise the pulls will be wrong. Residuals differ in all three cases; please be aware of this.

This function determines the sub-detector type itself by using the ID helper

Reimplemented from Trk::IResidualPullCalculator.

Definition at line 64 of file IResidualPullCalculator.h.

                                                                   {
      return std::nullopt;
    }

◆ residualPull() [2/2]

std::optional< Trk::ResidualPull > InDet::SCT_ResidualPullCalculator::residualPull	(	const Trk::MeasurementBase *	measurement,
		const Trk::TrackParameters *	trkPar,
		const Trk::ResidualPull::ResidualType	resType,
		const Trk::TrackState::MeasurementType	) const

overridevirtual

This function returns (creates!) a Trk::ResidualPull object, which contains the values of residual and pull for the given measurement and track state.

calc residual and pull for SCT measurements

The track state can be an unbiased one (which can be retrieved by the Trk::IUpdator), a biased one (which contains the measurement), or a truth state. The enum ResidualType must be set according to this, otherwise the pulls will be wrong. Residuals differ in all three cases; please be aware of this!

Implements Trk::IResidualPullCalculator.

Definition at line 38 of file SCT_ResidualPullCalculator.cxx.

                                              {
 
    // check the input:
    const InDet::SCT_ClusterOnTrack *sctROT = dynamic_cast<const InDet::SCT_ClusterOnTrack*>(measurement);
    if (!sctROT) return std::nullopt;
    if (!trkPar) return std::nullopt;
 
    // if no covariance for the track parameters is given the pull calculation is not valid
    bool pullIsValid = trkPar->covariance()!=nullptr;
 
    // residual and pull are always 1-dim in the end
    std::vector<double> residual(1);
    std::vector<double> pull(1);
    double sinAlpha = 0.0;
 
    // check if we have a 2-dim SCT cluster
    if (sctROT->localParameters().parameterKey() == 1) {
        // the (easy) 1-dim case:
        residual[Trk::loc1] = sctROT->localParameters()[Trk::loc1] - trkPar->parameters()[Trk::loc1];
        if (pullIsValid) {
            pull[Trk::loc1] = calcPull(residual[Trk::loc1],
                                       sctROT->localCovariance()(Trk::loc1,Trk::loc1),
                                       (*trkPar->covariance())(Trk::loc1,Trk::loc1),
                                       resType, pullIsValid);
        } else {
            pull[Trk::loc1] = calcPull(residual[Trk::loc1],
                                       sctROT->localCovariance()(Trk::loc1,Trk::loc1),
                                       0,
                                       resType, pullIsValid);
        }
    } else {
        // the 2-dim case:
        // get the stereo angle (preferrably) from the PrepRawData
        const InDet::SCT_Cluster *sctRIO = sctROT->prepRawData();
        if (!sctRIO) {
            Amg::Vector2D p(sctROT->localParameters()[Trk::locX],
                                 sctROT->localParameters()[Trk::locY]);
            sinAlpha = sctROT->detectorElement()->sinStereoLocal(p);
        } else {
            // Get angle of strip in local frame with respect to the etaAxis
            // the position of the ROT is lorentz-drift corrected by up to 3 micron,
            // leading to a strip frame slightly (~5murad) different than the original one
            sinAlpha = sctRIO->detectorElement()->sinStereoLocal(sctRIO->localPosition());
        }
        double cosAlpha = sqrt(1 - sinAlpha*sinAlpha);
 
        // Calculate Residual for hit: res = (vec(x_track) - vec(x_hit)) * vec(n_perpendicular)
        residual[Trk::loc1] =
            (measurement->localParameters()[Trk::locX] -
             trkPar->parameters()[Trk::locX]) * cosAlpha
            + (measurement->localParameters()[Trk::locY] -
               trkPar->parameters()[Trk::locY]) * sinAlpha;
 
        // Fill transformation matrix to transform covariance matrices
    Amg::MatrixX RotMat(2,2);
        RotMat(0,0) = cosAlpha;
        RotMat(0,1) = sinAlpha;
        RotMat(1,0) = -sinAlpha;
        RotMat(1,1) = cosAlpha;
        // get the covariance matrix of the ROT and rotate it by stereo angle
    Amg::MatrixX transformedROTCov = sctROT->localCovariance().similarity(RotMat);
 
        if (trkPar->covariance()) {
      // Get local error matrix for track to calc pull
      // Just use first local coordinates
      // and rotate by the stereo angle
      Amg::MatrixX RotMatTrk(2,2);
      RotMatTrk(0,0) = (*trkPar->covariance())(0,0);
      RotMatTrk(0,1) = (*trkPar->covariance())(0,1);
      RotMatTrk(1,0) = (*trkPar->covariance())(1,0);
      RotMatTrk(1,1) = (*trkPar->covariance())(1,1);
 
      Amg::MatrixX transformedTrkCov = RotMatTrk.similarity(RotMat);
            // calc pull now
            pull[Trk::loc1] = calcPull(residual[Trk::loc1],
                                       transformedROTCov(0,0),
                                       transformedTrkCov(0,0),
                                       resType, pullIsValid);
        } else {
            pull[Trk::loc1] = calcPull(residual[Trk::loc1],
                                       transformedROTCov(0,0),
                                       0.,
                                       resType, pullIsValid);
        }
 
    }
 
    // create the Trk::ResidualPull:
    // ParameterKey is always 1, because otherwise we rotated it back
    return std::make_optional<Trk::ResidualPull>(std::move(residual),
                                               std::move(pull), pullIsValid,
                                               resType, 1, sinAlpha);
}

◆ residuals()

std::array< double, 5 > InDet::SCT_ResidualPullCalculator::residuals	(	const Trk::MeasurementBase *	measurement,
		const Trk::TrackParameters *	trkPar,
		const Trk::ResidualPull::ResidualType	resType,
		const Trk::TrackState::MeasurementType	) const

overridevirtual

This function is a light-weight version of the function above, designed for track fitters where speed is critical.

calc residuals for SCT measurements

Implements Trk::IResidualPullCalculator.

Definition at line 140 of file SCT_ResidualPullCalculator.cxx.

                                              {
    std::array<double,5> residuals{};
    // check the input:
    const InDet::SCT_ClusterOnTrack *sctROT = dynamic_cast<const InDet::SCT_ClusterOnTrack*>(measurement);
    if (!sctROT) return residuals;
    if (!trkPar) return residuals;
    double sinAlpha = 0.0;
 
    // check if we have a 2-dim SCT cluster
    if (sctROT->localParameters().parameterKey() == 1) {
        // the (easy) 1-dim case:
        residuals[Trk::loc1] = sctROT->localParameters()[Trk::loc1] - trkPar->parameters()[Trk::loc1];
    } else {
        // the 2-dim case:
        // get the stereo angle (preferrably) from the PrepRawData
        const InDet::SCT_Cluster *sctRIO = sctROT->prepRawData();
        if (!sctRIO) {
            Amg::Vector2D p(sctROT->localParameters()[Trk::locX],
                                 sctROT->localParameters()[Trk::locY]);
            sinAlpha = sctROT->detectorElement()->sinStereoLocal(p);
        } else {
            // Get angle of strip in local frame with respect to the etaAxis
            // the position of the ROT is lorentz-drift corrected by up to 3 micron,
            // leading to a strip frame slightly (~5murad) different than the original one
            sinAlpha = sctRIO->detectorElement()->sinStereoLocal(sctRIO->localPosition());
        }
        double cosAlpha = sqrt(1 - sinAlpha*sinAlpha);
 
        // Calculate Residual for hit: res = (vec(x_track) - vec(x_hit)) * vec(n_perpendicular)
        residuals[Trk::loc1] =
            (measurement->localParameters()[Trk::locX] -
             trkPar->parameters()[Trk::locX]) * cosAlpha
            + (measurement->localParameters()[Trk::locY] -
               trkPar->parameters()[Trk::locY]) * sinAlpha;
 
    }
    return residuals;
}

◆ 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 asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

◆ 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_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:

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ SCT_ResidualPullCalculator()

◆ ~SCT_ResidualPullCalculator()

Member Function Documentation

◆ calcPull()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ residualPull() [1/2]

◆ residualPull() [2/2]

◆ residuals()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_varHandleArraysDeclared

◆ m_vhka