MeasurementBase.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2023 CERN for the benefit of the ATLAS collaboration
*/

// MeasurementBase.h, (c) ATLAS Detector software
 
#ifndef TRKMEASUREMENTBASE_MEASUREMENTBASE_H
#define TRKMEASUREMENTBASE_MEASUREMENTBASE_H
 
// Amg
#include "EventPrimitives/EventPrimitives.h"
#include "GeoPrimitives/GeoPrimitives.h"
// Trk
#include "TrkEventPrimitives/LocalParameters.h"
 
// I/O
#include <iosfwd>
#include <memory>
class MsgStream;
 
namespace Trk {
 
class LocalParameters;
class ErrorMatrix;
class Surface;

 
namespace MeasurementBaseType {
/* The various kind of MeasurementBase
 * to avoid dynamic_cast via using the type method
 */
enum Type
{
  Segment = 0,
  SpacePoint = 1,
  RIO_OnTrack = 2,
  CompetingRIOsOnTrack = 3,
  PseudoMeasurementOnTrack = 4,
  VertexOnTrack = 5,
  CaloCluster_OnTrack = 6
};
}
 
class MeasurementBase
{
 
public:
  MeasurementBase() = default;

  MeasurementBase(LocalParameters&& pars, Amg::MatrixX&& cov)
    : m_localParams(std::move(pars))
    , m_localCovariance(std::move(cov))
  {}

  virtual ~MeasurementBase() = default;

  virtual MeasurementBase* clone() const = 0;

  std::unique_ptr<MeasurementBase> uniqueClone() const
  {
    return std::unique_ptr<MeasurementBase>(clone());
  }

  const LocalParameters& localParameters() const;

  const Amg::MatrixX& localCovariance() const;

  virtual const Surface& associatedSurface() const = 0;

  virtual const Amg::Vector3D& globalPosition() const = 0;

  virtual bool type(MeasurementBaseType::Type type) const = 0;

  virtual MsgStream& dump(MsgStream& out) const = 0;

  virtual std::ostream& dump(std::ostream& out) const = 0;
 
protected:
  // Here to help implement the relevant semantics for
  // the derived classes
  MeasurementBase(const MeasurementBase&) = default;
  MeasurementBase(MeasurementBase&&) noexcept = default;
  MeasurementBase& operator=(const MeasurementBase&) = default;
  MeasurementBase& operator=(MeasurementBase&&) noexcept = default;
 
  LocalParameters m_localParams;
  Amg::MatrixX m_localCovariance;
};

inline MsgStream&
operator<<(MsgStream& sl, const Trk::MeasurementBase& mbase)
{
  return mbase.dump(sl);
}

inline std::ostream&
operator<<(std::ostream& sl, const Trk::MeasurementBase& mbase)
{
  return mbase.dump(sl);
}
 
}
 
inline const Trk::LocalParameters&
Trk::MeasurementBase::localParameters() const
{
  return m_localParams;
}
 
inline const Amg::MatrixX&
Trk::MeasurementBase::localCovariance() const
{
  return m_localCovariance;
}
 
#endif