A CA Parameters object initialization class. More...

#include <CaInitManager.h>

Collaboration diagram for cbm::algo::ca::InitManager:

Public Member Functions
	InitManager ()=default
	Default constructor.

	~InitManager ()=default
	Destructor.

	InitManager (const InitManager &)=delete
	Copy constructor is forbidden.

	InitManager (InitManager &&)=delete
	Move constructor is forbidden.

InitManager &	operator= (const InitManager &)=delete
	Copy assignment operator is forbidden.

InitManager &	operator= (InitManager &&)=delete
	Move assignment operator is forbidden.

void	AddStation (const StationInitializer &station)
	Adds a tracking station to the geometry.

void	CheckInit ()
	Provides final checks of the parameters object.

void	ClearCAIterations ()
	Clears vector of CA track finder iterations.

void	ClearSetupInfo ()
	Clears vector of base setup.

bool	FormParametersContainer ()
	Forms parameters container.

const std::string &	GetDetectorName (EDetectorID detId) const
	Gets name of the detector.

int	GetGhostSuppression () const
	Gets ghost suppression flag.

const std::string &	GetInputConfigMain () const
	Gets a name of the main input configuration file.

const std::string &	GetInputConfigUser () const
	Gets a name of the user input configuration file.

const InitController_t &	GetInitController () const
	Gets a const reference to ca::ObjectInitController.

int	GetNstationsActive () const
	Gets total number of active stations.

int	GetNstationsActive (EDetectorID detectorID) const
	Gets number of active stations for given detector ID.

int	GetNstationsGeometry () const
	Gets total number of stations, provided by setup geometry.

int	GetNstationsGeometry (EDetectorID detectorID) const
	Gets number of stations, provided by setup geometry for given detector ID.

const std::string &	GetOutputConfigName () const
	Gets a name of the output configuration file.

std::vector< StationInitializer > &	GetStationInfo ()
	Gets a reference to the stations array.

void	InitStationLayout ()
	Initializes station layout.

void	InitTargetField (double zStep)
	Calculates kf::FieldValue and L1FieldReference values for a selected step in z-axis from the target position.

bool	IsActive (EDetectorID detectorID) const
	Checks, if the detector is active.

bool	IsPresent (EDetectorID detectorID) const
	Checks, if the detector is present in the geometry.

void	PushBackCAIteration (const Iteration &iteration)
	Pushes an CA track finder iteration into a sequence of iteration using reference.

void	PushBackCAIteration (const Iteration *pIteration)
	Pushes an CA track finder iteration into a sequence of iteration using raw pointer.

void	PushBackCAIteration (const std::unique_ptr< Iteration > &puIteration)
	Pushes an CA track finder iteration into a sequence of iteration using std::unique_ptr.

void	ReadInputConfigs ()
	Reads main and user parameters configs.

void	ReadGeometrySetup (const std::string &fileName)
	Reads geometry setup from file.

void	ReadParametersObject (const std::string &fileName)
	Reads parameters object from boost-serialized binary file.

void	ReadSearchWindows (const std::string &fileName)
	Reads search windows from file.

void	SetCAIterationsNumberCrosscheck (int nIterations)
	Sets a number of CA track finder iterations to provide initialization cross-check.

void	SetConfigMain (const std::string &mainConfig)
	Sets base configuration file.

void	SetConfigUser (const std::string &userConfig)
	Sets user configuration file.

template<size_t Size>
void	SetDetectorNames (const std::array< const char *, Size > &container)
	Sets detector names.

void	SetFieldFunction (const FieldFunction_t &fieldFcn)
	Sets a magnetic field function, which will be applied for all the stations.

void	SetGhostSuppression (int ghostSuppression)
	Sets the flag to enable/disable the ghost suppression routine.

void	SetOutputConfigName (const std::string &filename)
	Sets a name of the output configuration file.

void	SetRandomSeed (unsigned int seed)
	Sets pseudo-random numbers generator seed.

void	SetTargetPosition (double x, double y, double z)
	Sets target position.

void	SetMaxDoubletsPerSinglet (unsigned int value)
	Sets upper-bound cut on max number of doublets per one singlet.

void	SetMaxTripletPerDoublets (unsigned int value)
	Sets upper-bound cut on max number of triplets per one doublet.

template<typename DataT >
void	SetGeometrySetup (const cbm::algo::kf::Setup< DataT > &setup)
	Sets setup.

void	SetMisalignmentTolerance (EDetectorID detectorId, double x, double y, double t)
	Sets misalignment parameters in X direction.

void	SetDefaultMass (double mass)
	Sets default fitter mass.

Parameters< fvec > &&	TakeParameters ()
	Takes parameters object from the init-manager instance.

void	WriteParametersObject (const std::string &fileName) const
	Writes parameters object from boost-serialized binary file.

void	DevSetIgnoreHitSearchAreas (bool value=true)
	Ignore hit search areas.

void	DevSetUseOfOriginalField (bool value=true)
	Force use of the original field (not approximated)

void	DevSetIsMatchDoubletsViaMc (bool value=true)
	Flag to match doublets using MC information.

void	DevSetIsMatchTripletsViaMc (bool value=true)
	Flag to match triplets using Mc information.

void	DevSetIsExtendTracksViaMc (bool value=true)
	Flag to match triplets using Mc information.

void	DevSetIsSuppressOverlapHitsViaMc (bool value=true)
	Flag to match triplets using Mc information.

void	DevSetIsParSearchWUsed (bool value=true)
	Flag to use estimated hit search windows.

Private Types
enum class	EInitKey { kFieldFunction , kTargetPos , kPrimaryVertexField , kStationsInfo , kCAIterationsNumberCrosscheck , kCAIterations , kSearchWindows , kGhostSuppression , kRandomSeed , kStationLayoutInitialized , kSetupInitialized , kEnd }
	Init-controller key set. More...

using	DetectorIDIntMap_t = std::unordered_map<EDetectorID, int>

using	DetectorIDSet_t = std::set<EDetectorID>

using	FieldFunction_t = std::function<void(const double (&xyz)[3], double (&B)[3])>

using	InitController_t = ObjectInitController<static_cast<int>(EInitKey::kEnd), EInitKey>

template<typename T >
using	DetectorIDArr_t = std::array<T, constants::size::MaxNdetectors>

Private Member Functions
void	CheckCAIterationsInit ()
	Checker for Iteration container initialization (sets EInitKey::kCAIterations)

void	CheckStationsInfoInit ()
	Checker for StationInitializer set initialization (sets EInitKey::kStationsInfo)

void	ClearStationLayout ()
	Returns station layout into undefined condition.

Private Attributes
InitController_t	fInitController {}
	Initialization flags.

DetectorIDArr_t< std::string >	fvDetectorNames {}
	Names of the detectors.

double	fTargetZ {0.}
	Target position z component in double precision.

std::vector< StationInitializer >	fvStationInfo {}
	Vector of StationInitializer objects (active + inactive)

FieldFunction_t	fFieldFunction {[](const double (&)[3], double (&)[3]) {}}
	A function which returns magnetic field vector B in a radius-vector xyz.

int	fCAIterationsNumberCrosscheck {-1}
	Number of iterations to be passed (must be used for cross-checks)

Parameters< fvec >	fParameters {}
	CA parameters object.

std::string	fsConfigInputMain = ""
	name for the input configuration file

std::string	fsConfigInputUser = ""
	name for the input configuration file

std::string	fConfigOutputName = ""
	name for the output configuration file

bool	fbConfigIsRead = false
	Flag, if configuration file was read.

bool	fbGeometryConfigLock = false
	Lock geometry initialization.

Detailed Description

A CA Parameters object initialization class.

This class provides an interface to form a solid Parameters object, which is used by the CA algorithm and the related routines. The initialization can be performed either from the detector-specific interfaces or by reading the already prepared binary wile with extention ca.par TODO:.... continue

Member Typedef Documentation

◆ DetectorIDArr_t

template<typename T >

using cbm::algo::ca::InitManager::DetectorIDArr_t = std::array<T, constants::size::MaxNdetectors>

private

Definition at line 82 of file CaInitManager.h.

◆ DetectorIDIntMap_t

using cbm::algo::ca::InitManager::DetectorIDIntMap_t = std::unordered_map<EDetectorID, int>

private

Definition at line 77 of file CaInitManager.h.

◆ DetectorIDSet_t

using cbm::algo::ca::InitManager::DetectorIDSet_t = std::set<EDetectorID>

private

Definition at line 78 of file CaInitManager.h.

◆ FieldFunction_t

using cbm::algo::ca::InitManager::FieldFunction_t = std::function<void(const double (&xyz)[3], double (&B)[3])>

private

Definition at line 79 of file CaInitManager.h.

◆ InitController_t

using cbm::algo::ca::InitManager::InitController_t = ObjectInitController<static_cast<int>(EInitKey::kEnd), EInitKey>

private

Definition at line 80 of file CaInitManager.h.

Member Enumeration Documentation

◆ EInitKey

enum class cbm::algo::ca::InitManager::EInitKey

strongprivate

Init-controller key set.

Enumerator
kFieldFunction	0) If magnetic field getter function is set
kTargetPos	1) If target position was defined
kPrimaryVertexField	2) If magnetic field value and region defined at primary vertex
kStationsInfo	3) If all the planned stations were added to the manager
kCAIterationsNumberCrosscheck	4) If the number of CA track finder is initialized
kCAIterations	5) If the CA track finder iterations were initialized
kSearchWindows	6) If the hit search windows were initialized
kGhostSuppression	7)
kRandomSeed	8) If the random seed is provided
kStationLayoutInitialized	9) If stations layout is initialized
kSetupInitialized	10) If KF-setup initialized
kEnd	11) [technical] number of entries in the enumeration

Definition at line 59 of file CaInitManager.h.

Constructor & Destructor Documentation

◆ InitManager() [1/3]

cbm::algo::ca::InitManager::InitManager ( )

default

Default constructor.

◆ ~InitManager()

cbm::algo::ca::InitManager::~InitManager ( )

default

Destructor.

◆ InitManager() [2/3]

cbm::algo::ca::InitManager::InitManager ( const InitManager & )

delete

Copy constructor is forbidden.

◆ InitManager() [3/3]

cbm::algo::ca::InitManager::InitManager ( InitManager && )

delete

Move constructor is forbidden.

Member Function Documentation

◆ AddStation()

void cbm::algo::ca::InitManager::AddStation ( const StationInitializer & station )

Adds a tracking station to the geometry.

Note: The added station stays uninitialized until the Parameters object is formed

Definition at line 27 of file CaInitManager.cxx.

References fvStationInfo.

Referenced by CbmL1::Init().

◆ CheckCAIterationsInit()

void cbm::algo::ca::InitManager::CheckCAIterationsInit ( )

private

Checker for Iteration container initialization (sets EInitKey::kCAIterations)

Returns: true If all Iteration objects were initialized properly

Definition at line 508 of file CaInitManager.cxx.

References fCAIterationsNumberCrosscheck, fInitController, fParameters, cbm::algo::ca::ObjectInitController< NumberOfFlags, InitKeyEnum >::GetFlag(), kCAIterations, and cbm::algo::ca::ObjectInitController< NumberOfFlags, InitKeyEnum >::SetFlag().

Referenced by CheckInit().

◆ CheckInit()

void cbm::algo::ca::InitManager::CheckInit ( )

Provides final checks of the parameters object.

Definition at line 31 of file CaInitManager.cxx.

References CheckCAIterationsInit(), CheckStationsInfoInit(), fbConfigIsRead, and fbGeometryConfigLock.

Referenced by FormParametersContainer().

◆ CheckStationsInfoInit()

void cbm::algo::ca::InitManager::CheckStationsInfoInit ( )

private

Checker for StationInitializer set initialization (sets EInitKey::kStationsInfo)

Returns: true If all StationInitializer objects were initialized properly. Similar effect can be achieved by

Definition at line 525 of file CaInitManager.cxx.

References fInitController, fParameters, fvStationInfo, cbm::algo::ca::ObjectInitController< NumberOfFlags, InitKeyEnum >::GetFlag(), kStationsInfo, cbm::algo::ca::constants::size::MaxNstations, and cbm::algo::ca::ObjectInitController< NumberOfFlags, InitKeyEnum >::SetFlag().

Referenced by CheckInit().

◆ ClearCAIterations()

void cbm::algo::ca::InitManager::ClearCAIterations ( )

Clears vector of CA track finder iterations.

Definition at line 85 of file CaInitManager.cxx.

References fCAIterationsNumberCrosscheck, fInitController, fParameters, kCAIterations, kCAIterationsNumberCrosscheck, and cbm::algo::ca::ObjectInitController< NumberOfFlags, InitKeyEnum >::SetFlag().

Referenced by cbm::algo::ca::ConfigReader::Read().

◆ ClearSetupInfo()

void cbm::algo::ca::InitManager::ClearSetupInfo ( )

Clears vector of base setup.

Definition at line 41 of file CaInitManager.cxx.

References ClearStationLayout(), fFieldFunction, fInitController, fParameters, fTargetZ, fvStationInfo, kFieldFunction, kGhostSuppression, kPrimaryVertexField, kRandomSeed, kStationsInfo, kTargetPos, and cbm::algo::ca::ObjectInitController< NumberOfFlags, InitKeyEnum >::SetFlag().

◆ ClearStationLayout()

void cbm::algo::ca::InitManager::ClearStationLayout ( )

private

Returns station layout into undefined condition.

Definition at line 552 of file CaInitManager.cxx.

References fInitController, fParameters, kStationLayoutInitialized, and cbm::algo::ca::ObjectInitController< NumberOfFlags, InitKeyEnum >::SetFlag().

Referenced by ClearSetupInfo(), and InitStationLayout().

◆ DevSetIgnoreHitSearchAreas()

void cbm::algo::ca::InitManager::DevSetIgnoreHitSearchAreas ( bool value = true )

inline

Ignore hit search areas.

Definition at line 308 of file CaInitManager.h.

References fParameters.

Referenced by cbm::algo::ca::ConfigReader::Read().

◆ DevSetIsExtendTracksViaMc()

void cbm::algo::ca::InitManager::DevSetIsExtendTracksViaMc ( bool value = true )

inline

Flag to match triplets using Mc information.

Definition at line 320 of file CaInitManager.h.

References fParameters.

Referenced by cbm::algo::ca::ConfigReader::Read().

◆ DevSetIsMatchDoubletsViaMc()

void cbm::algo::ca::InitManager::DevSetIsMatchDoubletsViaMc ( bool value = true )

inline

Flag to match doublets using MC information.

Definition at line 314 of file CaInitManager.h.

References fParameters.

Referenced by cbm::algo::ca::ConfigReader::Read().

◆ DevSetIsMatchTripletsViaMc()

void cbm::algo::ca::InitManager::DevSetIsMatchTripletsViaMc ( bool value = true )

inline

Flag to match triplets using Mc information.

Definition at line 317 of file CaInitManager.h.

References fParameters.

Referenced by cbm::algo::ca::ConfigReader::Read().

◆ DevSetIsParSearchWUsed()

void cbm::algo::ca::InitManager::DevSetIsParSearchWUsed ( bool value = true )

inline

Flag to use estimated hit search windows.

Parameters

true	estimated search windows will be used in track finder
false	the Kalman filter is be used in track finder

Definition at line 328 of file CaInitManager.h.

References fParameters.

Referenced by CbmL1::Init().

◆ DevSetIsSuppressOverlapHitsViaMc()

void cbm::algo::ca::InitManager::DevSetIsSuppressOverlapHitsViaMc ( bool value = true )

inline

Flag to match triplets using Mc information.

Definition at line 323 of file CaInitManager.h.

References fParameters.

Referenced by cbm::algo::ca::ConfigReader::Read().

◆ DevSetUseOfOriginalField()

void cbm::algo::ca::InitManager::DevSetUseOfOriginalField ( bool value = true )

inline

Force use of the original field (not approximated)

Definition at line 311 of file CaInitManager.h.

References fParameters.

Referenced by cbm::algo::ca::ConfigReader::Read().

◆ FormParametersContainer()

bool cbm::algo::ca::InitManager::FormParametersContainer ( )

Forms parameters container.

Returns: Success flag: true - the container is formed, false - error while forming the container occured

Definition at line 95 of file CaInitManager.cxx.

References CheckInit(), fbConfigIsRead, fInitController, fParameters, fvStationInfo, cbm::algo::ca::ObjectInitController< NumberOfFlags, InitKeyEnum >::IsFinalized(), kSearchWindows, ReadInputConfigs(), cbm::algo::ca::ObjectInitController< NumberOfFlags, InitKeyEnum >::SetFlag(), and cbm::algo::ca::ObjectInitController< NumberOfFlags, InitKeyEnum >::ToString().

Referenced by CbmL1::Init().

◆ GetDetectorName()

const std::string & cbm::algo::ca::InitManager::GetDetectorName ( EDetectorID detId ) const

inline

Gets name of the detector.

Parameters

detId Index of the detector

Returns: Name of the detector

Definition at line 124 of file CaInitManager.h.

References fvDetectorNames.

Referenced by cbm::algo::ca::ConfigReader::ReadInactiveStationMap(), and cbm::algo::ca::ConfigReader::ReadMisalignmentTolerance().

◆ GetGhostSuppression()

int cbm::algo::ca::InitManager::GetGhostSuppression ( ) const

inline

Gets ghost suppression flag.

Definition at line 127 of file CaInitManager.h.

References fParameters.

◆ GetInitController()

const InitController_t & cbm::algo::ca::InitManager::GetInitController ( ) const

inline

Gets a const reference to ca::ObjectInitController.

Definition at line 136 of file CaInitManager.h.

References fInitController.

◆ GetInputConfigMain()

const std::string & cbm::algo::ca::InitManager::GetInputConfigMain ( ) const

inline

Gets a name of the main input configuration file.

Definition at line 130 of file CaInitManager.h.

References fsConfigInputMain.

◆ GetInputConfigUser()

const std::string & cbm::algo::ca::InitManager::GetInputConfigUser ( ) const

inline

Gets a name of the user input configuration file.

Definition at line 133 of file CaInitManager.h.

References fsConfigInputMain.

◆ GetNstationsActive() [1/2]

int cbm::algo::ca::InitManager::GetNstationsActive ( ) const

Gets total number of active stations.

Definition at line 144 of file CaInitManager.cxx.

References fInitController, fParameters, cbm::algo::ca::ObjectInitController< NumberOfFlags, InitKeyEnum >::GetFlag(), and kStationLayoutInitialized.

Referenced by IsActive().

◆ GetNstationsActive() [2/2]

int cbm::algo::ca::InitManager::GetNstationsActive ( EDetectorID detectorID ) const

Gets number of active stations for given detector ID.

Definition at line 156 of file CaInitManager.cxx.

References fInitController, fParameters, cbm::algo::ca::ObjectInitController< NumberOfFlags, InitKeyEnum >::GetFlag(), and kStationLayoutInitialized.

◆ GetNstationsGeometry() [1/2]

int cbm::algo::ca::InitManager::GetNstationsGeometry ( ) const

Gets total number of stations, provided by setup geometry.

Definition at line 168 of file CaInitManager.cxx.

References fInitController, fParameters, cbm::algo::ca::ObjectInitController< NumberOfFlags, InitKeyEnum >::GetFlag(), and kStationLayoutInitialized.

Referenced by IsPresent(), and cbm::algo::ca::ConfigReader::ReadInactiveStationMap().

◆ GetNstationsGeometry() [2/2]

int cbm::algo::ca::InitManager::GetNstationsGeometry ( EDetectorID detectorID ) const

Gets number of stations, provided by setup geometry for given detector ID.

Definition at line 180 of file CaInitManager.cxx.

References fInitController, fParameters, cbm::algo::ca::ObjectInitController< NumberOfFlags, InitKeyEnum >::GetFlag(), and kStationLayoutInitialized.

◆ GetOutputConfigName()

const std::string & cbm::algo::ca::InitManager::GetOutputConfigName ( ) const

inline

Gets a name of the output configuration file.

Definition at line 151 of file CaInitManager.h.

References fConfigOutputName.

◆ GetStationInfo()

std::vector< StationInitializer > & cbm::algo::ca::InitManager::GetStationInfo ( )

Gets a reference to the stations array.

Definition at line 192 of file CaInitManager.cxx.

References fInitController, fvStationInfo, cbm::algo::ca::ObjectInitController< NumberOfFlags, InitKeyEnum >::GetFlag(), and kStationLayoutInitialized.

Referenced by cbm::algo::ca::ConfigReader::Read().

◆ InitStationLayout()

void cbm::algo::ca::InitManager::InitStationLayout ( )

Initializes station layout.

This function is to be called after all the tracking stations (StationInitializer objects) are added to the InitManager instance. After the initialization the vector of the tracking stations is sorted by z-positions and is available for modifications.

Definition at line 205 of file CaInitManager.cxx.

References ClearStationLayout(), fInitController, fParameters, fvStationInfo, kStationLayoutInitialized, and cbm::algo::ca::ObjectInitController< NumberOfFlags, InitKeyEnum >::SetFlag().

Referenced by CbmL1::Init(), and cbm::algo::ca::ConfigReader::Read().

◆ InitTargetField()

void cbm::algo::ca::InitManager::InitTargetField ( double zStep )

Calculates kf::FieldValue and L1FieldReference values for a selected step in z-axis from the target position.

Parameters

zStep step between nodal points

Definition at line 243 of file CaInitManager.cxx.

References fFieldFunction, fInitController, fParameters, fTargetZ, cbm::algo::ca::ObjectInitController< NumberOfFlags, InitKeyEnum >::GetFlag(), kFieldFunction, kPrimaryVertexField, kTargetPos, and cbm::algo::ca::ObjectInitController< NumberOfFlags, InitKeyEnum >::SetFlag().

Referenced by CbmL1::Init().

◆ IsActive()

bool cbm::algo::ca::InitManager::IsActive ( EDetectorID detectorID ) const

inline

Checks, if the detector is active.

Definition at line 168 of file CaInitManager.h.

References GetNstationsActive().

Referenced by CbmL1::Init().

◆ IsPresent()

bool cbm::algo::ca::InitManager::IsPresent ( EDetectorID detectorID ) const

inline

Checks, if the detector is present in the geometry.

Definition at line 171 of file CaInitManager.h.

References GetNstationsGeometry().

◆ operator=() [1/2]

InitManager & cbm::algo::ca::InitManager::operator= ( const InitManager & )

delete

Copy assignment operator is forbidden.

◆ operator=() [2/2]

InitManager & cbm::algo::ca::InitManager::operator= ( InitManager && )

delete

Move assignment operator is forbidden.

◆ PushBackCAIteration() [1/3]

void cbm::algo::ca::InitManager::PushBackCAIteration ( const Iteration & iteration )

Pushes an CA track finder iteration into a sequence of iteration using reference.

Definition at line 286 of file CaInitManager.cxx.

References fInitController, fParameters, cbm::algo::ca::ObjectInitController< NumberOfFlags, InitKeyEnum >::GetFlag(), and kCAIterationsNumberCrosscheck.

◆ PushBackCAIteration() [2/3]

void cbm::algo::ca::InitManager::PushBackCAIteration ( const Iteration * pIteration )

inline

Pushes an CA track finder iteration into a sequence of iteration using raw pointer.

Definition at line 177 of file CaInitManager.h.

References PushBackCAIteration().

Referenced by PushBackCAIteration().

◆ PushBackCAIteration() [3/3]

void cbm::algo::ca::InitManager::PushBackCAIteration ( const std::unique_ptr< Iteration > & puIteration )

inline

Pushes an CA track finder iteration into a sequence of iteration using std::unique_ptr.

Definition at line 180 of file CaInitManager.h.

References PushBackCAIteration().

Referenced by PushBackCAIteration().

◆ ReadGeometrySetup()

void cbm::algo::ca::InitManager::ReadGeometrySetup ( const std::string & fileName )

Reads geometry setup from file.

Parameters

fileName Name of input file

Definition at line 321 of file CaInitManager.cxx.

References cbm::algo::kf::SetupBuilder::Load(), and SetGeometrySetup().

◆ ReadInputConfigs()

void cbm::algo::ca::InitManager::ReadInputConfigs ( )

Reads main and user parameters configs.

Definition at line 299 of file CaInitManager.cxx.

References fbConfigIsRead, fbGeometryConfigLock, fsConfigInputMain, and fsConfigInputUser.

Referenced by FormParametersContainer(), and CbmL1::Init().

◆ ReadParametersObject()

void cbm::algo::ca::InitManager::ReadParametersObject ( const std::string & fileName )

Reads parameters object from boost-serialized binary file.

Parameters

fileName Name of input file

Definition at line 329 of file CaInitManager.cxx.

References cbm::algo::ca::constants::clrs::CL, fbGeometryConfigLock, fInitController, fParameters, cbm::algo::ca::constants::clrs::GNb, kPrimaryVertexField, kSearchWindows, kStationLayoutInitialized, and cbm::algo::ca::ObjectInitController< NumberOfFlags, InitKeyEnum >::SetFlag().

Referenced by cbm::ca::ParametersHandler::Get(), and CbmL1::ReadSTAPParamObject().

◆ ReadSearchWindows()

void cbm::algo::ca::InitManager::ReadSearchWindows ( const std::string & fileName )

Reads search windows from file.

Parameters

fileName Name of input file

Definition at line 364 of file CaInitManager.cxx.

References fInitController, fParameters, cbm::algo::ca::SearchWindow::GetStationID(), cbm::algo::ca::SearchWindow::GetTrackGroupID(), kSearchWindows, cbm::algo::ca::constants::size::MaxNstations, cbm::algo::ca::constants::size::MaxNtrackGroups, and cbm::algo::ca::ObjectInitController< NumberOfFlags, InitKeyEnum >::SetFlag().

Referenced by CbmL1::Init().

◆ SetCAIterationsNumberCrosscheck()

void cbm::algo::ca::InitManager::SetCAIterationsNumberCrosscheck ( int nIterations )

Sets a number of CA track finder iterations to provide initialization cross-check.

Definition at line 415 of file CaInitManager.cxx.

References fCAIterationsNumberCrosscheck, fInitController, fParameters, kCAIterationsNumberCrosscheck, and cbm::algo::ca::ObjectInitController< NumberOfFlags, InitKeyEnum >::SetFlag().

Referenced by cbm::algo::ca::ConfigReader::Read().

◆ SetConfigMain()

void cbm::algo::ca::InitManager::SetConfigMain ( const std::string & mainConfig )

inline

Sets base configuration file.

Parameters

mainConfig Path to main configuration file

Note: The base configuraiton file is mandatory until the tracking configuration is initialized from beforehand created Parameters file.

Definition at line 205 of file CaInitManager.h.

References fsConfigInputMain.

Referenced by CbmL1::Init().

◆ SetConfigUser()

void cbm::algo::ca::InitManager::SetConfigUser ( const std::string & userConfig )

inline

Sets user configuration file.

Parameters

userConfig Path to user configuration file

Note: The user configuraiton file is optional

Definition at line 210 of file CaInitManager.h.

References fsConfigInputUser.

Referenced by CbmL1::SetConfigUser().

◆ SetDefaultMass()

void cbm::algo::ca::InitManager::SetDefaultMass ( double mass )

inline

Sets default fitter mass.

Parameters

mass	Particle mass [GeV/c2]

Definition at line 293 of file CaInitManager.h.

References fParameters.

◆ SetDetectorNames()

template<size_t Size>

void cbm::algo::ca::InitManager::SetDetectorNames ( const std::array< const char *, Size > & container )

inline

Sets detector names.

Parameters

container Container of the detector names

Definition at line 215 of file CaInitManager.h.

References fvDetectorNames, and cbm::algo::ca::constants::size::MaxNdetectors.

Referenced by cbm::algo::TrackingChain::Init(), and CbmL1::Init().

◆ SetFieldFunction()

void cbm::algo::ca::InitManager::SetFieldFunction ( const FieldFunction_t & fieldFcn )

Sets a magnetic field function, which will be applied for all the stations.

Definition at line 427 of file CaInitManager.cxx.

References fFieldFunction, fInitController, cbm::algo::ca::ObjectInitController< NumberOfFlags, InitKeyEnum >::GetFlag(), kFieldFunction, and cbm::algo::ca::ObjectInitController< NumberOfFlags, InitKeyEnum >::SetFlag().

Referenced by CbmL1::Init().

◆ SetGeometrySetup()

template<typename DataT >

void cbm::algo::ca::InitManager::SetGeometrySetup ( const cbm::algo::kf::Setup< DataT > & setup )

inline

Sets setup.

Template Parameters

Underlying type of the setup

Definition at line 256 of file CaInitManager.h.

References fInitController, fParameters, cbm::algo::ca::ObjectInitController< NumberOfFlags, InitKeyEnum >::GetFlag(), cbm::algo::kf::Setup< T >::GetNofLayers(), kSetupInitialized, kStationLayoutInitialized, and cbm::algo::ca::ObjectInitController< NumberOfFlags, InitKeyEnum >::SetFlag().

Referenced by cbm::ca::ParametersHandler::Get(), CbmL1::Init(), and ReadGeometrySetup().

◆ SetGhostSuppression()

void cbm::algo::ca::InitManager::SetGhostSuppression ( int ghostSuppression )

Sets the flag to enable/disable the ghost suppression routine.

Definition at line 440 of file CaInitManager.cxx.

References fInitController, fParameters, cbm::algo::ca::ObjectInitController< NumberOfFlags, InitKeyEnum >::GetFlag(), kGhostSuppression, and cbm::algo::ca::ObjectInitController< NumberOfFlags, InitKeyEnum >::SetFlag().

Referenced by cbm::algo::ca::ConfigReader::Read().

◆ SetMaxDoubletsPerSinglet()

void cbm::algo::ca::InitManager::SetMaxDoubletsPerSinglet ( unsigned int value )

inline

Sets upper-bound cut on max number of doublets per one singlet.

Definition at line 248 of file CaInitManager.h.

References fParameters.

Referenced by cbm::algo::ca::ConfigReader::Read().

◆ SetMaxTripletPerDoublets()

void cbm::algo::ca::InitManager::SetMaxTripletPerDoublets ( unsigned int value )

inline

Sets upper-bound cut on max number of triplets per one doublet.

Definition at line 251 of file CaInitManager.h.

References fParameters.

Referenced by cbm::algo::ca::ConfigReader::Read().

◆ SetMisalignmentTolerance()

void cbm::algo::ca::InitManager::SetMisalignmentTolerance	(	EDetectorID	detectorId,
		double	x,
		double	y,
		double	t )

inline

Sets misalignment parameters in X direction.

Parameters

detectorId	Index of the detector system
x	Misalignment tolerance in x [cm]
y	Misalignment tolerance in y [cm]
t	Misalignment tolerance in t [ns]

Definition at line 284 of file CaInitManager.h.

References fParameters, x, and y.

Referenced by cbm::algo::ca::ConfigReader::ReadMisalignmentTolerance().

◆ SetOutputConfigName()

void cbm::algo::ca::InitManager::SetOutputConfigName ( const std::string & filename )

inline

Sets a name of the output configuration file.

Parameters

filename Name of the output CA parameters configuration

The output file is created from the fields, saved in the resulted Parameters object.

Definition at line 233 of file CaInitManager.h.

References fConfigOutputName.

Referenced by CbmL1::SetOutputConfigName().

◆ SetRandomSeed()

void cbm::algo::ca::InitManager::SetRandomSeed ( unsigned int seed )

Sets pseudo-random numbers generator seed.

Parameters

seed	Seed value

Note: The default seed is 1

Definition at line 453 of file CaInitManager.cxx.

References fInitController, fParameters, cbm::algo::ca::ObjectInitController< NumberOfFlags, InitKeyEnum >::GetFlag(), kRandomSeed, and cbm::algo::ca::ObjectInitController< NumberOfFlags, InitKeyEnum >::SetFlag().

Referenced by cbm::algo::ca::ConfigReader::Read(), and CbmL1::SetRandomSeed().

◆ SetTargetPosition()

void cbm::algo::ca::InitManager::SetTargetPosition	(	double	x,
		double	y,
		double	z )

Sets target position.

Parameters

x	Position X component [cm]
y	Position Y component [cm]
z	Position Z component [cm]

Fill fvec target fields

Set additional field for z component in double precision

Definition at line 465 of file CaInitManager.cxx.

References fInitController, fParameters, fTargetZ, cbm::algo::ca::ObjectInitController< NumberOfFlags, InitKeyEnum >::GetFlag(), kTargetPos, cbm::algo::ca::ObjectInitController< NumberOfFlags, InitKeyEnum >::SetFlag(), x, and y.

Referenced by CbmL1::Init().

◆ TakeParameters()

Parameters< fvec > && cbm::algo::ca::InitManager::TakeParameters ( )

Takes parameters object from the init-manager instance.

Returns: A parameter object

Definition at line 483 of file CaInitManager.cxx.

References fParameters.

Referenced by cbm::ca::ParametersHandler::Get(), and CbmL1::Init().

◆ WriteParametersObject()

void cbm::algo::ca::InitManager::WriteParametersObject ( const std::string & fileName ) const

Writes parameters object from boost-serialized binary file.

Parameters

fileName Name of input file

Definition at line 487 of file CaInitManager.cxx.

References cbm::algo::ca::constants::clrs::CL, fParameters, and cbm::algo::ca::constants::clrs::GNb.

Referenced by CbmL1::WriteSTAPParamObject().

Member Data Documentation

◆ fbConfigIsRead

bool cbm::algo::ca::InitManager::fbConfigIsRead = false

private

Flag, if configuration file was read.

Definition at line 364 of file CaInitManager.h.

Referenced by CheckInit(), FormParametersContainer(), and ReadInputConfigs().

◆ fbGeometryConfigLock

bool cbm::algo::ca::InitManager::fbGeometryConfigLock = false

private

Lock geometry initialization.

Definition at line 365 of file CaInitManager.h.

Referenced by CheckInit(), ReadInputConfigs(), and ReadParametersObject().

◆ fCAIterationsNumberCrosscheck

int cbm::algo::ca::InitManager::fCAIterationsNumberCrosscheck {-1}

private

Number of iterations to be passed (must be used for cross-checks)

Definition at line 354 of file CaInitManager.h.

Referenced by CheckCAIterationsInit(), ClearCAIterations(), and SetCAIterationsNumberCrosscheck().

◆ fConfigOutputName

std::string cbm::algo::ca::InitManager::fConfigOutputName = ""

private

name for the output configuration file

Definition at line 362 of file CaInitManager.h.

Referenced by GetOutputConfigName(), and SetOutputConfigName().

◆ fFieldFunction

FieldFunction_t cbm::algo::ca::InitManager::fFieldFunction {[](const double (&)[3], double (&)[3]) {}}

private

A function which returns magnetic field vector B in a radius-vector xyz.

Definition at line 350 of file CaInitManager.h.

Referenced by ClearSetupInfo(), InitTargetField(), and SetFieldFunction().

◆ fInitController

InitController_t cbm::algo::ca::InitManager::fInitController {}

private

◆ fParameters

Parameters<fvec> cbm::algo::ca::InitManager::fParameters {}

private

CA parameters object.

Definition at line 356 of file CaInitManager.h.

Referenced by CheckCAIterationsInit(), CheckStationsInfoInit(), ClearCAIterations(), ClearSetupInfo(), ClearStationLayout(), DevSetIgnoreHitSearchAreas(), DevSetIsExtendTracksViaMc(), DevSetIsMatchDoubletsViaMc(), DevSetIsMatchTripletsViaMc(), DevSetIsParSearchWUsed(), DevSetIsSuppressOverlapHitsViaMc(), DevSetUseOfOriginalField(), FormParametersContainer(), GetGhostSuppression(), GetNstationsActive(), GetNstationsActive(), GetNstationsGeometry(), GetNstationsGeometry(), InitStationLayout(), InitTargetField(), PushBackCAIteration(), ReadParametersObject(), ReadSearchWindows(), SetCAIterationsNumberCrosscheck(), SetDefaultMass(), SetGeometrySetup(), SetGhostSuppression(), SetMaxDoubletsPerSinglet(), SetMaxTripletPerDoublets(), SetMisalignmentTolerance(), SetRandomSeed(), SetTargetPosition(), TakeParameters(), and WriteParametersObject().

◆ fsConfigInputMain

std::string cbm::algo::ca::InitManager::fsConfigInputMain = ""

private

name for the input configuration file

Definition at line 360 of file CaInitManager.h.

Referenced by GetInputConfigMain(), GetInputConfigUser(), ReadInputConfigs(), and SetConfigMain().

◆ fsConfigInputUser

std::string cbm::algo::ca::InitManager::fsConfigInputUser = ""

private

name for the input configuration file

Definition at line 361 of file CaInitManager.h.

Referenced by ReadInputConfigs(), and SetConfigUser().

◆ fTargetZ

double cbm::algo::ca::InitManager::fTargetZ {0.}

private

Target position z component in double precision.

Definition at line 345 of file CaInitManager.h.

Referenced by ClearSetupInfo(), InitTargetField(), and SetTargetPosition().

◆ fvDetectorNames

DetectorIDArr_t<std::string> cbm::algo::ca::InitManager::fvDetectorNames {}

private

Names of the detectors.

Definition at line 343 of file CaInitManager.h.

Referenced by GetDetectorName(), and SetDetectorNames().

◆ fvStationInfo

std::vector<StationInitializer> cbm::algo::ca::InitManager::fvStationInfo {}

private

Vector of StationInitializer objects (active + inactive)

Definition at line 347 of file CaInitManager.h.

Referenced by AddStation(), CheckStationsInfoInit(), ClearSetupInfo(), FormParametersContainer(), GetStationInfo(), and InitStationLayout().

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

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ DetectorIDArr_t

◆ DetectorIDIntMap_t

◆ DetectorIDSet_t

◆ FieldFunction_t

◆ InitController_t

Member Enumeration Documentation

◆ EInitKey

Constructor & Destructor Documentation

◆ InitManager() [1/3]

◆ ~InitManager()

◆ InitManager() [2/3]

◆ InitManager() [3/3]

Member Function Documentation

◆ AddStation()

◆ CheckCAIterationsInit()

◆ CheckInit()

◆ CheckStationsInfoInit()

◆ ClearCAIterations()

◆ ClearSetupInfo()

◆ ClearStationLayout()

◆ DevSetIgnoreHitSearchAreas()

◆ DevSetIsExtendTracksViaMc()

◆ DevSetIsMatchDoubletsViaMc()

◆ DevSetIsMatchTripletsViaMc()

◆ DevSetIsParSearchWUsed()

◆ DevSetIsSuppressOverlapHitsViaMc()

◆ DevSetUseOfOriginalField()

◆ FormParametersContainer()

◆ GetDetectorName()

◆ GetGhostSuppression()

◆ GetInitController()

◆ GetInputConfigMain()

◆ GetInputConfigUser()

◆ GetNstationsActive() [1/2]

◆ GetNstationsActive() [2/2]

◆ GetNstationsGeometry() [1/2]

◆ GetNstationsGeometry() [2/2]

◆ GetOutputConfigName()

◆ GetStationInfo()

◆ InitStationLayout()

◆ InitTargetField()

◆ IsActive()

◆ IsPresent()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ PushBackCAIteration() [1/3]

◆ PushBackCAIteration() [2/3]

◆ PushBackCAIteration() [3/3]

◆ ReadGeometrySetup()

◆ ReadInputConfigs()

◆ ReadParametersObject()

◆ ReadSearchWindows()

◆ SetCAIterationsNumberCrosscheck()

◆ SetConfigMain()

◆ SetConfigUser()

◆ SetDefaultMass()

◆ SetDetectorNames()

◆ SetFieldFunction()

◆ SetGeometrySetup()

◆ SetGhostSuppression()

◆ SetMaxDoubletsPerSinglet()

◆ SetMaxTripletPerDoublets()

◆ SetMisalignmentTolerance()

◆ SetOutputConfigName()

◆ SetRandomSeed()

◆ SetTargetPosition()

◆ TakeParameters()

◆ WriteParametersObject()

Member Data Documentation

◆ fbConfigIsRead

◆ fbGeometryConfigLock

◆ fCAIterationsNumberCrosscheck

◆ fConfigOutputName

◆ fFieldFunction