Tracking/TrkEvent/TrkSpacePoint/TrkSpacePoint/SpacePoint.h

Go to the documentation of this file.

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

// SpacePoint.h
//   Header file for ABC SpacePoint
// (c) ATLAS Detector software
// Class to handle SPs for InDet and Muons
// Version 1.0 14/10/2003 Veronique Boisvert
// Version 2.0 12/12/2005 Martin Siebel
#ifndef TRKSPACEPOINT_SPACEPOINT_H
#define TRKSPACEPOINT_SPACEPOINT_H
 
#include <cassert>
#include <cmath>
#include <iosfwd>
#include <utility>  //for std::pair
 
#include "Identifier/IdentifierHash.h"
#include "TrkMeasurementBase/MeasurementBase.h"
 
class MsgStream;
 
namespace Trk {
 
class LocalParameters;
class Surface;
class PrepRawData;
 
class SpacePoint : public MeasurementBase {

  // Public methods:
 public:
  // public because of DataPool
  SpacePoint();
 // Destructor:
  virtual ~SpacePoint() = default;

  // Const methods:

  const std::pair<IdentifierHash, IdentifierHash>& elementIdList() const;

  const std::pair<const PrepRawData*, const PrepRawData*>& clusterList() const;

  const AmgSymMatrix(3)& globCovariance() const;

  double eta(double z0 = 0) const;

  double r() const;

  double phi() const;

  virtual const Surface& associatedSurface() const override final;

  virtual const Amg::Vector3D& globalPosition() const override final;

  virtual SpacePoint* clone() const override = 0;

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

  virtual bool type(MeasurementBaseType::Type type) const override final {
    return (type == MeasurementBaseType::SpacePoint);
  }

  virtual MsgStream& dump(MsgStream& out) const override = 0;
  virtual std::ostream& dump(std::ostream& out) const override = 0;
 
 protected:
  std::pair<const PrepRawData*, const PrepRawData*> m_clusList;
  std::pair<IdentifierHash, IdentifierHash> m_elemIdList;
  Amg::Vector3D m_position;
  AmgSymMatrix(3) m_globalCovariance;
 
  //For use by the final derived ones
  SpacePoint(const SpacePoint&) = default;
  SpacePoint(SpacePoint&&) noexcept = default;
  SpacePoint& operator=(const SpacePoint&) = default;
  SpacePoint& operator=(SpacePoint&&) noexcept = default;
 
  void setupGlobalFromLocalCovariance();
};

MsgStream& operator<<(MsgStream& sl, const SpacePoint& spacePoint);

std::ostream& operator<<(std::ostream& sl, const SpacePoint& spacePoint);

// Inline methods:
 
inline const std::pair<IdentifierHash, IdentifierHash>&
SpacePoint::elementIdList() const {
  return m_elemIdList;
}
 
inline const std::pair<const PrepRawData*, const PrepRawData*>&
SpacePoint::clusterList() const {
  return m_clusList;
}
 
inline double SpacePoint::eta(double z0) const {
  //  double zr = (m_z-z0)/m_r;
  double zr = (m_position.z() - z0) / m_position.perp();
  return std::log(zr + std::sqrt(1. + zr * zr));
}
 
inline double SpacePoint::r() const {
  return m_position.perp();
}
 
inline double SpacePoint::phi() const {
  return m_position.phi();
}
 
// The methods required by MeasurementBase
inline const Amg::Vector3D& SpacePoint::globalPosition() const {
  return m_position;
}
inline const AmgSymMatrix(3)& SpacePoint::globCovariance() const {
  return m_globalCovariance;
}
 
}  // namespace Trk
 
#endif  // TRKSPACEPOINT_SPACEPOINT_H