A container for all external parameters of the CA tracking algorithm. More...

#include <CaParameters.h>

Inheritance diagram for Parameters< DataT >:

Collaboration diagram for Parameters< DataT >:

Public Member Functions
	Parameters ()=default
	Default constructor.

	Parameters (ca::Setup< DataT > &&setup, ca::Config &&config, SearchWindowMapContainer &&searchWindows)
	Constructor from arguments.

template<typename DataIn>
	Parameters (const Parameters< DataIn > &other)
	Copy constructor with type conversion.

	Parameters (const Parameters &other)=default
	Copy constructor.

	Parameters (Parameters &&other)=default
	Move constructor.

	~Parameters () noexcept=default
	Destructor.

Parameters &	operator= (const Parameters &other)=default
	Copy assignment operator.

Parameters &	operator= (Parameters &&other)=default
	Move assignment operator.

void	Print (int verbosityLevel=0) const
	Prints configuration.

std::string	ToString (int verbosity=0, int indentLevel=0) const
	String representation of the class contents.

kf::EFieldMode	GetFieldMode () const
	Gets field mode.

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

int	GetNstationsActive (EDetectorID detId) 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 detId) const
	Gets number of stations, provided by setup geometry for given detector ID.

std::pair< EDetectorID, int >	GetStationIndexLocal (int geoId) const
	Provides access to the first index of the station on each particular detector (const)

int	GetStationIndexGeometry (int locId, EDetectorID detId) const
	Provides access to local indexes of stations (const)

int	GetStationIndexActive (int locId, EDetectorID detId) const
	Provides access to global indexes of stations among geometry (const)

const auto &	GetCAIterations () const
	Provides access to L1CAIteration vector (const)

int	GetNcaIterations () const
	Provides number of iterations.

const auto &	GetActiveSetup () const
	Gets active setup.

const auto &	GetGeometrySetup () const
	Gets active setup.

bool	IsActive (EDetectorID detId) const
	Checks, if the detector subsystem active.

void	CheckConsistency () const
	Class invariant checker.

const Setup< DataT > &	GetSetup () const
	Constant accessor to CA setup.

const Config &	GetConfig () const
	Constant accessor to CA config.

const SearchWindowMapContainer &	GetSearchWindows () const
	Constant accessor to search window map container.

Private Types
using	DetectorID_t = std::underlying_type_t<EDetectorID>

template<typename T>
using	StationArray_t = std::array<T, constants::size::MaxNstations>

Private Member Functions
template<class Archive>
void	serialize (Archive &ar, const unsigned int)

Private Attributes
Setup< DataT >	fSetup
	Setup representation.

Config	fConfig
	Configuration.

SearchWindowMapContainer	fSwMaps
	Search window map.

Friends
class	ParametersIO

class	boost::serialization::access
	Serialization function.

Detailed Description

template<typename DataT>
class Parameters< DataT >

A container for all external parameters of the CA tracking algorithm.

Definition at line 52 of file CaParameters.h.

Member Typedef Documentation

◆ DetectorID_t

template<typename DataT>

using cbm::algo::ca::Parameters< DataT >::DetectorID_t = std::underlying_type_t<EDetectorID>

private

Definition at line 55 of file CaParameters.h.

◆ StationArray_t

template<typename DataT>

template<typename T>

using cbm::algo::ca::Parameters< DataT >::StationArray_t = std::array<T, constants::size::MaxNstations>

private

Definition at line 57 of file CaParameters.h.

Constructor & Destructor Documentation

◆ Parameters() [1/5]

template<typename DataT>

cbm::algo::ca::Parameters< DataT >::Parameters ( )

default

Default constructor.

◆ Parameters() [2/5]

template<typename DataT>

Parameters::Parameters	(	ca::Setup< DataT > &&	setup,
		ca::Config &&	config,
		ca::SearchWindowMapContainer &&	searchWindows )

Constructor from arguments.

Parameters

setup	initialized CA-setup
config	initialized CA config
searchWindows	initialized search window container

Definition at line 31 of file CaParameters.cxx.

◆ Parameters() [3/5]

template<typename DataT>

template<typename DataIn>

cbm::algo::ca::Parameters< DataT >::Parameters ( const Parameters< DataIn > & other )

inline

Copy constructor with type conversion.

Definition at line 71 of file CaParameters.h.

◆ Parameters() [4/5]

template<typename DataT>

cbm::algo::ca::Parameters< DataT >::Parameters ( const Parameters< DataT > & other )

default

Copy constructor.

◆ Parameters() [5/5]

template<typename DataT>

cbm::algo::ca::Parameters< DataT >::Parameters ( Parameters< DataT > && other )

default

Move constructor.

◆ ~Parameters()

template<typename DataT>

cbm::algo::ca::Parameters< DataT >::~Parameters ( )

defaultnoexcept

Destructor.

Member Function Documentation

◆ CheckConsistency()

template<typename DataT>

void Parameters::CheckConsistency ( ) const

Class invariant checker.

Definition at line 43 of file CaParameters.cxx.

◆ GetActiveSetup()

template<typename DataT>

const auto & cbm::algo::ca::Parameters< DataT >::GetActiveSetup ( ) const

inline

Gets active setup.

Definition at line 160 of file CaParameters.h.

◆ GetCAIterations()

template<typename DataT>

const auto & cbm::algo::ca::Parameters< DataT >::GetCAIterations ( ) const

inline

Provides access to L1CAIteration vector (const)

Definition at line 154 of file CaParameters.h.

◆ GetConfig()

template<typename DataT>

const Config & cbm::algo::ca::Parameters< DataT >::GetConfig ( ) const

inline

Constant accessor to CA config.

Definition at line 176 of file CaParameters.h.

◆ GetFieldMode()

template<typename DataT>

kf::EFieldMode cbm::algo::ca::Parameters< DataT >::GetFieldMode ( ) const

inline

Gets field mode.

Definition at line 102 of file CaParameters.h.

◆ GetGeometrySetup()

template<typename DataT>

const auto & cbm::algo::ca::Parameters< DataT >::GetGeometrySetup ( ) const

inline

Gets active setup.

Definition at line 163 of file CaParameters.h.

◆ GetNcaIterations()

template<typename DataT>

int cbm::algo::ca::Parameters< DataT >::GetNcaIterations ( ) const

inline

Provides number of iterations.

Definition at line 157 of file CaParameters.h.

◆ GetNstationsActive() [1/2]

template<typename DataT>

int cbm::algo::ca::Parameters< DataT >::GetNstationsActive ( ) const

inline

Gets total number of active stations.

Definition at line 105 of file CaParameters.h.

◆ GetNstationsActive() [2/2]

template<typename DataT>

int cbm::algo::ca::Parameters< DataT >::GetNstationsActive ( EDetectorID detId ) const

inline

Gets number of active stations for given detector ID.

Definition at line 108 of file CaParameters.h.

◆ GetNstationsGeometry() [1/2]

template<typename DataT>

int cbm::algo::ca::Parameters< DataT >::GetNstationsGeometry ( ) const

inline

Gets total number of stations, provided by setup geometry.

Definition at line 111 of file CaParameters.h.

◆ GetNstationsGeometry() [2/2]

template<typename DataT>

int cbm::algo::ca::Parameters< DataT >::GetNstationsGeometry ( EDetectorID detId ) const

inline

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

Definition at line 114 of file CaParameters.h.

◆ GetSearchWindows()

template<typename DataT>

const SearchWindowMapContainer & cbm::algo::ca::Parameters< DataT >::GetSearchWindows ( ) const

inline

Constant accessor to search window map container.

Definition at line 179 of file CaParameters.h.

◆ GetSetup()

template<typename DataT>

const Setup< DataT > & cbm::algo::ca::Parameters< DataT >::GetSetup ( ) const

inline

Constant accessor to CA setup.

Definition at line 173 of file CaParameters.h.

◆ GetStationIndexActive()

template<typename DataT>

int cbm::algo::ca::Parameters< DataT >::GetStationIndexActive	(	int	locId,
		EDetectorID	detId ) const

inline

Provides access to global indexes of stations among geometry (const)

Calculates global index of station used by track finder

Parameters

locId	local index of the tracking station (for a particular detector)
detId	ID of the detector subsystem

Definition at line 148 of file CaParameters.h.

◆ GetStationIndexGeometry()

template<typename DataT>

int cbm::algo::ca::Parameters< DataT >::GetStationIndexGeometry	(	int	locId,
		EDetectorID	detId ) const

inline

Provides access to local indexes of stations (const)

Calculates global index of station among geometry (accounts for inactive stations)

Parameters

locId	local index of the tracking station (for a particular detector)
detId	ID of the detector subsystem

Definition at line 134 of file CaParameters.h.

◆ GetStationIndexLocal()

template<typename DataT>

std::pair< EDetectorID, int > cbm::algo::ca::Parameters< DataT >::GetStationIndexLocal ( int geoId ) const

inline

Provides access to the first index of the station on each particular detector (const)

Gets local index of station

Parameters

geoId geometry index of the tracking station

Returns: A pair (detectorID, local index of the tracking station)

Definition at line 122 of file CaParameters.h.

◆ IsActive()

template<typename DataT>

bool cbm::algo::ca::Parameters< DataT >::IsActive ( EDetectorID detId ) const

inline

Checks, if the detector subsystem active.

Parameters

detId Detector ID

Definition at line 167 of file CaParameters.h.

◆ operator=() [1/2]

template<typename DataT>

Parameters & cbm::algo::ca::Parameters< DataT >::operator= ( const Parameters< DataT > & other )

default

Copy assignment operator.

◆ operator=() [2/2]

template<typename DataT>

Parameters & cbm::algo::ca::Parameters< DataT >::operator= ( Parameters< DataT > && other )

default

Move assignment operator.

◆ Print()

template<typename DataT>

void Parameters::Print ( int verbosityLevel = 0 ) const

Prints configuration.

Definition at line 271 of file CaParameters.cxx.

◆ serialize()

template<typename DataT>

template<class Archive>

void cbm::algo::ca::Parameters< DataT >::serialize	(	Archive &	ar,
		const unsigned int	)

inlineprivate

Definition at line 189 of file CaParameters.h.

◆ ToString()

template<typename DataT>

std::string Parameters::ToString	(	int	verbosity = 0,
		int	indentLevel = 0 ) const

String representation of the class contents.

Parameters

verbosity	A verbose level for output
indentLevel	Indent level of the string output

Sets red/green color dependently from flag

Definition at line 279 of file CaParameters.cxx.

Friends And Related Symbol Documentation

◆ boost::serialization::access

template<typename DataT>

friend class boost::serialization::access

friend

Serialization function.

Definition at line 187 of file CaParameters.h.

◆ ParametersIO

template<typename DataT>

friend class ParametersIO

friend

Definition at line 53 of file CaParameters.h.

Member Data Documentation

◆ fConfig

template<typename DataT>

Config cbm::algo::ca::Parameters< DataT >::fConfig

private

Configuration.

Definition at line 183 of file CaParameters.h.

◆ fSetup

template<typename DataT>

Setup<DataT> cbm::algo::ca::Parameters< DataT >::fSetup

private

Setup representation.

Definition at line 182 of file CaParameters.h.

◆ fSwMaps

template<typename DataT>

SearchWindowMapContainer cbm::algo::ca::Parameters< DataT >::fSwMaps

private

Search window map.

Definition at line 184 of file CaParameters.h.

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

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ DetectorID_t

◆ StationArray_t

Constructor & Destructor Documentation

◆ Parameters() [1/5]

◆ Parameters() [2/5]

◆ Parameters() [3/5]

◆ Parameters() [4/5]

◆ Parameters() [5/5]

◆ ~Parameters()

Member Function Documentation

◆ CheckConsistency()

◆ GetActiveSetup()

◆ GetCAIterations()

◆ GetConfig()

◆ GetFieldMode()

◆ GetGeometrySetup()

◆ GetNcaIterations()

◆ GetNstationsActive() [1/2]

◆ GetNstationsActive() [2/2]

◆ GetNstationsGeometry() [1/2]

◆ GetNstationsGeometry() [2/2]

◆ GetSearchWindows()

◆ GetSetup()

◆ GetStationIndexActive()

◆ GetStationIndexGeometry()

◆ GetStationIndexLocal()

◆ IsActive()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ Print()

◆ serialize()

◆ ToString()

Friends And Related Symbol Documentation

◆ boost::serialization::access

◆ ParametersIO

Member Data Documentation

◆ fConfig

◆ fSetup

◆ fSwMaps