Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Acts::FreeToBoundCorrection Struct Reference

Free to bound transformation Correction configuration class. More...

#include <acts/blob/sPHENIX/Core/include/Acts/EventData/detail/CorrectedTransformationFreeToBound.hpp>

Public Member Functions

 FreeToBoundCorrection ()=default
 Default constructor.
 
 FreeToBoundCorrection (bool apply_, ActsScalar alpha_, ActsScalar beta_)
 
 FreeToBoundCorrection (bool apply_)
 
 operator bool () const
 Return boolean for applying correction or not.
 

Public Attributes

bool apply = false
 Apply correction or not.
 
ActsScalar alpha = 0.1
 UKF tuning parameters.
 
ActsScalar beta = 2
 
ActsScalar cosIncidentAngleMinCutoff = 1e-5
 The cutoff of incident angles cosine for correction.
 
ActsScalar cosIncidentAngleMaxCutoff = 0.99500417
 

Detailed Description

Free to bound transformation Correction configuration class.

Definition at line 26 of file CorrectedTransformationFreeToBound.hpp.

View newest version in sPHENIX GitHub at line 26 of file CorrectedTransformationFreeToBound.hpp

Constructor & Destructor Documentation

Acts::FreeToBoundCorrection::FreeToBoundCorrection ( )
default

Default constructor.

Acts::FreeToBoundCorrection::FreeToBoundCorrection ( bool  apply_,
ActsScalar  alpha_,
ActsScalar  beta_ 
)

Construct from boolean and UKF parameters (alpha, beta)

Parameters
apply_Whether to apply correction
alpha_The UKF tuning parameter alpha
beta_The UKF tuning parameter beta

Definition at line 25 of file CorrectedTransformationFreeToBound.cpp.

View newest version in sPHENIX GitHub at line 25 of file CorrectedTransformationFreeToBound.cpp

Acts::FreeToBoundCorrection::FreeToBoundCorrection ( bool  apply_)
explicit

Construct from boolean only

Parameters
apply_Whether to apply correction

Definition at line 30 of file CorrectedTransformationFreeToBound.cpp.

View newest version in sPHENIX GitHub at line 30 of file CorrectedTransformationFreeToBound.cpp

Member Function Documentation

Acts::FreeToBoundCorrection::operator bool ( ) const

Return boolean for applying correction or not.

Definition at line 33 of file CorrectedTransformationFreeToBound.cpp.

View newest version in sPHENIX GitHub at line 33 of file CorrectedTransformationFreeToBound.cpp

Member Data Documentation

ActsScalar Acts::FreeToBoundCorrection::alpha = 0.1

UKF tuning parameters.

Definition at line 31 of file CorrectedTransformationFreeToBound.hpp.

View newest version in sPHENIX GitHub at line 31 of file CorrectedTransformationFreeToBound.hpp

Referenced by Acts::detail::CorrectedFreeToBoundTransformer::CorrectedFreeToBoundTransformer().

bool Acts::FreeToBoundCorrection::apply = false

Apply correction or not.

Definition at line 28 of file CorrectedTransformationFreeToBound.hpp.

View newest version in sPHENIX GitHub at line 28 of file CorrectedTransformationFreeToBound.hpp

Referenced by Acts::Test::BOOST_AUTO_TEST_CASE().

ActsScalar Acts::FreeToBoundCorrection::beta = 2
ActsScalar Acts::FreeToBoundCorrection::cosIncidentAngleMaxCutoff = 0.99500417
ActsScalar Acts::FreeToBoundCorrection::cosIncidentAngleMinCutoff = 1e-5

The cutoff of incident angles cosine for correction.

Definition at line 35 of file CorrectedTransformationFreeToBound.hpp.

View newest version in sPHENIX GitHub at line 35 of file CorrectedTransformationFreeToBound.hpp

Referenced by Acts::detail::CorrectedFreeToBoundTransformer::CorrectedFreeToBoundTransformer().


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