Setup representation for tracking. More...

#include <CaSetup.h>

Inheritance diagram for cbm::algo::ca::Setup< Float >:

Collaboration diagram for cbm::algo::ca::Setup< Float >:

Public Types
using	KfSetup_t = typename kf::Setup<Float>

Public Member Functions
	Setup ()=default
	Default constructor (for serialization)

	Setup (kf::Setup< Float > geoSetup, const std::vector< std::pair< EDetectorID, int > > &inactiveStations)
	Constructor.

template<typename SrcFloat>
	Setup (const Setup< SrcFloat > &other)
	Copy-convert constructor.

	Setup (const Setup &)=default
	Default copy constructor.

	Setup (Setup &&)=default
	Move constructor.

	~Setup ()=default
	Destructor.

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

Setup &	operator= (Setup &&)=default
	Move assignment operator.

const KfSetup_t &	GetActiveSetup () const
	Constant accessor to the active setup.

const KfSetup_t &	GetGeometrySetup () const
	Constant accessor to the geometry setup.

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

int	GetNofActStations (EDetectorID detId) const
	Gets number of active stations for a given detector subsystem.

int	GetNofGeoStations () const
	Gets total number of geometry stations.

int	GetNofGeoStations (EDetectorID detId) const
	Gets number of geometry stations for a given detector subsystem.

int	ActToGeoStationId (int actId) const
	Converts active station ID to geometry station ID.

std::pair< EDetectorID, int >	ActToLocStationId (int actId) const
	Converts active station ID to (detector ID, local station ID)

int	GeoToActStationId (int geoId) const
	Converts geometry station ID to active station ID.

std::pair< EDetectorID, int >	GeoToLocStationId (int geoId) const
	Converts geometry station ID to (detector ID, local station ID)

int	LocToActStationId (EDetectorID detId, int locId) const
	Converts (detectorId, local station ID) to active station ID.

int	LocToGeoStationId (EDetectorID detId, int locId) const
	Converts (detectorId, local station ID) to geometry station ID.

Private Types
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)
	Serialization method.

Private Attributes
KfSetup_t	fGeoSetup
	Geometry KF-setup (includes both active and inactive stations)

KfSetup_t	fActSetup
	Active KF-setup (includes only inactive stations)

StationArray_t< int >	fvGeoToActMap
	Maps geoId -> actId [geoId].

StationArray_t< int >	fvActToGeoMap
	Maps actId -> geoId [actId].

Friends
template<typename>
class	Setup

class	boost::serialization::access

Detailed Description

template<typename Float>
class cbm::algo::ca::Setup< Float >

Setup representation for tracking.

Template Parameters

Float A floating point type (where applicable)

GeoSetup – full tracking setup: each layer represents a station, which can be either active (enabled), or passive (disabled) ActSetup – active tracking setup: each layer is an active tracking station

STATION ID VARIANTS

abrev.	full name	definition
detId	Detector ID	An ID of a det. subsystem in CA, represented with ca::EDetectorID enum
locId	Local station ID	An ID of tracking station within a seletected detector subsystem
geoId	Geometry station ID	A continuous ID of a tracking station, presented in the geometry over
		all detector subsystems.
actId	Active station ID	A continuous ID of a active tracking stations over all det. subsystems

CONTENTS 1) geometrical setup (different material volumes):

magnetic field
target information
material budget 2) active setup (only active stations):
magnetic field
target information
material budget

Definition at line 54 of file CaSetup.h.

Member Typedef Documentation

◆ KfSetup_t

template<typename Float>

using cbm::algo::ca::Setup< Float >::KfSetup_t = typename kf::Setup<Float>

Definition at line 59 of file CaSetup.h.

◆ StationArray_t

template<typename Float>

template<typename T>

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

private

Definition at line 164 of file CaSetup.h.

Constructor & Destructor Documentation

◆ Setup() [1/5]

template<typename Float>

cbm::algo::ca::Setup< Float >::Setup ( )

default

Default constructor (for serialization)

◆ Setup() [2/5]

template<typename Float>

Setup::Setup	(	kf::Setup< Float >	geoSetup,
		const std::vector< std::pair< EDetectorID, int > > &	inactiveStations )

Constructor.

Parameters

geoSetup	A valid geometrical kf::Setup (NOTE: resource is moved)
inactiveStations	A vector of pairs {detId, locId} for inactive layers in geo Setup

Definition at line 20 of file CaSetup.cxx.

References ActToLocStationId(), fActSetup, fGeoSetup, fvActToGeoMap, fvGeoToActMap, and LocToGeoStationId().

◆ Setup() [3/5]

template<typename Float>

template<typename SrcFloat>

cbm::algo::ca::Setup< Float >::Setup ( const Setup< SrcFloat > & other )

inline

Copy-convert constructor.

Template Parameters

SrcFloat Underlying floating-point data type of the source

Definition at line 73 of file CaSetup.h.

References fActSetup, fGeoSetup, fvActToGeoMap, fvGeoToActMap, and Setup.

◆ Setup() [4/5]

template<typename Float>

cbm::algo::ca::Setup< Float >::Setup ( const Setup< Float > & )

default

Default copy constructor.

References Setup.

◆ Setup() [5/5]

template<typename Float>

cbm::algo::ca::Setup< Float >::Setup ( Setup< Float > && )

default

Move constructor.

References Setup.

◆ ~Setup()

template<typename Float>

cbm::algo::ca::Setup< Float >::~Setup ( )

default

Destructor.

Member Function Documentation

◆ ActToGeoStationId()

template<typename Float>

int cbm::algo::ca::Setup< Float >::ActToGeoStationId ( int actId ) const

inline

Converts active station ID to geometry station ID.

Parameters

actId Active station ID

Returns: Geometry station ID

Definition at line 119 of file CaSetup.h.

References fvActToGeoMap.

◆ ActToLocStationId()

template<typename Float>

std::pair< EDetectorID, int > cbm::algo::ca::Setup< Float >::ActToLocStationId ( int actId ) const

inline

Converts active station ID to (detector ID, local station ID)

Parameters

actId Active station ID

Returns: (detector ID, local station ID)

Definition at line 124 of file CaSetup.h.

References fActSetup.

Referenced by Setup().

◆ GeoToActStationId()

template<typename Float>

int cbm::algo::ca::Setup< Float >::GeoToActStationId ( int geoId ) const

inline

Converts geometry station ID to active station ID.

Parameters

geoId Geometry station ID

Returns: Active station ID

Definition at line 132 of file CaSetup.h.

References fvGeoToActMap.

◆ GeoToLocStationId()

template<typename Float>

std::pair< EDetectorID, int > cbm::algo::ca::Setup< Float >::GeoToLocStationId ( int geoId ) const

inline

Converts geometry station ID to (detector ID, local station ID)

Parameters

geoId Geometry station ID

Returns: (detector ID, local station ID)

Definition at line 137 of file CaSetup.h.

References fGeoSetup.

◆ GetActiveSetup()

template<typename Float>

const KfSetup_t & cbm::algo::ca::Setup< Float >::GetActiveSetup ( ) const

inline

Constant accessor to the active setup.

Definition at line 97 of file CaSetup.h.

References fActSetup.

◆ GetGeometrySetup()

template<typename Float>

const KfSetup_t & cbm::algo::ca::Setup< Float >::GetGeometrySetup ( ) const

inline

Constant accessor to the geometry setup.

Definition at line 100 of file CaSetup.h.

References fGeoSetup.

◆ GetNofActStations() [1/2]

template<typename Float>

int cbm::algo::ca::Setup< Float >::GetNofActStations ( ) const

inline

Gets total number of active stations.

Definition at line 103 of file CaSetup.h.

References fActSetup.

◆ GetNofActStations() [2/2]

template<typename Float>

int cbm::algo::ca::Setup< Float >::GetNofActStations ( EDetectorID detId ) const

inline

Gets number of active stations for a given detector subsystem.

Parameters

detId An identifier of the detector subsystem

Definition at line 107 of file CaSetup.h.

References fActSetup.

◆ GetNofGeoStations() [1/2]

template<typename Float>

int cbm::algo::ca::Setup< Float >::GetNofGeoStations ( ) const

inline

Gets total number of geometry stations.

Definition at line 110 of file CaSetup.h.

References fGeoSetup.

◆ GetNofGeoStations() [2/2]

template<typename Float>

int cbm::algo::ca::Setup< Float >::GetNofGeoStations ( EDetectorID detId ) const

inline

Gets number of geometry stations for a given detector subsystem.

Parameters

detId An identifier of the detector subsystem

Definition at line 114 of file CaSetup.h.

References fGeoSetup.

◆ LocToActStationId()

template<typename Float>

int cbm::algo::ca::Setup< Float >::LocToActStationId	(	EDetectorID	detId,
		int	locId ) const

inline

Converts (detectorId, local station ID) to active station ID.

Parameters

detId	Detector ID
locId	Local staiton ID

Returns: Active station ID

Definition at line 146 of file CaSetup.h.

References fActSetup.

◆ LocToGeoStationId()

template<typename Float>

int cbm::algo::ca::Setup< Float >::LocToGeoStationId	(	EDetectorID	detId,
		int	locId ) const

inline

Converts (detectorId, local station ID) to geometry station ID.

Parameters

detId	Detector ID
locId	Local staiton ID

Returns: Geometry station ID

Definition at line 155 of file CaSetup.h.

References fGeoSetup.

Referenced by Setup().

◆ operator=() [1/2]

template<typename Float>

Setup & cbm::algo::ca::Setup< Float >::operator= ( const Setup< Float > & other )

default

Copy assignment operator.

References Setup.

◆ operator=() [2/2]

template<typename Float>

Setup & cbm::algo::ca::Setup< Float >::operator= ( Setup< Float > && )

default

Move assignment operator.

References Setup.

◆ serialize()

template<typename Float>

template<class Archive>

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

inlineprivate

Serialization method.

Definition at line 173 of file CaSetup.h.

References fActSetup, fGeoSetup, fvActToGeoMap, and fvGeoToActMap.

Friends And Related Symbol Documentation

◆ boost::serialization::access

template<typename Float>

friend class boost::serialization::access

friend

Definition at line 161 of file CaSetup.h.

References boost::serialization::access.

Referenced by boost::serialization::access.

◆ Setup

template<typename Float>

template<typename>

friend class Setup

friend

Definition at line 56 of file CaSetup.h.

References Setup.

Referenced by operator=(), operator=(), Setup, Setup(), Setup(), and Setup().

Member Data Documentation

◆ fActSetup

template<typename Float>

KfSetup_t cbm::algo::ca::Setup< Float >::fActSetup

private

Active KF-setup (includes only inactive stations)

Definition at line 167 of file CaSetup.h.

Referenced by ActToLocStationId(), GetActiveSetup(), GetNofActStations(), GetNofActStations(), LocToActStationId(), serialize(), Setup(), and Setup().

◆ fGeoSetup

template<typename Float>

KfSetup_t cbm::algo::ca::Setup< Float >::fGeoSetup

private

Geometry KF-setup (includes both active and inactive stations)

Definition at line 166 of file CaSetup.h.

Referenced by GeoToLocStationId(), GetGeometrySetup(), GetNofGeoStations(), GetNofGeoStations(), LocToGeoStationId(), serialize(), Setup(), and Setup().

◆ fvActToGeoMap

template<typename Float>

StationArray_t<int> cbm::algo::ca::Setup< Float >::fvActToGeoMap

private

Maps actId -> geoId [actId].

Definition at line 169 of file CaSetup.h.

Referenced by ActToGeoStationId(), serialize(), Setup(), and Setup().

◆ fvGeoToActMap

template<typename Float>

StationArray_t<int> cbm::algo::ca::Setup< Float >::fvGeoToActMap

private

Maps geoId -> actId [geoId].

Definition at line 168 of file CaSetup.h.

Referenced by GeoToActStationId(), serialize(), Setup(), and Setup().

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

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ KfSetup_t

◆ StationArray_t

Constructor & Destructor Documentation

◆ Setup() [1/5]

◆ Setup() [2/5]

◆ Setup() [3/5]

◆ Setup() [4/5]

◆ Setup() [5/5]

◆ ~Setup()

Member Function Documentation

◆ ActToGeoStationId()

◆ ActToLocStationId()

◆ GeoToActStationId()

◆ GeoToLocStationId()

◆ GetActiveSetup()

◆ GetGeometrySetup()

◆ GetNofActStations() [1/2]

◆ GetNofActStations() [2/2]

◆ GetNofGeoStations() [1/2]

◆ GetNofGeoStations() [2/2]

◆ LocToActStationId()

◆ LocToGeoStationId()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ serialize()

Friends And Related Symbol Documentation

◆ boost::serialization::access

◆ Setup

Member Data Documentation

◆ fActSetup

◆ fGeoSetup

◆ fvActToGeoMap

◆ fvGeoToActMap