A map of station thickness in units of radiation length (X0) to the specific point in XY plane. More...

#include <KfMaterialMap.h>

Public Member Functions
	MaterialMap ()=default
	Default constructor.

	MaterialMap (int nBins, float xyMax, float zRef, float zMin, float zMax)
	Constructor from parameters.

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

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

	MaterialMap (MaterialMap &&other) noexcept
	Move constructor.

MaterialMap &	operator= (MaterialMap &&other) noexcept
	Move assignment operator.

	~MaterialMap () noexcept=default
	Destructor.

void	Add (const MaterialMap &other, float zTarg=defs::Undef< float >)
	Adds material layer.

int	GetBin (float x, float y) const
	Gets bin index for (x,y). Returns -1 when outside of the map.

int	GetNbins () const
	Gets number of bins (rows or columns) of the material table.

float	GetXYmax () const
	Gets radius of the material table [cm].

float	GetZref () const
	Gets reference Z of the material [cm].

float	GetZmin () const
	Gets minimal Z of the collected material [cm].

float	GetZmax () const
	Gets maximal Z of the collected material [cm].

template<typename I >
I	GetThicknessX0 (const I &x, const I &y) const
	Gets material thickness in units of radiational length X0.

template<typename I >
I	GetBinThicknessX0 (int iGlob) const
	Gets material thickness in units of radiational length X0.

template<typename I >
I	GetBinThicknessX0 (int iX, int iY) const
	Gets material thickness in units of radiational length X0.

bool	IsUndefined () const
	Function to test the instance for NaN.

void	Rebin (int factor)
	Reduces number of bins by a given factor.

void	SetRadThickBin (int iBinX, int iBinY, float thickness)
	Sets value of material thickness in units of X0 for a given cell of the material table.

void	Swap (MaterialMap &other) noexcept
	Swap method.

std::string	ToString (int indentLevel=0, int verbose=1) const
	String representation of the object.

Private Member Functions
void	CheckConsistency () const
	Checks the object consistency.

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

Private Attributes
int	fNbins = defs::Undef<int>
	Number of rows (== N columns) in the material budget table.

float	fXYmax = defs::Undef<float>
	Size of the station in x and y dimensions [cm].

float	fFactor = defs::Undef<float>
	Util. var. for the conversion of point coordinates to row/column id.

float	fZref = defs::Undef<float>
	Reference Z of the collected material [cm].

float	fZmin = defs::Undef<float>
	Minimal Z of the collected material [cm].

float	fZmax = defs::Undef<float>
	Minimal Z of the collected material [cm].

std::vector< float >	fTable {}
	Material budget table.

Friends
class	boost::serialization::access
	Serialization function.

bool	operator< (const MaterialMap &lhs, const MaterialMap &rhs)
	Comparison operator (material map ordering by fZref)

Detailed Description

A map of station thickness in units of radiation length (X0) to the specific point in XY plane.

Definition at line 27 of file KfMaterialMap.h.

Constructor & Destructor Documentation

◆ MaterialMap() [1/4]

cbm::algo::kf::MaterialMap::MaterialMap ( )

default

Default constructor.

◆ MaterialMap() [2/4]

MaterialMap::MaterialMap	(	int	nBins,
		float	xyMax,
		float	zRef,
		float	zMin,
		float	zMax )

Constructor from parameters.

Parameters

nBins	Number of rows or columns
xyMax	Size of station in x and y dimensions [cm]
zRef	Reference z-coordinate of the material layer [cm]
zMin	Lower boundary z-coordinate for the material layer [cm]
zMax	Upper boundary z-coordinate for the material layer [cm]

Definition at line 22 of file KfMaterialMap.cxx.

References CheckConsistency(), fNbins, and fTable.

◆ MaterialMap() [3/4]

cbm::algo::kf::MaterialMap::MaterialMap ( const MaterialMap & other )

default

Copy constructor.

◆ MaterialMap() [4/4]

MaterialMap::MaterialMap ( MaterialMap && other )

noexcept

Move constructor.

Definition at line 36 of file KfMaterialMap.cxx.

◆ ~MaterialMap()

cbm::algo::kf::MaterialMap::~MaterialMap ( )

defaultnoexcept

Destructor.

Member Function Documentation

◆ Add()

void MaterialMap::Add	(	const MaterialMap &	other,
		float	zTarg = defs::Undef<float> )

Adds material layer.

Parameters

other	Other material layer
zTarg	z-coordinate of the target

Definition at line 51 of file KfMaterialMap.cxx.

References fNbins, fTable, fXYmax, fZmax, fZmin, fZref, and GetThicknessX0().

◆ CheckConsistency()

void MaterialMap::CheckConsistency ( ) const

private

Checks the object consistency.

Exceptions

std::logic_error If the object is in non-valid mode

Definition at line 182 of file KfMaterialMap.cxx.

References fNbins, fXYmax, fZmax, fZmin, and fZref.

Referenced by MaterialMap().

◆ GetBin()

int MaterialMap::GetBin	(	float	x,
		float	y ) const

Gets bin index for (x,y). Returns -1 when outside of the map.

Definition at line 86 of file KfMaterialMap.cxx.

References fFactor, fNbins, fXYmax, x, and y.

Referenced by cbm::algo::kf::MaterialMonitor::MarkActiveBin().

◆ GetBinThicknessX0() [1/2]

template<typename I >

I cbm::algo::kf::MaterialMap::GetBinThicknessX0 ( int iGlob ) const

inline

Gets material thickness in units of radiational length X0.

Template Parameters

I	Type of material thickness

Parameters

iGlob Global bin number: iGlob = iX + iY * fNbins

Definition at line 107 of file KfMaterialMap.h.

Referenced by cbm::algo::kf::MaterialMonitor::EvaluateStatistics(), and kf::tools::RootUtils::ToHistogram().

◆ GetBinThicknessX0() [2/2]

template<typename I >

I cbm::algo::kf::MaterialMap::GetBinThicknessX0	(	int	iX,
		int	iY ) const

inline

Gets material thickness in units of radiational length X0.

Template Parameters

I	Type of material thickness

Parameters

iX	Bin number along x axis
iY	Bin number along y axis

Definition at line 126 of file KfMaterialMap.h.

◆ GetNbins()

int cbm::algo::kf::MaterialMap::GetNbins ( ) const

inline

Gets number of bins (rows or columns) of the material table.

Definition at line 64 of file KfMaterialMap.h.

Referenced by cbm::algo::kf::MaterialMonitor::EvaluateStatistics(), cbm::algo::kf::MaterialMonitor::SetMaterial(), and kf::tools::RootUtils::ToHistogram().

◆ GetThicknessX0()

template<typename I >

I cbm::algo::kf::MaterialMap::GetThicknessX0	(	const I &	x,
		const I &	y ) const

inline

Gets material thickness in units of radiational length X0.

Template Parameters

I	Type of the x and y (floating point)

Parameters

x	X coordinate of the point [cm]
y	Y coordinate of the point [cm]

Definition at line 83 of file KfMaterialMap.h.

References x, and y.

Referenced by Add().

◆ GetXYmax()

float cbm::algo::kf::MaterialMap::GetXYmax ( ) const

inline

Gets radius of the material table [cm].

Definition at line 67 of file KfMaterialMap.h.

Referenced by kf::tools::RootUtils::ToHistogram().

◆ GetZmax()

float cbm::algo::kf::MaterialMap::GetZmax ( ) const

inline

Gets maximal Z of the collected material [cm].

Definition at line 76 of file KfMaterialMap.h.

◆ GetZmin()

float cbm::algo::kf::MaterialMap::GetZmin ( ) const

inline

Gets minimal Z of the collected material [cm].

Definition at line 73 of file KfMaterialMap.h.

◆ GetZref()

float cbm::algo::kf::MaterialMap::GetZref ( ) const

inline

Gets reference Z of the material [cm].

Definition at line 70 of file KfMaterialMap.h.

◆ IsUndefined()

bool cbm::algo::kf::MaterialMap::IsUndefined ( ) const

inline

Function to test the instance for NaN.

Definition at line 132 of file KfMaterialMap.h.

Referenced by cbm::algo::kf::Target< T >::SetMaterial().

◆ operator=() [1/2]

MaterialMap & cbm::algo::kf::MaterialMap::operator= ( const MaterialMap & other )

default

Copy assignment operator.

◆ operator=() [2/2]

MaterialMap & MaterialMap::operator= ( MaterialMap && other )

noexcept

Move assignment operator.

Definition at line 40 of file KfMaterialMap.cxx.

◆ Rebin()

void MaterialMap::Rebin ( int factor )

Reduces number of bins by a given factor.

Parameters

factor Number of bins in a new bin

Definition at line 98 of file KfMaterialMap.cxx.

References fFactor, fNbins, and fTable.

◆ serialize()

template<class Archive >

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

inlineprivate

Definition at line 178 of file KfMaterialMap.h.

◆ SetRadThickBin()

void cbm::algo::kf::MaterialMap::SetRadThickBin	(	int	iBinX,
		int	iBinY,
		float	thickness )

inline

Sets value of material thickness in units of X0 for a given cell of the material table.

Parameters

iBinX	Index of table column
iBinY	Index of table row
thickness	Thickness of the material in units of X0

Note: Indices of rows and columns in the table runs from 0 to nBins-1 inclusively, where nBins is the number both of rows and columns. One should be careful while reading and storing the table from ROOT-file, because iBinX = 0 and iBinY = 0 in the TH1::SetBinContent method of usually defines the underflow bin.

Definition at line 148 of file KfMaterialMap.h.

Referenced by kf::tools::MaterialMapFactory::GenerateMaterialMap().

◆ Swap()

void MaterialMap::Swap ( MaterialMap & other )

noexcept

Swap method.

Definition at line 133 of file KfMaterialMap.cxx.

◆ ToString()

std::string MaterialMap::ToString	(	int	indentLevel = 0,
		int	verbose = 1 ) const

String representation of the object.

Parameters

indentLevel	Indent level of the string output
verbose	Verbosity level

Definition at line 146 of file KfMaterialMap.cxx.

References fNbins, fXYmax, fZmax, fZmin, and fZref.

Friends And Related Symbol Documentation

◆ boost::serialization::access

friend class boost::serialization::access

friend

Serialization function.

Definition at line 176 of file KfMaterialMap.h.

◆ operator<

bool operator<	(	const MaterialMap &	lhs,
		const MaterialMap &	rhs )

friend

Comparison operator (material map ordering by fZref)

Definition at line 159 of file KfMaterialMap.h.

Member Data Documentation

◆ fFactor

float cbm::algo::kf::MaterialMap::fFactor = defs::Undef<float>

private

Util. var. for the conversion of point coordinates to row/column id.

Definition at line 169 of file KfMaterialMap.h.

Referenced by GetBin(), and Rebin().

◆ fNbins

int cbm::algo::kf::MaterialMap::fNbins = defs::Undef<int>

private

Number of rows (== N columns) in the material budget table.

Definition at line 167 of file KfMaterialMap.h.

Referenced by Add(), CheckConsistency(), GetBin(), MaterialMap(), Rebin(), and ToString().

◆ fTable

std::vector<float> cbm::algo::kf::MaterialMap::fTable {}

private

Material budget table.

Definition at line 173 of file KfMaterialMap.h.

Referenced by Add(), MaterialMap(), and Rebin().

◆ fXYmax

float cbm::algo::kf::MaterialMap::fXYmax = defs::Undef<float>

private

Size of the station in x and y dimensions [cm].

Definition at line 168 of file KfMaterialMap.h.

Referenced by Add(), CheckConsistency(), GetBin(), and ToString().

◆ fZmax

float cbm::algo::kf::MaterialMap::fZmax = defs::Undef<float>

private

Minimal Z of the collected material [cm].

Definition at line 172 of file KfMaterialMap.h.

Referenced by Add(), CheckConsistency(), and ToString().

◆ fZmin

float cbm::algo::kf::MaterialMap::fZmin = defs::Undef<float>

private

Minimal Z of the collected material [cm].

Definition at line 171 of file KfMaterialMap.h.

Referenced by Add(), CheckConsistency(), and ToString().

◆ fZref

float cbm::algo::kf::MaterialMap::fZref = defs::Undef<float>

private

Reference Z of the collected material [cm].

Definition at line 170 of file KfMaterialMap.h.

Referenced by Add(), CheckConsistency(), and ToString().

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

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ MaterialMap() [1/4]

◆ MaterialMap() [2/4]

◆ MaterialMap() [3/4]

◆ MaterialMap() [4/4]

◆ ~MaterialMap()

Member Function Documentation

◆ Add()

◆ CheckConsistency()

◆ GetBin()

◆ GetBinThicknessX0() [1/2]

◆ GetBinThicknessX0() [2/2]

◆ GetNbins()

◆ GetThicknessX0()

◆ GetXYmax()

◆ GetZmax()

◆ GetZmin()

◆ GetZref()

◆ IsUndefined()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ Rebin()

◆ serialize()

◆ SetRadThickBin()

◆ Swap()

◆ ToString()

Friends And Related Symbol Documentation

◆ boost::serialization::access

◆ operator<

Member Data Documentation

◆ fFactor

◆ fNbins

◆ fTable

◆ fXYmax

◆ fZmax

◆ fZmin

◆ fZref