EnergyLoss.h

Go to the documentation of this file.

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

// EnergyLoss.h, (c) ATLAS Detector software
 
#ifndef TRKMATERIALONTRACK_ENERGYLOSS_H
#define TRKMATERIALONTRACK_ENERGYLOSS_H
 
#include <cassert>
#include <cmath>
#include <iosfwd>
 
class MsgStream;
class TrackCollectionCnv;
 
namespace Trk {

class EnergyLoss
{
  friend class ::TrackCollectionCnv;
 
public:
  EnergyLoss() = default;
  EnergyLoss(const EnergyLoss&) = default;
  EnergyLoss(EnergyLoss&&) noexcept = default;
  EnergyLoss& operator=(const EnergyLoss&) = default;
  EnergyLoss& operator=(EnergyLoss&&) noexcept = default;
  virtual ~EnergyLoss() = default;
  EnergyLoss(double deltaE,
             double sigmaDeltaE,
             double sigmaMinusDeltaE = 0.0,
             double sigmaPlusDeltaE = 0.0);

  EnergyLoss(double deltaE,
             double sigmaDeltaE,
             double mean_ioni,
             double sigma_ioni,
             double mean_rad,
             double sigma_rad);

  EnergyLoss(double deltaE,
             double sigmaDeltaE,
             double sigmaMinusDeltaE,
             double sigmaPlusDeltaE,
             double mean_ioni,
             double sigma_ioni,
             double mean_rad,
             double sigma_rad,
             double length);

  virtual EnergyLoss* clone() const;

  double deltaE() const;

  double sigmaDeltaE() const;

  double sigmaMinusDeltaE() const;

  double sigmaPlusDeltaE() const;
 
  // access to eloss components
  double meanIoni() const;
  double sigmaIoni() const;
  double meanRad() const;
  double sigmaRad() const;
  double length() const;
 
  // update from mean values
  void update(double ioni,
              double sigi,
              double rad,
              double sigr,
              bool mpv = false);
 
  // update
  void update(const EnergyLoss&, bool mpv = false);
 
  // set
  void set(double eLoss,
           double sigde,
           double ioni,
           double sigi,
           double rad,
           double sigr);

  virtual MsgStream& dump(MsgStream& sl) const;
  virtual std::ostream& dump(std::ostream& sl) const;
 
private:
  double m_deltaE = 0;
  double m_sigmaDeltaE = 0;
  double m_sigmaMinusDeltaE = 0;
  double m_sigmaPlusDeltaE = 0;
  // additional information about components (cache only, not persistified)
  double m_mean_ioni = 0; // mean value for ionization
  double m_sig_ioni = 0;  // sigma for ionization
  double m_mean_rad = 0;  // mean value for radiation
  double m_sig_rad = 0;   // sigma for radiation
  double m_length = 0;    // 3D length of material
};

MsgStream&
operator<<(MsgStream& sl, const EnergyLoss& eloss);

std::ostream&
operator<<(std::ostream& sl, const EnergyLoss& eloss);
 
} // end ns
 
#include "TrkMaterialOnTrack/EnergyLoss.icc"
#endif // TRKMATERIALONTRACK_ENERGYLOSS_H