Trk::ResidualPullCalculator Class Reference

AlgTool to calculate the residual and pull of a measurement and the related track state independently of the detector type. More...

#include <ResidualPullCalculator.h>

Inheritance diagram for Trk::ResidualPullCalculator:

Collaboration diagram for Trk::ResidualPullCalculator:

Public Member Functions
	ResidualPullCalculator (const std::string &type, const std::string &name, const IInterface *parent)
	constructor
	~ResidualPullCalculator ()
virtual StatusCode	initialize () override final
	initialize
virtual StatusCode	finalize () override final
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 final
	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::optional< Trk::ResidualPull >	residualPull (const Trk::MeasurementBase *measurement, const Trk::TrackParameters *trkPar, const Trk::ResidualPull::ResidualType resType, const Trk::TrackState::MeasurementType, const std::vector< const Trk::AlignmentEffectsOnTrack * > &) const override final
	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.
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 final
	This function is a light-weight version of the function above, designed for track fitters where speed is critical.
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
double	calcPull (const double residual, const double locMesCov, const double locTrkCov, const Trk::ResidualPull::ResidualType &resType) const
	calc pull in 1 dimension
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
ToolHandle< IResidualPullCalculator >	m_SCTresidualTool
	the ResidualPullCalculator for the SCT
ToolHandle< IResidualPullCalculator >	m_RPCresidualTool
	the ResidualPullCalculator for the RPC
ToolHandle< IResidualPullCalculator >	m_TGCresidualTool
	the ResidualPullCalculator for the TGC
const AtlasDetectorID *	m_idHelper
	Used to know the sub-det from PRD->identify().
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

AlgTool to calculate the residual and pull of a measurement and the related track state independently of the detector type.

The Trk::ResidualPullCalculator is an AlgTool to calculate the residual and pull of a measurement and the related track state independent of the detector type. For sub-detectors like the SCT which need more attention a special tool in the detector-realm is called (to avoid dependencies on sub-detector code; only runtime-dependencies are created).

The residuals and pulls are calculated according to the formulas given in the description of Trk::ResidualPull.

Definition at line 46 of file 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

ResidualPullCalculator()

Trk::ResidualPullCalculator::ResidualPullCalculator	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

constructor

Definition at line 31 of file ResidualPullCalculator.cxx.

    : AthAlgTool(type,name,parent),
m_SCTresidualTool("InDet::SCT_ResidualPullCalculator/SCT_ResidualPullCalculator"),
m_RPCresidualTool("Muon::RPC_ResidualPullCalculator/RPC_ResidualPullCalculator"),
m_TGCresidualTool("Muon::TGC_ResidualPullCalculator/TGC_ResidualPullCalculator"),
m_idHelper(nullptr) {
    declareInterface<IResidualPullCalculator>(this);
    declareProperty("ResidualPullCalculatorForSCT", m_SCTresidualTool,  "Tool to calculate residuals and pulls in the SCT (including module rotation)");
    declareProperty("ResidualPullCalculatorForRPC", m_RPCresidualTool,  "Tool to calculate residuals and pulls in the RPC (including phi/eta detection)");
    declareProperty("ResidualPullCalculatorForTGC", m_TGCresidualTool,  "Tool to calculate residuals and pulls in the SCT (including module rotation)");
 
}

~ResidualPullCalculator()

Trk::ResidualPullCalculator::~ResidualPullCalculator ( )

inline

Definition at line 50 of file ResidualPullCalculator.h.

{}

Member Function Documentation

calcPull()

double Trk::ResidualPullCalculator::calcPull ( const double residual, const double locMesCov, const double locTrkCov, const Trk::ResidualPull::ResidualType & resType ) const

private

calc pull in 1 dimension

Definition at line 444 of file ResidualPullCalculator.cxx.

                                                       {
 
    double CovarianceSum = 0.0;
    if (resType == Trk::ResidualPull::Unbiased) {
        CovarianceSum = locMesCov + locTrkCov;
    } else if (resType == Trk::ResidualPull::Biased) {
        CovarianceSum = locMesCov - locTrkCov;
    } else CovarianceSum = locMesCov;
 
    if (CovarianceSum <= 0.0) {
        ATH_MSG_DEBUG("instable calculation: total covariance is non-positive, MeasCov = "<<
            locMesCov<<", TrkCov = "<<locTrkCov<<", resType = "<<resType);
        return 0.0;
    }
    return residual/sqrt(CovarianceSum);
}

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.

{ return m_detStore; }

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.

{ 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

finalize()

StatusCode Trk::ResidualPullCalculator::finalize ( )

finaloverridevirtual

Definition at line 79 of file ResidualPullCalculator.cxx.

                                               {
    ATH_MSG_DEBUG ("starting finalize() in " << name());
    return StatusCode::SUCCESS;
}

initialize()

StatusCode Trk::ResidualPullCalculator::initialize ( )

finaloverridevirtual

initialize

Definition at line 47 of file ResidualPullCalculator.cxx.

                                                 {
 
    // ---------------------------------------
    //Set up ATLAS ID helper to be able to identify the RIO's det-subsystem.
    ATH_CHECK(detStore()->retrieve(m_idHelper, "AtlasID"));
    // ----------------------------------
    // get the SCT residual/pull calculator
    if ( ! m_SCTresidualTool.empty() ) {
        ATH_CHECK( m_SCTresidualTool.retrieve());
    } else {
        ATH_MSG_DEBUG ("No residual calculator for SCT given, will ignore SCT measurements!");
    }
 
    // ----------------------------------
    // get the RPC residual/pull calculator
    if ( ! m_RPCresidualTool.empty() ) {
        ATH_CHECK( m_RPCresidualTool.retrieve());
    } else {
        ATH_MSG_DEBUG ("No residual calculator for RPC given, will ignore RPC measurements!");
    }
 
    // ----------------------------------
    // get the TGC residual/pull calculator
    if ( ! m_TGCresidualTool.empty() ) {
        ATH_CHECK( m_TGCresidualTool.retrieve());
    } else {
        ATH_MSG_DEBUG ("No residual calculator for TGC given, will ignore TGC measurements!");
    }
 
    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]

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

finaloverridevirtual

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

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

Implements Trk::IResidualPullCalculator.

Definition at line 175 of file ResidualPullCalculator.cxx.

                                                      {
 
    if (!measurement || !trkPar) return std::nullopt;
 
    // if no covariance for the track parameters is given the pull calculation is not valid
    bool pullIsValid = trkPar->covariance();
 
    Trk::TrackState::MeasurementType measType = detType;
    if (detType == Trk::TrackState::unidentified) {
        Trk::MeasurementTypeID helper = MeasurementTypeID(m_idHelper);
        measType = helper.defineType(measurement);
    }
    unsigned int dimOfLocPars = (unsigned int)measurement->localParameters().dimension();
    std::vector<double> residual(dimOfLocPars);
    std::vector<double> pull(dimOfLocPars);
 
    unsigned int iColRow=0;
    ATH_MSG_VERBOSE ("Calculating residual for type " << measType << " dimension " << dimOfLocPars);
 
    // do the calculations for the different detector types
    switch(measType) {
        case Trk::TrackState::Pixel:
        ATH_MSG_VERBOSE ("Pixel dim calculation ");
        // calc residual and pull for the second coordinate, first coord postponed to 1-dim case
        residual[Trk::loc2] = measurement->localParameters()[Trk::loc2] - trkPar->parameters()[Trk::loc2];
        if (pullIsValid) {
            pull[Trk::loc2] = calcPull(residual[Trk::loc2],
            measurement->localCovariance()(Trk::loc2,Trk::loc2),
            (*trkPar->covariance())(Trk::loc2,Trk::loc2),
            resType);
        } else {
            pull[Trk::loc2] = calcPull(residual[Trk::loc2],
            measurement->localCovariance()(Trk::loc2,Trk::loc2),
            0,
            resType);
        }
        // do not break here, but also fill the first coordinate...
        /* FALLTHROUGH */
        case Trk::TrackState::TRT:
        case Trk::TrackState::MDT:
        case Trk::TrackState::CSC:
        case Trk::TrackState::STGC:
        case Trk::TrackState::MM:
        ATH_MSG_VERBOSE ("One dim calculation ");
        // 1-dim measurement
        // calc residual and pull for the first coordinate
        residual[Trk::loc1] = measurement->localParameters()[Trk::loc1] - trkPar->parameters()[Trk::loc1];
        if (pullIsValid) {
            pull[Trk::loc1] = calcPull(residual[Trk::loc1],
            measurement->localCovariance()(Trk::loc1,Trk::loc1),
            (*trkPar->covariance())(Trk::loc1,Trk::loc1),
            resType);
        } else {
            pull[Trk::loc1] = calcPull(residual[Trk::loc1],
            measurement->localCovariance()(Trk::loc1,Trk::loc1),
            0,
            resType);
        }
        break;
        case Trk::TrackState::SCT:
        // special case, has to be handed down to the SCT tool
        if ( ! m_SCTresidualTool.empty() ) {
            ATH_MSG_VERBOSE ("Calling SCT tool ");
            return m_SCTresidualTool->residualPull(measurement, trkPar, resType, Trk::TrackState::SCT);
        } else {
            ATH_MSG_WARNING ("No SCT ResidualPullCalculator given, cannot calculate residual and pull for SCT measurement!");
            return std::nullopt;
        }
        break;
        case Trk::TrackState::RPC:
        // special case, has to be handed down to the RPC tool
        if ( ! m_RPCresidualTool.empty() ) {
            ATH_MSG_VERBOSE ("Calling RPC tool ");
            return m_RPCresidualTool->residualPull(measurement, trkPar, resType, Trk::TrackState::RPC);
        } else {
            ATH_MSG_WARNING ("No RPC ResidualPullCalculator given, cannot calculate residual and pull for RPC measurement!");
            return std::nullopt;
        }
        break;
        case Trk::TrackState::TGC:
        // special case, has to be handed down to the TGC tool
        if ( ! m_TGCresidualTool.empty() ) {
            ATH_MSG_VERBOSE ("Calling TGC tool ");
            return m_TGCresidualTool->residualPull(measurement, trkPar, resType, Trk::TrackState::TGC);
        } else {
            ATH_MSG_WARNING ("No TGC ResidualPullCalculator given, cannot calculate residual and pull for TGC measurement!");
            return std::nullopt;
        }
        break;
        case Trk::TrackState::Segment:
        case Trk::TrackState::Pseudo:
        case Trk::TrackState::Vertex:
        case Trk::TrackState::SpacePoint:
        ATH_MSG_VERBOSE ("Bit-key calculation ");
 
        // PMs, Segments etc: use LocalParameters bit-key scheme
        for (unsigned int i=0; i<5; ++i) {
            Trk::ParamDefs iPar = Trk::ParamDefsAccessor::pardef[i];
            if (measurement->localParameters().contains(iPar)) {
                residual[iColRow] = measurement->localParameters()[iPar]
                    - trkPar->parameters()[iPar];
                if (pullIsValid)
                    pull[iColRow]     = calcPull(residual[iColRow],
                measurement->localCovariance()(Trk::ParamDefsAccessor::pardef[iColRow],Trk::ParamDefsAccessor::pardef[iColRow]),
                (*trkPar->covariance())(Trk::ParamDefsAccessor::pardef[iColRow],Trk::ParamDefsAccessor::pardef[iColRow]),
                resType);
                ++iColRow;
            }
        }
        break;
        default:
        ATH_MSG_VERBOSE ("Default calculation ");
        // use HEPvector to calculate the residual
        // r = m - H.p
        Amg::VectorX HEPresidual = measurement->localParameters() - (measurement->localParameters().expansionMatrix() * trkPar->parameters());
        residual.resize(HEPresidual.rows());
        pull.resize(HEPresidual.rows());
        for (int i = 0; i < HEPresidual.rows(); i++) {
            residual[i] = HEPresidual[i];
        }
 
    }
    return std::make_optional<Trk::ResidualPull>(
        std::move(residual), std::move(pull), pullIsValid, resType,
        measurement->localParameters().parameterKey());
}

residualPull() [2/2]

std::optional< Trk::ResidualPull > Trk::ResidualPullCalculator::residualPull ( const Trk::MeasurementBase * measurement, const Trk::TrackParameters * trkPar, const Trk::ResidualPull::ResidualType resType, const Trk::TrackState::MeasurementType detType, const std::vector< const Trk::AlignmentEffectsOnTrack * > & aeots ) const

finaloverridevirtual

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 309 of file ResidualPullCalculator.cxx.

                                                                     {
 
    //bool veryVerbose = true;
 
    Trk::TrackState::MeasurementType measType = detType;
    if (detType == Trk::TrackState::unidentified) {
        Trk::MeasurementTypeID helper = MeasurementTypeID(m_idHelper);
        measType = helper.defineType(measurement);
    }
 
    // time to shift the parameter - do this rather than the measurement so we can call the original method.
    Amg::Vector3D loc3Dframe;
    Amg::Vector2D localPos;
    Amg::Vector2D localPosSimple;
    Amg::Vector3D globalPos;
    AmgVector(5) parameters;
 
    std::unique_ptr<Trk::TrackParameters>  trkPar = originalTrkPar->uniqueClone();
    parameters =  trkPar->parameters();
 
    ATH_MSG_VERBOSE( " ResidualPullCalculator aeots size  " <<  aeots.size() << " parameters[0] " <<  parameters[0] );
    double residual = measurement->localParameters()[Trk::loc1] - trkPar->parameters()[Trk::loc1];
    ATH_MSG_VERBOSE(" parameters[0] "
                    << parameters[0] << " trkPar->parameters()[Trk::loc1] "
                    << trkPar->parameters()[Trk::loc1]
                    << " measurement->localParameters()[Trk::loc1] "
                    << measurement->localParameters()[Trk::loc1] << " resi "
                    << residual);
 
    localPos[0] = parameters[0];
    localPosSimple[0] = parameters[0];
    for ( const auto & aeot : aeots ){
        ATH_MSG_VERBOSE( " ResidualPullCalculator aeots deltaTranslation  " <<  aeot->deltaTranslation() << " angle " << aeot->deltaAngle());
 
        Trk::DistanceSolution solution = aeot->associatedSurface().straightLineDistanceEstimate(originalTrkPar->position(),originalTrkPar->momentum().unit());
        double distance = solution.currentDistance(true);
//      calculate sign of distance
        Amg::Vector3D displacementVector =
            Amg::Vector3D(originalTrkPar->position().x() -
                                  aeot->associatedSurface().center().x(),
                              originalTrkPar->position().y() -
                                  aeot->associatedSurface().center().y(),
                              originalTrkPar->position().z() -
                                  aeot->associatedSurface().center().z());
        if (displacementVector.dot(originalTrkPar->momentum().unit()) < 0)
        distance = -distance;
 
        if(measType == Trk::TrackState::MDT) {
// MDT
          double distanceX = distance*originalTrkPar->momentum().unit().x();
          double distanceY = distance*originalTrkPar->momentum().unit().y();
          const double originalPhi=originalTrkPar->momentum().phi();
          double distanceR = std::cos(originalPhi)*distanceX + std::sin(originalPhi)*distanceY; //< Is this quicker than hypotenuse?
          ATH_MSG_VERBOSE(" originalTrkPar->position() x "
                          << originalTrkPar->position().x() << " y "
                          << originalTrkPar->position().y() << " z "
                          << originalTrkPar->position().z());
          ATH_MSG_VERBOSE(" aeot->associatedSurface().center() x "
                          << aeot->associatedSurface().center().x() << " y "
                          << aeot->associatedSurface().center().y() << " z "
                          << aeot->associatedSurface().center().z());
 
          //        use drift (circle) derivatives as in TrkiPatFitterUtils
 
          Amg::Vector3D sensorDirection  = Amg::Vector3D(measurement->associatedSurface().transform().rotation().col(2));
          Amg::Vector3D driftDirection = Amg::Vector3D(sensorDirection.cross(originalTrkPar->momentum().unit()));
          driftDirection = driftDirection.unit();
          ATH_MSG_VERBOSE( " cos(theta) " << std::cos(originalTrkPar->momentum().theta()) << " phi " << originalPhi );
          ATH_MSG_VERBOSE( " sensorDirection x " << sensorDirection.x() << " y " << sensorDirection.y() << " z " << sensorDirection.z() );
          ATH_MSG_VERBOSE( " driftDirection x " << driftDirection.x() << " y " << driftDirection.y() << " z " << driftDirection.z() );
 
 
// Barrel
          double projection = driftDirection.z();
// dz because of a dhteta change: factor = dz/dtheta
          const double originalTheta=originalTrkPar->momentum().theta();
          const double sinOriginalTheta=std::sin(originalTheta);
          double factor = (distanceR/sinOriginalTheta)/sinOriginalTheta;    //preserve calc. order
          const Surface&  surface = aeot->associatedSurface();
          ATH_MSG_VERBOSE( " fabs(surface.normal().z()) " << std::fabs(surface.normal().z()) );
          if(std::fabs(surface.normal().z()) > 0.5) {
// endcap
             projection = (driftDirection.x()*surface.center().x() + driftDirection.y()*surface.center().y()) /
                                 surface.center().perp();
// dr because of a dhteta change : factor = dR/dtheta
             factor = -(distanceR/std::sin(originalTheta))/(std::cos(originalTheta)); //preserve calc. order
             ATH_MSG_VERBOSE( " distance " << distance << " Endcap projection " << projection << " factor " << factor );
          } else {
             ATH_MSG_VERBOSE( " distance " << distance << " Barrel projection " << projection  << " factor " << factor );
          }
 
 
          localPos[0] += projection*aeot->deltaTranslation() - projection*factor*aeot->deltaAngle(); // Shift in precision direction.
 
          ATH_MSG_VERBOSE( " MDT old localPos " << parameters[0] << " new localPos " << localPos[0] );
 
        } else {
 
// CSC or MM clusters
 
          double projection = aeot->associatedSurface().normal().dot(originalTrkPar->momentum().unit());
          localPos[0] += aeot->deltaTranslation()*projection + distance*aeot->deltaAngle();
 
          ATH_MSG_VERBOSE(" CSC old localPos "
                          << parameters[0] << " distance " << distance
                          << " proj " << projection << " new localPos "
                          << localPos[0] << " simple " << localPosSimple[0]);
        }
    }
 
    parameters[0] = localPos[0];
    residual = measurement->localParameters()[Trk::loc1] -  parameters[0];
    ATH_MSG_VERBOSE( " new residual after end aeots loop " << residual );
 
    // Set parameters to the new values;
    const AmgSymMatrix(5)* originalCov = trkPar->covariance();
    if(originalCov) {
       trkPar->updateParameters(parameters, AmgSymMatrix(5)( *originalCov ) );
    } else {
       trkPar->updateParameters(parameters);
    }
 
    // Now call original method.
    return residualPull(measurement, trkPar.get(), resType, detType );
}

residuals()

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

finaloverridevirtual

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

The user has to provide a std::array of size 5, which gets filled with the residuals.

Implements Trk::IResidualPullCalculator.

Definition at line 88 of file ResidualPullCalculator.cxx.

                                                      {
 
    std::array<double,5> residuals{-999.,-999.,-999.,-999.,-999};
    Trk::TrackState::MeasurementType measType = detType;
    if (detType == Trk::TrackState::unidentified) {
        Trk::MeasurementTypeID helper = MeasurementTypeID(m_idHelper);
        measType = helper.defineType(measurement);
    }
    switch(measType) {
        case Trk::TrackState::Pixel:
            ATH_MSG_VERBOSE ("Pixel dim calculation ");
            // calc residual and pull for the second coordinate, first coord postponed to 1-dim case
            residuals[Trk::loc1] = measurement->localParameters()[Trk::loc1] - trkPar->parameters()[Trk::loc1];
            residuals[Trk::loc2] = measurement->localParameters()[Trk::loc2] - trkPar->parameters()[Trk::loc2];
        break;
        case Trk::TrackState::TRT:
        case Trk::TrackState::MDT:
        case Trk::TrackState::CSC:
        case Trk::TrackState::MM:
            ATH_MSG_VERBOSE ("One dim calculation ");
            // 1-dim measurement
            // calc residual and pull for the first coordinate
            residuals[Trk::loc1] = measurement->localParameters()[Trk::loc1] - trkPar->parameters()[Trk::loc1];
            break;
        case Trk::TrackState::STGC:
            ATH_MSG_VERBOSE ("One dim calculation ");
            // 1-dim measurement
            // calc residual and pull for the first coordinate
            if( measurement->localParameters().contains(Trk::loc1) )
                residuals[Trk::loc1] = measurement->localParameters()[Trk::loc1] - trkPar->parameters()[Trk::loc1];
            else
                residuals[Trk::loc2] = measurement->localParameters()[Trk::loc2] - trkPar->parameters()[Trk::loc2];
            break;
        case Trk::TrackState::SCT:
            // special case, has to be handed down to the SCT tool
            if ( ! m_SCTresidualTool.empty() ) {
                ATH_MSG_VERBOSE ("Calling SCT tool ");
                return m_SCTresidualTool->residuals(measurement, trkPar, resType, Trk::TrackState::SCT);
            } else {
                ATH_MSG_WARNING ("No SCT ResidualPullCalculator given, cannot calculate residual and pull for SCT measurement!");
            }
            break;
        case Trk::TrackState::RPC:
            // special case, has to be handed down to the RPC tool
            if ( ! m_RPCresidualTool.empty() ) {
                ATH_MSG_VERBOSE ("Calling RPC tool ");
                return m_RPCresidualTool->residuals(measurement, trkPar, resType, Trk::TrackState::RPC);
            } else {
                ATH_MSG_WARNING ("No RPC ResidualPullCalculator given, cannot calculate residual and pull for RPC measurement!");
            }
            break;
        case Trk::TrackState::TGC:
            // special case, has to be handed down to the TGC tool
            if ( ! m_TGCresidualTool.empty() ) {
                ATH_MSG_VERBOSE ("Calling TGC tool ");
                return m_TGCresidualTool->residuals(measurement, trkPar, resType, Trk::TrackState::TGC);
            } else {
                ATH_MSG_WARNING ("No TGC ResidualPullCalculator given, cannot calculate residual and pull for TGC measurement!");
            }
            break;
        case Trk::TrackState::Segment:
        case Trk::TrackState::Pseudo:
        case Trk::TrackState::Vertex:
        case Trk::TrackState::SpacePoint:
        default:
            ATH_MSG_VERBOSE ("Bit-key calculation ");
            // PMs, Segments etc: use LocalParameters bit-key scheme
            for (unsigned int i=0; i<5; ++i) {
                Trk::ParamDefs iPar = Trk::ParamDefsAccessor::pardef[i];
                if (measurement->localParameters().contains(iPar)) {
                    residuals[i] = measurement->localParameters()[iPar]
                        - trkPar->parameters()[iPar];
                }
            }
            break;
    }
    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_idHelper

const AtlasDetectorID* Trk::ResidualPullCalculator::m_idHelper

private

Used to know the sub-det from PRD->identify().

Definition at line 103 of file ResidualPullCalculator.h.

m_RPCresidualTool

ToolHandle<IResidualPullCalculator> Trk::ResidualPullCalculator::m_RPCresidualTool

private

the ResidualPullCalculator for the RPC

Definition at line 101 of file ResidualPullCalculator.h.

m_SCTresidualTool

ToolHandle<IResidualPullCalculator> Trk::ResidualPullCalculator::m_SCTresidualTool

private

the ResidualPullCalculator for the SCT

Definition at line 100 of file ResidualPullCalculator.h.

m_TGCresidualTool

ToolHandle<IResidualPullCalculator> Trk::ResidualPullCalculator::m_TGCresidualTool

private

the ResidualPullCalculator for the TGC

Definition at line 102 of file ResidualPullCalculator.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:

• ResidualPullCalculator.h
• ResidualPullCalculator.cxx