PixelClusterOnTrack.h

Go to the documentation of this file.

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

// PixelClusterOnTrack.h, (c) ATLAS Detector software
 
#ifndef INDETRIO_ONTRACK_PIXELCLUSTERONTRACK_H
#define INDETRIO_ONTRACK_PIXELCLUSTERONTRACK_H
 
// Base classes
#include "InDetRIO_OnTrack/SiClusterOnTrack.h"
#include "TrkEventPrimitives/LocalParameters.h"
 
// for ElementLink to IdentifiableContainer PixelClusterContainer
#include "AthLinks/ElementLink.h"
#include "InDetPrepRawData/PixelClusterContainer.h"
 
class FakeTrackBuilder;
class PixelCluster;
 
namespace Trk {
class Surface;
class TrkDetElementBase;
class ITrkEventCnvTool;
}  // namespace Trk
 
namespace InDetDD {
class SiDetectorElement;
}
 
typedef ElementLink<InDet::PixelClusterContainer>
    ElementLinkToIDCPixelClusterContainer;
 
namespace InDet {
 
class PixelDetectorElement;
class LocalParameters;

 
class PixelClusterOnTrack final : public SiClusterOnTrack {
 
 public:
  friend class Trk::ITrkEventCnvTool;
  PixelClusterOnTrack();
  PixelClusterOnTrack(const PixelClusterOnTrack&) = default;
  PixelClusterOnTrack(PixelClusterOnTrack&&) = default;
  PixelClusterOnTrack& operator=(const PixelClusterOnTrack&) = default;
  PixelClusterOnTrack& operator=(PixelClusterOnTrack&&) = default;
  virtual ~PixelClusterOnTrack() = default;
  PixelClusterOnTrack(const PixelCluster* RIO,
                      Trk::LocalParameters&& locpars,
                      Amg::MatrixX&& locerr,
                      const IdentifierHash& idDE,
                      bool hasAmbiguity = false,
                      // this parameter is ignored,
                      // information taken from RIO
                      // Just kept not to break the interface to
                      // already existing code.
                      bool isbroad = false);
 

  PixelClusterOnTrack(const PixelCluster* RIO,
                      Trk::LocalParameters&& locpars,
                      Amg::MatrixX&& locerr,
                      const IdentifierHash& idDE,
                      const Amg::Vector3D& globalPosition,
                      bool hasAmbiguity = false,
                      // this parameter is ignored,
                      // information taken from RIO
                      // Just kept not to break the interface to
                      // already existing code.
                      bool isbroad = false);
 
 
  /*
   * Constuctor used by P->T converter.
   * The P->T converter calls
   * setValues method to complete the object.
   * e.g set/reset the DetectorElement
   */
  PixelClusterOnTrack(const ElementLinkToIDCPixelClusterContainer& RIO,
                      const Trk::LocalParameters& locpars,
                      const Amg::MatrixX& locerr,
                      const IdentifierHash& idDE,
                      const Identifier& id,
                      float energyLoss,
                      bool isFake,
                      bool hasClusterAmbiguity,
                      bool isbroad);
 

  virtual PixelClusterOnTrack* clone() const override final;

  virtual const Trk::Surface& associatedSurface() const override final;
 
  virtual bool rioType(Trk::RIO_OnTrackType::Type type) const override final {
    return (type == Trk::RIO_OnTrackType::PixelCluster);
  }

  virtual const PixelCluster* prepRawData() const override final;
 
  const ElementLinkToIDCPixelClusterContainer& prepRawDataLink() const;

  virtual const InDetDD::SiDetectorElement* detectorElement()
      const override final;

  bool hasClusterAmbiguity() const;
  bool isFake() const;
  float energyLoss() const;

  virtual MsgStream& dump(MsgStream& out) const override final;

  virtual std::ostream& dump(std::ostream& out) const override final;
 
 private:
  friend class PixelClusterOnTrackCnv_p1;
  friend class ::FakeTrackBuilder;

  virtual void setValues(const Trk::TrkDetElementBase* detEl,
                         const Trk::PrepRawData* prd) override final;

  ElementLinkToIDCPixelClusterContainer m_rio;

  bool m_hasClusterAmbiguity;
  bool m_isFake;
  float m_energyLoss;
  const InDetDD::SiDetectorElement* m_detEl;
};
 
inline PixelClusterOnTrack* PixelClusterOnTrack::clone() const {
  return new PixelClusterOnTrack(*this);
}
 
inline const PixelCluster* PixelClusterOnTrack::prepRawData() const {
  // somehow one has to ask first if it is valid ... otherwise it always returns
  // 0 ...
  if (m_rio.isValid())
    return m_rio.cachedElement();
  else
    return 0;
}
 
inline const ElementLinkToIDCPixelClusterContainer&
PixelClusterOnTrack::prepRawDataLink() const {
  return m_rio;
}
 
inline const InDetDD::SiDetectorElement* PixelClusterOnTrack::detectorElement()
    const {
  return m_detEl;
}
 
inline bool PixelClusterOnTrack::hasClusterAmbiguity() const {
  return m_hasClusterAmbiguity;
}
 
inline bool PixelClusterOnTrack::isFake() const {
  return m_isFake;
}
 
inline float PixelClusterOnTrack::energyLoss() const {
  return m_energyLoss;
}
 
}  // namespace InDet
 
#endif  // TRKRIO_ONTRACK_SICLUSTERONTRACK_H