Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ActsAlignment::AlignmentOptions< fit_options_t > Struct Template Reference

Options for align() call. More...

#include <acts/blob/sPHENIX/Alignment/include/ActsAlignment/Kernel/Alignment.hpp>

+ Collaboration diagram for ActsAlignment::AlignmentOptions< fit_options_t >:

Public Member Functions

 AlignmentOptions ()=delete
 Deleted default constructor.
 
 AlignmentOptions (const fit_options_t &fOptions, const AlignedTransformUpdater &aTransformUpdater, const std::vector< Acts::DetectorElementBase * > &aDetElements={}, double chi2CutOff=0.5, const std::pair< size_t, double > &deltaChi2CutOff={5, 0.01}, size_t maxIters=5, const std::map< unsigned int, AlignmentMask > &iterState={})
 

Public Attributes

fit_options_t fitOptions
 
AlignedTransformUpdater alignedTransformUpdater = nullptr
 The updater to the aligned transform.
 
std::vector
< Acts::DetectorElementBase * > 
alignedDetElements
 
double averageChi2ONdfCutOff = 0.5
 
std::pair< size_t, doubledeltaAverageChi2ONdfCutOff = {5, 0.01}
 
size_t maxIterations = 5
 
std::map< unsigned int,
AlignmentMask
iterationState
 

Detailed Description

template<typename fit_options_t>
struct ActsAlignment::AlignmentOptions< fit_options_t >

Options for align() call.

Template Parameters
fit_options_tThe fit options type

Definition at line 39 of file Alignment.hpp.

View newest version in sPHENIX GitHub at line 39 of file Alignment.hpp

Constructor & Destructor Documentation

template<typename fit_options_t>
ActsAlignment::AlignmentOptions< fit_options_t >::AlignmentOptions ( )
delete

Deleted default constructor.

template<typename fit_options_t>
ActsAlignment::AlignmentOptions< fit_options_t >::AlignmentOptions ( const fit_options_t &  fOptions,
const AlignedTransformUpdater aTransformUpdater,
const std::vector< Acts::DetectorElementBase * > &  aDetElements = {},
double  chi2CutOff = 0.5,
const std::pair< size_t, double > &  deltaChi2CutOff = {5, 0.01},
size_t  maxIters = 5,
const std::map< unsigned int, AlignmentMask > &  iterState = {} 
)
inline

AlignmentOptions

Parameters
fOptionsThe fit options
aTransformUpdaterThe updater to update aligned transform
aDetElementsThe alignable detector elements
chi2CufOffThe alignment chi2 tolerance
deltaChi2CutOffThe change of chi2 within a few iterations
maxItersThe alignment maximum iterations

Definition at line 52 of file Alignment.hpp.

View newest version in sPHENIX GitHub at line 52 of file Alignment.hpp

Member Data Documentation

template<typename fit_options_t>
std::vector<Acts::DetectorElementBase*> ActsAlignment::AlignmentOptions< fit_options_t >::alignedDetElements

Definition at line 75 of file Alignment.hpp.

View newest version in sPHENIX GitHub at line 75 of file Alignment.hpp

Referenced by ActsAlignment::Alignment< fitter_t >::align(), and BOOST_AUTO_TEST_CASE().

template<typename fit_options_t>
AlignedTransformUpdater ActsAlignment::AlignmentOptions< fit_options_t >::alignedTransformUpdater = nullptr

The updater to the aligned transform.

Definition at line 72 of file Alignment.hpp.

View newest version in sPHENIX GitHub at line 72 of file Alignment.hpp

Referenced by ActsAlignment::Alignment< fitter_t >::align().

template<typename fit_options_t>
double ActsAlignment::AlignmentOptions< fit_options_t >::averageChi2ONdfCutOff = 0.5

Definition at line 78 of file Alignment.hpp.

View newest version in sPHENIX GitHub at line 78 of file Alignment.hpp

Referenced by ActsAlignment::Alignment< fitter_t >::align().

template<typename fit_options_t>
std::pair<size_t, double> ActsAlignment::AlignmentOptions< fit_options_t >::deltaAverageChi2ONdfCutOff = {5, 0.01}

Definition at line 82 of file Alignment.hpp.

View newest version in sPHENIX GitHub at line 82 of file Alignment.hpp

Referenced by ActsAlignment::Alignment< fitter_t >::align().

template<typename fit_options_t>
fit_options_t ActsAlignment::AlignmentOptions< fit_options_t >::fitOptions

Definition at line 69 of file Alignment.hpp.

View newest version in sPHENIX GitHub at line 69 of file Alignment.hpp

Referenced by ActsAlignment::Alignment< fitter_t >::align().

template<typename fit_options_t>
std::map<unsigned int, AlignmentMask> ActsAlignment::AlignmentOptions< fit_options_t >::iterationState

Definition at line 88 of file Alignment.hpp.

View newest version in sPHENIX GitHub at line 88 of file Alignment.hpp

Referenced by ActsAlignment::Alignment< fitter_t >::align().

template<typename fit_options_t>
size_t ActsAlignment::AlignmentOptions< fit_options_t >::maxIterations = 5

Definition at line 85 of file Alignment.hpp.

View newest version in sPHENIX GitHub at line 85 of file Alignment.hpp

Referenced by ActsAlignment::Alignment< fitter_t >::align(), and BOOST_AUTO_TEST_CASE().


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