IResidualPullCalculator.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2023 CERN for the benefit of the ATLAS collaboration
*/
 
// IResidualPullCalculator.h
//   Header file for interface of ResidualPullCalculator
// (c) ATLAS Detector software
// Sebastian.Fleischmann@cern.ch
 
#ifndef TRK_IRESIDUALPULLCALCULATOR_H
#define TRK_IRESIDUALPULLCALCULATOR_H
 
#include "GaudiKernel/IAlgTool.h"
#include "TrkParameters/TrackParameters.h" // typedef
#include "TrkEventPrimitives/TrackStateDefs.h"
#include "TrkEventPrimitives/ResidualPull.h"
#include <array>
#include <optional>
 
namespace Trk {
static const InterfaceID IID_IResidualPullCalculator("IResidualPullCalculator",1,0);
 
class MeasurementBase;
class AlignmentEffectsOnTrack;
 
class IResidualPullCalculator : virtual public IAlgTool {
public:
    static const InterfaceID& interfaceID();
 
    virtual std::optional<Trk::ResidualPull> residualPull(
        const Trk::MeasurementBase*, const Trk::TrackParameters*,
        const Trk::ResidualPull::ResidualType residualType,
        const TrackState::MeasurementType = TrackState::unidentified) const = 0;
 
    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 {
      return std::nullopt;
    }
 
    virtual  std::array<double,5> residuals(
       const Trk::MeasurementBase*,
       const Trk::TrackParameters*,
       const Trk::ResidualPull::ResidualType residualType,
       const TrackState::MeasurementType = TrackState::unidentified) const = 0;
};
 
inline const InterfaceID& Trk::IResidualPullCalculator::interfaceID() {
    return IID_IResidualPullCalculator;
}
 
} // end of namespace
 
#endif // TRK_IRESIDUALPULLCALCULATOR_H