ATLAS Offline Software
Loading...
Searching...
No Matches
MuonExperimental::Gx2fMaterialProperties::ScatteringAtSurface Struct Reference

Auxiliary struct to describe the material scattering at a surface. More...

#include <Chi2Fitter.h>

Collaboration diagram for MuonExperimental::Gx2fMaterialProperties::ScatteringAtSurface:

Public Member Functions

constexpr bool isValid () const
 Is the scattering uncertainty valid.
constexpr double sigma () const
 Uncertainty on the scattering angle.
 ScatteringAtSurface ()=default
 Default constructor to construct an invalid scatterer.
 ScatteringAtSurface (const double sigma)
 Constructor taking the width of the scatterer.
ScatteringAtSurface & operator+= (const ScatteringAtSurface &other)

Public Attributes

bool m_isValid {false}
 Flag toggling whether the scatterer is valid.
double m_sigma {0.}
 The inverse uncertainty on the scattering angles calculated using e.g.

Detailed Description

Auxiliary struct to describe the material scattering at a surface.

Definition at line 126 of file Chi2Fitter.h.

Constructor & Destructor Documentation

◆ ScatteringAtSurface() [1/2]

MuonExperimental::Gx2fMaterialProperties::ScatteringAtSurface::ScatteringAtSurface ( )
default

Default constructor to construct an invalid scatterer.

◆ ScatteringAtSurface() [2/2]

MuonExperimental::Gx2fMaterialProperties::ScatteringAtSurface::ScatteringAtSurface ( const double sigma)
inlineexplicit

Constructor taking the width of the scatterer.

Parameters
sigmaThe width of the scatterer

Definition at line 135 of file Chi2Fitter.h.

136 : m_isValid{sigma > Acts::s_epsilon}, m_sigma{sigma} {}
bool m_isValid
Flag toggling whether the scatterer is valid.
Definition Chi2Fitter.h:147
constexpr double sigma() const
Uncertainty on the scattering angle.
Definition Chi2Fitter.h:130
double m_sigma
The inverse uncertainty on the scattering angles calculated using e.g.
Definition Chi2Fitter.h:150

Member Function Documentation

◆ isValid()

bool MuonExperimental::Gx2fMaterialProperties::ScatteringAtSurface::isValid ( ) const
inlineconstexpr

Is the scattering uncertainty valid.

Definition at line 128 of file Chi2Fitter.h.

128{ return m_isValid; }

◆ operator+=()

ScatteringAtSurface & MuonExperimental::Gx2fMaterialProperties::ScatteringAtSurface::operator+= ( const ScatteringAtSurface & other)
inline

Definition at line 138 of file Chi2Fitter.h.

138 {
139 if (&other != this && other.isValid()) {
140 m_sigma += other.sigma();
141 m_isValid = true;
142 }
143
144 return *this;
145 }

◆ sigma()

double MuonExperimental::Gx2fMaterialProperties::ScatteringAtSurface::sigma ( ) const
inlineconstexpr

Uncertainty on the scattering angle.

Definition at line 130 of file Chi2Fitter.h.

130{ return m_sigma; }

Member Data Documentation

◆ m_isValid

bool MuonExperimental::Gx2fMaterialProperties::ScatteringAtSurface::m_isValid {false}

Flag toggling whether the scatterer is valid.

Definition at line 147 of file Chi2Fitter.h.

147{false};

◆ m_sigma

double MuonExperimental::Gx2fMaterialProperties::ScatteringAtSurface::m_sigma {0.}

The inverse uncertainty on the scattering angles calculated using e.g.

the Highland formula

Definition at line 150 of file Chi2Fitter.h.

150{0.};

The documentation for this struct was generated from the following file: