class that is similar to MaterialEffectsOnTrack, but has 'set' methods for more flexibility during track fitting More...

#include <GXFMaterialEffects.h>

Collaboration diagram for Trk::GXFMaterialEffects:

Public Member Functions
	GXFMaterialEffects (const MaterialEffectsOnTrack &)
	Constructor that captures the properties of a more standard MaterialEffectsOnTrack object. More...

	GXFMaterialEffects ()=default

	GXFMaterialEffects (const GXFMaterialEffects &rhs)

GXFMaterialEffects &	operator= (const GXFMaterialEffects &rhs)

	GXFMaterialEffects (GXFMaterialEffects &&rhs)=default

GXFMaterialEffects &	operator= (GXFMaterialEffects &&rhs)=default

	~GXFMaterialEffects ()=default

void	setScatteringAngles (double, double)

void	setScatteringSigmas (double, double)

double	x0 () const

void	setX0 (double)

double	deltaPhi () const

double	measuredDeltaPhi () const

void	setMeasuredDeltaPhi (double)

double	deltaTheta () const

double	sigmaDeltaPhi () const

double	sigmaDeltaTheta () const

double	deltaE () const

void	setEloss (std::unique_ptr< EnergyLoss >)
	Set the energy loss properties of this material effect. More...

double	sigmaDeltaE () const

double	sigmaDeltaEPos () const

double	sigmaDeltaENeg () const

double	sigmaDeltaEAve () const

void	setDeltaE (double)

void	setSigmaDeltaE (double)

void	setSigmaDeltaEPos (double)

void	setSigmaDeltaENeg (double)

double	delta_p () const

void	setdelta_p (double)

void	setKink (bool)

bool	isKink () const

void	setMeasuredEloss (bool)

bool	isMeasuredEloss () const

const Surface &	associatedSurface () const

void	setSurface (const Surface *)
	Set the surface for this material effects instance. More...

std::unique_ptr< MaterialEffectsBase >	makeMEOT () const

const MaterialProperties *	materialProperties () const

void	setMaterialProperties (const MaterialProperties *)
	Set the material properties of this material effects instance. More...

Private Attributes
double	m_scatphi = 0

double	m_scattheta = 0

double	m_sigmascatphi = 0

double	m_sigmascattheta = 0

double	m_x0 = 0

double	m_deltap = 0

double	m_deltae = 0

double	m_sigmadeltae = 0

double	m_sigmadeltaepos = 0

double	m_sigmadeltaeneg = 0

std::unique_ptr< const EnergyLoss >	m_eloss

const Surface *	m_surf = nullptr

const MaterialProperties *	m_matprop = nullptr

bool	m_iskink = false

bool	m_ismeasuredeloss = false

double	m_measscatphi = 0

double	m_sintheta = 1

Detailed Description

class that is similar to MaterialEffectsOnTrack, but has 'set' methods for more flexibility during track fitting

Author: thijs.nosp@m..cor.nosp@m.nelis.nosp@m.sen@.nosp@m.cern..nosp@m.ch

Definition at line 24 of file GXFMaterialEffects.h.

Constructor & Destructor Documentation

◆ GXFMaterialEffects() [1/4]

Trk::GXFMaterialEffects::GXFMaterialEffects ( const MaterialEffectsOnTrack & meot )

Constructor that captures the properties of a more standard MaterialEffectsOnTrack object.

This is one of the possible constructors for GXFMaterialEffects. It takes as an argument a MaterialEffectsOnTrack, which is the more widely used class to represent material effects. It copies the properties of the passed object pointer.

Note: This method assumes no ownership of the passed pointer whatsoever, and ownership of the MaterialEffectsOnTrack remains the responsibility of the original owner.

Definition at line 12 of file GXFMaterialEffects.cxx.

     : m_sigmadeltae(0), m_surf(&meot.associatedSurface()) {
  
     if (meot.energyLoss() != nullptr) {
       m_deltae = meot.energyLoss()->deltaE();
       m_sigmadeltaepos = meot.energyLoss()->sigmaPlusDeltaE();
       m_sigmadeltaeneg = meot.energyLoss()->sigmaMinusDeltaE();
  
       if (meot.scatteringAngles() == nullptr) {
         m_eloss = std::unique_ptr<EnergyLoss>(meot.energyLoss()->clone());
         m_sigmadeltae = meot.energyLoss()->sigmaDeltaE();
       } else {
         m_eloss = nullptr;
       }
     } else {
       m_eloss = nullptr;
       m_deltae = 0;
       m_sigmadeltaepos = 0;
       m_sigmadeltaeneg = 0;
     }
  
     double x0 = meot.thicknessInX0();
     const ScatteringAngles *scatangles = meot.scatteringAngles();
  
     if ((scatangles != nullptr) && x0 > 0) {
       m_x0 = x0;
       m_sintheta = scatangles->sigmaDeltaTheta() / scatangles->sigmaDeltaPhi();
       m_scatphi = scatangles->deltaPhi();
       m_scattheta = scatangles->deltaTheta();
       m_sigmascatphi = scatangles->sigmaDeltaPhi();
       m_sigmascattheta = scatangles->sigmaDeltaTheta();
     } else {
       m_scatphi = m_scattheta = m_sigmascatphi = m_sigmascattheta = 0;
     }
   }

◆ GXFMaterialEffects() [2/4]

Trk::GXFMaterialEffects::GXFMaterialEffects ( )

default

◆ GXFMaterialEffects() [3/4]

Trk::GXFMaterialEffects::GXFMaterialEffects ( const GXFMaterialEffects & rhs )

Definition at line 48 of file GXFMaterialEffects.cxx.

     : m_scatphi (rhs.m_scatphi),
       m_scattheta (rhs.m_scattheta),
       m_sigmascatphi (rhs.m_sigmascatphi),
       m_sigmascattheta (rhs.m_sigmascattheta),
       m_x0 (rhs.m_x0),
       m_deltap (rhs.m_deltap),
       m_deltae (rhs.m_deltae),
       m_sigmadeltae (rhs.m_sigmadeltae),
       m_sigmadeltaepos (rhs.m_sigmadeltaepos),
       m_sigmadeltaeneg (rhs.m_sigmadeltaeneg),
       m_eloss (std::unique_ptr<EnergyLoss>(rhs.m_eloss != nullptr ? rhs.m_eloss->clone() : nullptr)),
       m_surf (rhs.m_surf),
       m_matprop (rhs.m_matprop),
       m_iskink (rhs.m_iskink),
       m_ismeasuredeloss (rhs.m_ismeasuredeloss),
       m_measscatphi (rhs.m_measscatphi),
       m_sintheta (rhs.m_sintheta)
   {
   }

◆ GXFMaterialEffects() [4/4]

Trk::GXFMaterialEffects::GXFMaterialEffects ( GXFMaterialEffects && rhs )

default

◆ ~GXFMaterialEffects()

Trk::GXFMaterialEffects::~GXFMaterialEffects ( )

default

Member Function Documentation

◆ associatedSurface()

const Surface & Trk::GXFMaterialEffects::associatedSurface ( ) const

Definition at line 202 of file GXFMaterialEffects.cxx.

                                                              {
     return *m_surf;
   }

◆ delta_p()

double Trk::GXFMaterialEffects::delta_p ( ) const

Definition at line 178 of file GXFMaterialEffects.cxx.

                                            {
     return m_deltap;
   }

◆ deltaE()

double Trk::GXFMaterialEffects::deltaE ( ) const

Definition at line 131 of file GXFMaterialEffects.cxx.

                                           {
     return m_deltae;
   }

◆ deltaPhi()

double Trk::GXFMaterialEffects::deltaPhi ( ) const

Definition at line 111 of file GXFMaterialEffects.cxx.

                                             {
     return m_scatphi;
   }

◆ deltaTheta()

double Trk::GXFMaterialEffects::deltaTheta ( ) const

Definition at line 119 of file GXFMaterialEffects.cxx.

                                               {
     return m_scattheta;
   }

◆ isKink()

bool Trk::GXFMaterialEffects::isKink ( ) const

Definition at line 190 of file GXFMaterialEffects.cxx.

                                         {
     return m_iskink;
   }

◆ isMeasuredEloss()

bool Trk::GXFMaterialEffects::isMeasuredEloss ( ) const

Definition at line 198 of file GXFMaterialEffects.cxx.

                                                  {
     return m_ismeasuredeloss;
   }

◆ makeMEOT()

std::unique_ptr< MaterialEffectsBase > Trk::GXFMaterialEffects::makeMEOT ( ) const

Definition at line 210 of file GXFMaterialEffects.cxx.

                                                                         {
     std::optional<ScatteringAngles> scatangles;
  
     if (m_sigmascattheta != 0) {
       scatangles = ScatteringAngles(m_scatphi, m_scattheta, m_sigmascatphi, m_sigmascattheta);
     }
     
     std::bitset<MaterialEffectsBase::NumberOfMaterialEffectsTypes> typePattern;
     typePattern.set(MaterialEffectsBase::FittedMaterialEffects);
     std::unique_ptr<const Trk::EnergyLoss> neweloss;
     
     if (m_deltae != 0) {
       if (m_eloss != nullptr) {
         neweloss.reset(m_eloss->clone());
       } else {
         neweloss = std::make_unique<Trk::EnergyLoss>(m_deltae, m_sigmadeltae, m_sigmadeltaeneg, m_sigmadeltaepos);
       }
     }
  
     return std::make_unique<MaterialEffectsOnTrack>(
       m_x0, scatangles, std::move(neweloss), *m_surf, typePattern);
   }

◆ materialProperties()

const Trk::MaterialProperties * Trk::GXFMaterialEffects::materialProperties ( ) const

Definition at line 233 of file GXFMaterialEffects.cxx.

                                                                              {
     return m_matprop;
   }

◆ measuredDeltaPhi()

double Trk::GXFMaterialEffects::measuredDeltaPhi ( ) const

Definition at line 115 of file GXFMaterialEffects.cxx.

                                                     {
     return m_measscatphi;
   }

◆ operator=() [1/2]

GXFMaterialEffects & Trk::GXFMaterialEffects::operator= ( const GXFMaterialEffects & rhs )

Definition at line 69 of file GXFMaterialEffects.cxx.

                                                                                      {
     if (this != &rhs) {
       m_eloss = std::unique_ptr<EnergyLoss>(rhs.m_eloss != nullptr ? rhs.m_eloss->clone() : nullptr);
       m_scatphi = rhs.m_scatphi;
       m_scattheta = rhs.m_scattheta;
       m_sigmascatphi = rhs.m_sigmascatphi;
       m_sigmascattheta = rhs.m_sigmascattheta;
       m_x0 = rhs.m_x0;
       m_deltap = rhs.m_deltap;
       m_deltae = rhs.m_deltae;
       m_sigmadeltae = rhs.m_sigmadeltae;
       m_sigmadeltaepos = rhs.m_sigmadeltaepos;
       m_sigmadeltaeneg = rhs.m_sigmadeltaeneg;
       m_iskink = rhs.m_iskink;
       m_ismeasuredeloss = rhs.m_ismeasuredeloss;
       m_surf = rhs.m_surf;
       m_matprop = rhs.m_matprop;
       m_measscatphi = rhs.m_measscatphi;
       m_sintheta = rhs.m_sintheta;
     }
     
     return *this;
   }

◆ operator=() [2/2]

GXFMaterialEffects& Trk::GXFMaterialEffects::operator= ( GXFMaterialEffects && rhs )

default

◆ setdelta_p()

void Trk::GXFMaterialEffects::setdelta_p ( double delta_p )

Definition at line 182 of file GXFMaterialEffects.cxx.

                                                     {
     m_deltap = delta_p;
   }

◆ setDeltaE()

void Trk::GXFMaterialEffects::setDeltaE ( double deltae )

Definition at line 170 of file GXFMaterialEffects.cxx.

                                                   {
     m_deltae = deltae;
   }

◆ setEloss()

void Trk::GXFMaterialEffects::setEloss ( std::unique_ptr< EnergyLoss > eloss )

Set the energy loss properties of this material effect.

This method sets the energy loss properties of the material effects instance through an instance of Trk::EnergyLoss.

Note: This method assumes full ownership of the passed pointer.

Definition at line 135 of file GXFMaterialEffects.cxx.

                                                                       {
     m_eloss = std::move(eloss);
   }

◆ setKink()

void Trk::GXFMaterialEffects::setKink ( bool iskink )

Definition at line 186 of file GXFMaterialEffects.cxx.

                                               {
     m_iskink = iskink;
   }

◆ setMaterialProperties()

void Trk::GXFMaterialEffects::setMaterialProperties ( const MaterialProperties * matprop )

Set the material properties of this material effects instance.

Note: The argument pointer is a raw, non-owning pointer and the method assumes no ownership of the pointee.

Definition at line 237 of file GXFMaterialEffects.cxx.

                                                                                       {
     m_matprop = matprop;
   }

◆ setMeasuredDeltaPhi()

void Trk::GXFMaterialEffects::setMeasuredDeltaPhi ( double measdf )

Definition at line 174 of file GXFMaterialEffects.cxx.

                                                             {
     m_measscatphi = measdf;
   }

◆ setMeasuredEloss()

void Trk::GXFMaterialEffects::setMeasuredEloss ( bool ismeasuredeloss )

Definition at line 194 of file GXFMaterialEffects.cxx.

                                                                 {
     m_ismeasuredeloss = ismeasuredeloss;
   }

◆ setScatteringAngles()

void Trk::GXFMaterialEffects::setScatteringAngles	(	double	scatphi,
		double	scattheta
	)

Definition at line 93 of file GXFMaterialEffects.cxx.

                                                                                {
     m_scatphi = scatphi;
     m_scattheta = scattheta;
   }

◆ setScatteringSigmas()

void Trk::GXFMaterialEffects::setScatteringSigmas	(	double	scatsigmaphi,
		double	scatsigmatheta
	)

Definition at line 98 of file GXFMaterialEffects.cxx.

                                                                                          {
     m_sigmascatphi = scatsigmaphi;
     m_sigmascattheta = scatsigmatheta;
   }

◆ setSigmaDeltaE()

void Trk::GXFMaterialEffects::setSigmaDeltaE ( double sigmadeltae )

Definition at line 158 of file GXFMaterialEffects.cxx.

                                                             {
     m_sigmadeltae = sigmadeltae;
   }

◆ setSigmaDeltaENeg()

void Trk::GXFMaterialEffects::setSigmaDeltaENeg ( double sigmadeltaeneg )

Definition at line 166 of file GXFMaterialEffects.cxx.

                                                                   {
     m_sigmadeltaeneg = sigmadeltaeneg;
   }

◆ setSigmaDeltaEPos()

void Trk::GXFMaterialEffects::setSigmaDeltaEPos ( double sigmadeltaepos )

Definition at line 162 of file GXFMaterialEffects.cxx.

                                                                   {
     m_sigmadeltaepos = sigmadeltaepos;
   }

◆ setSurface()

void Trk::GXFMaterialEffects::setSurface ( const Surface * surf )

Set the surface for this material effects instance.

This method links the instance of GXFMaterialEffects to a surface. The surface can then be accessed through the surface() method.

Note: This method does NOT assume ownership of the passed pointer.

Definition at line 206 of file GXFMaterialEffects.cxx.

                                                           {
     m_surf = surf;
   }

◆ setX0()

void Trk::GXFMaterialEffects::setX0 ( double x0 )

Definition at line 107 of file GXFMaterialEffects.cxx.

                                           {
     m_x0 = x0;
   }

◆ sigmaDeltaE()

double Trk::GXFMaterialEffects::sigmaDeltaE ( ) const

Definition at line 139 of file GXFMaterialEffects.cxx.

                                                {
     return m_sigmadeltae;
   }

◆ sigmaDeltaEAve()

double Trk::GXFMaterialEffects::sigmaDeltaEAve ( ) const

Definition at line 151 of file GXFMaterialEffects.cxx.

                                                   {
     if (m_eloss != nullptr) {
       return m_eloss->sigmaDeltaE();
     }
     return 0;
   }

◆ sigmaDeltaENeg()

double Trk::GXFMaterialEffects::sigmaDeltaENeg ( ) const

Definition at line 147 of file GXFMaterialEffects.cxx.

                                                   {
     return m_sigmadeltaeneg;
   }

◆ sigmaDeltaEPos()

double Trk::GXFMaterialEffects::sigmaDeltaEPos ( ) const

Definition at line 143 of file GXFMaterialEffects.cxx.

                                                   {
     return m_sigmadeltaepos;
   }

◆ sigmaDeltaPhi()

double Trk::GXFMaterialEffects::sigmaDeltaPhi ( ) const

Definition at line 123 of file GXFMaterialEffects.cxx.

                                                  {
     return m_sigmascatphi;
   }

◆ sigmaDeltaTheta()

double Trk::GXFMaterialEffects::sigmaDeltaTheta ( ) const

Definition at line 127 of file GXFMaterialEffects.cxx.

                                                    {
     return m_sigmascattheta;
   }

◆ x0()

double Trk::GXFMaterialEffects::x0 ( ) const

Definition at line 103 of file GXFMaterialEffects.cxx.

                                       {
     return m_x0;
   }

Member Data Documentation

◆ m_deltae

double Trk::GXFMaterialEffects::m_deltae = 0

private

Definition at line 112 of file GXFMaterialEffects.h.

◆ m_deltap

double Trk::GXFMaterialEffects::m_deltap = 0

private

Definition at line 111 of file GXFMaterialEffects.h.

◆ m_eloss

std::unique_ptr<const EnergyLoss> Trk::GXFMaterialEffects::m_eloss

private

Definition at line 116 of file GXFMaterialEffects.h.

◆ m_iskink

bool Trk::GXFMaterialEffects::m_iskink = false

private

Definition at line 120 of file GXFMaterialEffects.h.

◆ m_ismeasuredeloss

bool Trk::GXFMaterialEffects::m_ismeasuredeloss = false

private

Definition at line 121 of file GXFMaterialEffects.h.

◆ m_matprop

const MaterialProperties* Trk::GXFMaterialEffects::m_matprop = nullptr

private

Definition at line 119 of file GXFMaterialEffects.h.

◆ m_measscatphi

double Trk::GXFMaterialEffects::m_measscatphi = 0

private

Definition at line 122 of file GXFMaterialEffects.h.

◆ m_scatphi

double Trk::GXFMaterialEffects::m_scatphi = 0

private

Definition at line 106 of file GXFMaterialEffects.h.

◆ m_scattheta

double Trk::GXFMaterialEffects::m_scattheta = 0

private

Definition at line 107 of file GXFMaterialEffects.h.

◆ m_sigmadeltae

double Trk::GXFMaterialEffects::m_sigmadeltae = 0

private

Definition at line 113 of file GXFMaterialEffects.h.

◆ m_sigmadeltaeneg

double Trk::GXFMaterialEffects::m_sigmadeltaeneg = 0

private

Definition at line 115 of file GXFMaterialEffects.h.

◆ m_sigmadeltaepos

double Trk::GXFMaterialEffects::m_sigmadeltaepos = 0

private

Definition at line 114 of file GXFMaterialEffects.h.

◆ m_sigmascatphi

double Trk::GXFMaterialEffects::m_sigmascatphi = 0

private

Definition at line 108 of file GXFMaterialEffects.h.

◆ m_sigmascattheta

double Trk::GXFMaterialEffects::m_sigmascattheta = 0

private

Definition at line 109 of file GXFMaterialEffects.h.

◆ m_sintheta

double Trk::GXFMaterialEffects::m_sintheta = 1

private

Definition at line 123 of file GXFMaterialEffects.h.

◆ m_surf

const Surface* Trk::GXFMaterialEffects::m_surf = nullptr

private

Definition at line 118 of file GXFMaterialEffects.h.

◆ m_x0

double Trk::GXFMaterialEffects::m_x0 = 0

private

Definition at line 110 of file GXFMaterialEffects.h.

The documentation for this class was generated from the following files:

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GXFMaterialEffects() [1/4]

◆ GXFMaterialEffects() [2/4]

◆ GXFMaterialEffects() [3/4]

◆ GXFMaterialEffects() [4/4]

◆ ~GXFMaterialEffects()

Member Function Documentation

◆ associatedSurface()

◆ delta_p()

◆ deltaE()

◆ deltaPhi()

◆ deltaTheta()

◆ isKink()

◆ isMeasuredEloss()

◆ makeMEOT()

◆ materialProperties()

◆ measuredDeltaPhi()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ setdelta_p()

◆ setDeltaE()

◆ setEloss()

◆ setKink()

◆ setMaterialProperties()

◆ setMeasuredDeltaPhi()

◆ setMeasuredEloss()

◆ setScatteringAngles()

◆ setScatteringSigmas()

◆ setSigmaDeltaE()

◆ setSigmaDeltaENeg()

◆ setSigmaDeltaEPos()

◆ setSurface()

◆ setX0()

◆ sigmaDeltaE()

◆ sigmaDeltaEAve()

◆ sigmaDeltaENeg()

◆ sigmaDeltaEPos()

◆ sigmaDeltaPhi()

◆ sigmaDeltaTheta()

◆ x0()

Member Data Documentation

◆ m_deltae

◆ m_deltap

◆ m_eloss

◆ m_iskink

◆ m_ismeasuredeloss

◆ m_matprop

◆ m_measscatphi

◆ m_scatphi

◆ m_scattheta

◆ m_sigmadeltae

◆ m_sigmadeltaeneg

◆ m_sigmadeltaepos

◆ m_sigmascatphi

◆ m_sigmascattheta

◆ m_sintheta

◆ m_surf

◆ m_x0