ActsExamples::Digitization::GaussClipped Struct Reference

#include <acts/blob/sPHENIX/Examples/Algorithms/Digitization/include/ActsExamples/Digitization/Smearers.hpp>

Public Member Functions
	GaussClipped (double sigma_, const std::pair< double, double > &range_)
	Construct with a.
	range (range_)
Acts::Result< std::pair < double, double > >	operator() (double value, RandomEngine &rnd) const

Public Attributes
double	sigma
size_t	maxAttemps = 1000
std::pair< double, double >	range

Detailed Description

Gaussian smearing of a single parameter with clipping.

In case a hit is smeared outside the range, the smearing will be repeated, until a maximum attempt number is reached

Definition at line 100 of file Smearers.hpp.

View newest version in sPHENIX GitHub at line 100 of file Smearers.hpp

Constructor & Destructor Documentation

ActsExamples::Digitization::GaussClipped::GaussClipped ( double  sigma_, const std::pair< double, double > &  range_  )

inline

Construct with a.

Parameters

sigma	standard deviation and
range

Definition at line 109 of file Smearers.hpp.

View newest version in sPHENIX GitHub at line 109 of file Smearers.hpp

Member Function Documentation

Acts::Result<std::pair<double, double> > ActsExamples::Digitization::GaussClipped::operator() ( double  value, RandomEngine &  rnd  ) const

inline

Call operator for the SmearFunction caller interface.

Parameters

value	parameter to be smeared
rnd	random generator to be used for the call

Note

it will smear until inside range, unless maxAttempts is reached

Returns

a Result that is ok() when inside range, other DigitizationError

Definition at line 120 of file Smearers.hpp.

View newest version in sPHENIX GitHub at line 120 of file Smearers.hpp

References dist(), maxAttemps, range, and sigma.

Here is the call graph for this function:

ActsExamples::Digitization::GaussClipped::range ( range_  )

inline

Definition at line 110 of file Smearers.hpp.

View newest version in sPHENIX GitHub at line 110 of file Smearers.hpp

Member Data Documentation

size_t ActsExamples::Digitization::GaussClipped::maxAttemps = 1000

Definition at line 103 of file Smearers.hpp.

View newest version in sPHENIX GitHub at line 103 of file Smearers.hpp

Referenced by operator()().

std::pair<double, double> ActsExamples::Digitization::GaussClipped::range

Initial value:

= {std::numeric_limits<double>::lowest(),
                                     std::numeric_limits<double>::max()}

Definition at line 105 of file Smearers.hpp.

View newest version in sPHENIX GitHub at line 105 of file Smearers.hpp

Referenced by operator()().

double ActsExamples::Digitization::GaussClipped::sigma

Definition at line 101 of file Smearers.hpp.

View newest version in sPHENIX GitHub at line 101 of file Smearers.hpp

Referenced by operator()().

---

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

• acts/blob/sPHENIX/Examples/Algorithms/Digitization/include/ActsExamples/Digitization/Smearers.hpp