ParametersCommon.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2023 CERN for the benefit of the ATLAS collaboration
*/
 
/* @brief ParametersCommon common base class
 * for  ParametersT, CurvilinearParameters and PatternTrackParameters
 */
 
#ifndef TRKPARAMETERSCOMMON_PARAMETERSCOMMON_H
#define TRKPARAMETERSCOMMON_PARAMETERSCOMMON_H
//
#include "TrkParametersBase/Charged.h"
#include "TrkParametersBase/Neutral.h"
// Amg
#include "EventPrimitives/EventPrimitives.h"
#include "GeoPrimitives/GeoPrimitives.h"
#include "TrkEventPrimitives/SurfaceTypes.h"
//
#include <optional>
#include <limits>
 
namespace Trk {
class Surface;

enum ParametersType { AtaSurface = 0, Curvilinear = 1, Pattern = 2 };
 
namespace InvalidParam {
constexpr double INVALID = std::numeric_limits<double>::quiet_NaN();
constexpr double INVALID_P(10e9);
constexpr double INVALID_QOP(10e-9);
}

 
template <int DIM, class T>
class ParametersCommon {
 public:
  static_assert((std::is_same<T, Trk::Charged>::value ||
                 std::is_same<T, Trk::Neutral>::value),
                "Parameters must be Charged or Neutral");
  static constexpr int dim = DIM;

  const AmgVector(DIM) & parameters() const;
  AmgVector(DIM) & parameters();

  const AmgSymMatrix(DIM) * covariance() const;
  AmgSymMatrix(DIM) * covariance();

  constexpr bool isCharged() const;
  Amg::Vector2D localPosition() const;

  void setParameters(const AmgVector(DIM) & param);

  void setCovariance(const AmgSymMatrix(DIM) & cov);

  void updateParameters(const AmgVector(DIM) &, const AmgSymMatrix(DIM) &);

  void updateParameters(const AmgVector(DIM) &);

  virtual bool hasSurface() const = 0;

  virtual const Surface& associatedSurface() const = 0;

  virtual Amg::RotationMatrix3D measurementFrame() const = 0;

  virtual ParametersCommon<DIM, T>* clone() const = 0;

  constexpr virtual ParametersType type() const = 0;

  virtual SurfaceType surfaceType() const = 0;

  virtual ~ParametersCommon() = default;
 
 protected:
  /*
   * This is an abstract class and we can not instantiate objects directly.
   * In the other hand derived classed can use ctors
   */
  ParametersCommon() = default;
  ParametersCommon(ParametersCommon&&) noexcept = default;
  ParametersCommon& operator=(ParametersCommon&&) noexcept = default;
  ParametersCommon(const ParametersCommon&) = default;
  ParametersCommon& operator=(const ParametersCommon&) = default;
  /* Helper ctors for derived classes*/
  ParametersCommon(const AmgVector(DIM) parameters,
                 std::optional<AmgSymMatrix(DIM)>&& covariance,
                 const T chargeDef);
 
  ParametersCommon(std::optional<AmgSymMatrix(DIM)>&& covariance);
 
  ParametersCommon(const AmgVector(DIM) & parameters,
                 std::optional<AmgSymMatrix(DIM)>&& covariance = std::nullopt);
 
 
  /* Helper implementing the specific per derived class logic for
   * the update of parameters*/
  virtual void updateParametersHelper(const AmgVector(DIM) &) = 0;

  AmgVector(DIM) m_parameters;
  std::optional<AmgSymMatrix(DIM)> m_covariance = std::nullopt;
  T m_chargeDef{};  
};
}  // end of namespace Trk
 
#include "TrkParametersBase/ParametersCommon.icc"
 
#endif