Maps local detector and station indices to the material maps and field slices. More...

#include <KfModuleIndexMap.h>

Public Member Functions
int	GetNofLayers () const
	Gets total number of components.

template<class EDetId>
int	GetNofLayers (EDetId detId) const
	Gets number of layers of a given EDetId.

template<class EDetId = int>
std::pair< EDetId, int >	GlobalToLocal (int globId) const
	Converts internal layer index to pair (detID, locID)

template<class EDetId>
int	LocalToGlobal (EDetId detId, int locId) const
	Converts external pair (detID, locID) to internal layer index.

template<class EDetId>
void	Disable (EDetId detId, int locId)
	Disables a component.

void	Reset ()
	Resets the instance.

std::string	ToString (int indentLevel=0) const
	String representation of the instance.

Private Member Functions
template<class EDetId>
int	GetIntDetIndex (EDetId detId) const
	Gets internal index of the detector ID.

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

Private Attributes
std::vector< int >	fvLocToGlb {}

std::vector< std::pair< int, int > >	fvGlbToLoc {}

std::vector< int >	fvDetLocOffset {}
	First index of component for det.

std::vector< int >	fvDetIntToExt {}
	Maps external detID to internal.

std::vector< int >	fvDetExtToInt {}
	Maps internal detID to external.

std::vector< int >	fvNofLayersIntDet {}
	Number of layers in a detector.

Friends
class	ModuleIndexMapFactory

class	boost::serialization::access

Detailed Description

Maps local detector and station indices to the material maps and field slices.

The class maps external indices of components combined into subsets to a plain global index. The indices both of the components inside a subset (iLoc) and the indices of the subsets themselves (iDetExt) must be unique, but can be unsorted and can have holes in their ranges. The global index (iGlob) is assigned automatically depending on the element ordering.

The mapping is organized with the sequential contiguous containers (std::vector). The containers used are: (i) fvDetExtToInt [ iDetExt ] => iDetInt size: max(iDetExt) (ii) fvDetIntToExt [ iDetInt ] => iDetExt (int) size: number of registered subsystems (iii) fvDetLocOffset [ iDetInt ] => max number of elements for iDetInt - 1 size: max possible number of elements (including inactive/unused) fvDetLocOffset[0] = 0, fvDetLocOffset.back() = n of max possible elements (iv) fvGlbToLoc [ iGlob ] => pair(iDetInt, iLoc) size: number of registered components (v) fvLocToGlb [ fvDetLocOffset[iDetInt] + iLoc] => iGlob size: max possible number of components (including inactive/unused)

Definition at line 50 of file KfModuleIndexMap.h.

Member Function Documentation

◆ Disable()

template<class EDetId>

void cbm::algo::kf::ModuleIndexMap::Disable	(	EDetId	detId,
		int	locId )

Disables a component.

Template Parameters

EDetId concrete index type of the det ID (can be either an enum, or an integral type)

Parameters

locId	Local ID of the layer
detId	Detector ID of the component

Definition at line 162 of file KfModuleIndexMap.h.

References Disable(), fvDetExtToInt, fvDetIntToExt, fvDetLocOffset, fvGlbToLoc, fvLocToGlb, and fvNofLayersIntDet.

Referenced by Disable().

◆ GetIntDetIndex()

template<class EDetId>

int cbm::algo::kf::ModuleIndexMap::GetIntDetIndex ( EDetId detId ) const

inlineprivate

Gets internal index of the detector ID.

Template Parameters

EDetId

Definition at line 104 of file KfModuleIndexMap.h.

References fvDetExtToInt.

Referenced by GetNofLayers().

◆ GetNofLayers() [1/2]

int cbm::algo::kf::ModuleIndexMap::GetNofLayers ( ) const

inline

Gets total number of components.

Definition at line 56 of file KfModuleIndexMap.h.

References fvGlbToLoc.

Referenced by ToString().

◆ GetNofLayers() [2/2]

template<class EDetId>

int cbm::algo::kf::ModuleIndexMap::GetNofLayers ( EDetId detId ) const

inline

Gets number of layers of a given EDetId.

Template Parameters

EDetId concrete index type of the det ID (can be either an enum, or an integral type)

Parameters

detId Detector ID of the component

Definition at line 62 of file KfModuleIndexMap.h.

References fvNofLayersIntDet, and GetIntDetIndex().

◆ GlobalToLocal()

template<class EDetId>

std::pair< EDetId, int > cbm::algo::kf::ModuleIndexMap::GlobalToLocal ( int globId ) const

inline

Converts internal layer index to pair (detID, locID)

Template Parameters

EDetId concrete index type of the det ID (can be either an enum, or an integral type)

Parameters

globId Internal layer index

Returns: pair(detector ID, local ID) of the layer

Definition at line 189 of file KfModuleIndexMap.h.

References fvGlbToLoc, and GlobalToLocal().

Referenced by GlobalToLocal().

◆ LocalToGlobal()

template<class EDetId>

int cbm::algo::kf::ModuleIndexMap::LocalToGlobal	(	EDetId	detId,
		int	locId ) const

inline

Converts external pair (detID, locID) to internal layer index.

Template Parameters

EDetId concrete index type of the det ID (can be either an enum, or an integral type)

Parameters

locId	Local ID of the layer
detId	Detector ID of the component

Note: if the (detId, locId) pair was not registered, returns -1

Returns: global index of the layer

Definition at line 82 of file KfModuleIndexMap.h.

References fvDetExtToInt, fvDetLocOffset, and fvLocToGlb.

◆ Reset()

void cbm::algo::kf::ModuleIndexMap::Reset ( )

Resets the instance.

Definition at line 16 of file KfModuleIndexMap.cxx.

References fvDetExtToInt, fvDetIntToExt, fvDetLocOffset, fvGlbToLoc, and fvLocToGlb.

◆ serialize()

template<class Archive>

void cbm::algo::kf::ModuleIndexMap::serialize	(	Archive &	ar,
		const unsigned int	)

inlineprivate

Definition at line 110 of file KfModuleIndexMap.h.

References fvDetExtToInt, fvDetIntToExt, fvDetLocOffset, fvGlbToLoc, fvLocToGlb, and fvNofLayersIntDet.

◆ ToString()

std::string cbm::algo::kf::ModuleIndexMap::ToString ( int indentLevel = 0 ) const

String representation of the instance.

Definition at line 27 of file KfModuleIndexMap.cxx.

References fvGlbToLoc, and GetNofLayers().

Friends And Related Symbol Documentation

◆ boost::serialization::access

friend class boost::serialization::access

friend

Definition at line 52 of file KfModuleIndexMap.h.

◆ ModuleIndexMapFactory

friend class ModuleIndexMapFactory

friend

Definition at line 51 of file KfModuleIndexMap.h.

References ModuleIndexMapFactory.

Referenced by ModuleIndexMapFactory.

Member Data Documentation

◆ fvDetExtToInt

std::vector<int> cbm::algo::kf::ModuleIndexMap::fvDetExtToInt {}

private

Maps internal detID to external.

Definition at line 124 of file KfModuleIndexMap.h.

Referenced by Disable(), GetIntDetIndex(), LocalToGlobal(), cbm::algo::kf::ModuleIndexMapFactory::MakeIndexMap(), Reset(), and serialize().

◆ fvDetIntToExt

std::vector<int> cbm::algo::kf::ModuleIndexMap::fvDetIntToExt {}

private

Maps external detID to internal.

Definition at line 123 of file KfModuleIndexMap.h.

Referenced by Disable(), cbm::algo::kf::ModuleIndexMapFactory::MakeIndexMap(), Reset(), and serialize().

◆ fvDetLocOffset

std::vector<int> cbm::algo::kf::ModuleIndexMap::fvDetLocOffset {}

private

First index of component for det.

Definition at line 122 of file KfModuleIndexMap.h.

Referenced by Disable(), LocalToGlobal(), cbm::algo::kf::ModuleIndexMapFactory::MakeIndexMap(), Reset(), and serialize().

◆ fvGlbToLoc

std::vector<std::pair<int, int> > cbm::algo::kf::ModuleIndexMap::fvGlbToLoc {}

private

Definition at line 121 of file KfModuleIndexMap.h.

Referenced by Disable(), GetNofLayers(), GlobalToLocal(), cbm::algo::kf::ModuleIndexMapFactory::MakeIndexMap(), Reset(), serialize(), and ToString().

◆ fvLocToGlb

std::vector<int> cbm::algo::kf::ModuleIndexMap::fvLocToGlb {}

private

Definition at line 120 of file KfModuleIndexMap.h.

Referenced by Disable(), LocalToGlobal(), cbm::algo::kf::ModuleIndexMapFactory::MakeIndexMap(), Reset(), and serialize().

◆ fvNofLayersIntDet

std::vector<int> cbm::algo::kf::ModuleIndexMap::fvNofLayersIntDet {}

private

Number of layers in a detector.

Definition at line 125 of file KfModuleIndexMap.h.

Referenced by Disable(), GetNofLayers(), cbm::algo::kf::ModuleIndexMapFactory::MakeIndexMap(), and serialize().

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

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Function Documentation

◆ Disable()

◆ GetIntDetIndex()

◆ GetNofLayers() [1/2]

◆ GetNofLayers() [2/2]

◆ GlobalToLocal()

◆ LocalToGlobal()

◆ Reset()

◆ serialize()

◆ ToString()

Friends And Related Symbol Documentation

◆ boost::serialization::access

◆ ModuleIndexMapFactory

Member Data Documentation

◆ fvDetExtToInt

◆ fvDetIntToExt

◆ fvDetLocOffset

◆ fvGlbToLoc

◆ fvLocToGlb

◆ fvNofLayersIntDet