EstimatedBremOnTrack.h

Go to the documentation of this file.

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

// EstimatedBremOnTrack.h, (c) ATLAS Detector software
 
#ifndef TRKMATERIALONTRACK_EstimatedBremOnTrack_H
#define TRKMATERIALONTRACK_EstimatedBremOnTrack_H
 
#include "TrkEventPrimitives/PropDirection.h"
#include "TrkMaterialOnTrack/MaterialEffectsBase.h"
#include <iosfwd>
#include <memory>
 
class MsgStream;
 
namespace Trk {
 
class Surface;

class EstimatedBremOnTrack final : public MaterialEffectsBase
{
public:
  EstimatedBremOnTrack() = default;
  EstimatedBremOnTrack(double thicknessInX0,
                       double retainedEnFraction,
                       double sigmaRetainedEnFraction,
                       double sigmaQoverPsquared,
                       const Surface& sf,
                       const SearchDirection searchDirection = bothway);
  EstimatedBremOnTrack(const EstimatedBremOnTrack& ebrot) = default;
  EstimatedBremOnTrack& operator=(const EstimatedBremOnTrack& rhs) = default;
  EstimatedBremOnTrack(EstimatedBremOnTrack&& ebrot) noexcept = default;
  EstimatedBremOnTrack& operator=(EstimatedBremOnTrack&& rhs) noexcept = default;
  virtual ~EstimatedBremOnTrack() = default;
  
  MaterialEffectsBase::MaterialEffectsDerivedType 
  derivedType() const override final {
    return MaterialEffectsBase::ESTIMATED_BREM_ON_TRACK;
  }

  virtual EstimatedBremOnTrack* clone() const override final;

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

  double retainedEnFraction() const;

  double sigmaRetainedEnFraction() const;

  double sigmaQoverPsquared() const;

  SearchDirection searchDirection() const;

  virtual MsgStream& dump(MsgStream& sl) const override final;
  virtual std::ostream& dump(std::ostream& sl) const override final;
 
private:
  double m_retainedEnFraction{ 0.0 };
  double m_sigmaRetainedEnFraction{ 0.0 };
  double m_sigmaQoverPsquared{ 0.0 };

  SearchDirection m_bremSearchDirection{ Trk::undefinedDirection };
};
 
inline EstimatedBremOnTrack*
EstimatedBremOnTrack::clone() const
{
  return new EstimatedBremOnTrack(*this);
}
 
inline double
EstimatedBremOnTrack::retainedEnFraction() const
{
  return m_retainedEnFraction;
}
 
inline double
EstimatedBremOnTrack::sigmaRetainedEnFraction() const
{
  return m_sigmaRetainedEnFraction;
}
 
inline double
EstimatedBremOnTrack::sigmaQoverPsquared() const
{
  return m_sigmaQoverPsquared;
}
 
inline SearchDirection
EstimatedBremOnTrack::searchDirection() const
{
  return m_bremSearchDirection;
}
 
} // end ns
 
#endif // TRKMATERIALONTRACK_ESTIMATEDBREMONTRACK_H