Encapsulation of the kf::Setup initialization routines for CBM. More...

#include <CbmKfTrackingSetupBuilder.h>

Collaboration diagram for cbm::kf::TrackingSetupBuilder:

Public Member Functions
std::shared_ptr< const cbm::algo::kf::Setup< double > >	GetSharedGeoSetup ()
	Gets a shared pointer to the geometry setup.

template<typename T >
cbm::algo::kf::Setup< T >	MakeSetup (cbm::algo::kf::EFieldMode fldMode)
	Makes setup object.

bool	IsInGeometry (cbm::algo::ca::EDetectorID detID) const
	Checks, if a tracking detector is used (is in geometry and has hits)

bool	HasHits (cbm::algo::ca::EDetectorID detID) const
	Checks, if a tracking detector has hits.

void	SetIgnoreHitPresence (bool ok=true)
	Sets hits ignoring (DEBUG FLAG)

	TrackingSetupBuilder (const TrackingSetupBuilder &)=delete

	TrackingSetupBuilder (TrackingSetupBuilder &&)=delete

TrackingSetupBuilder &	operator= (const TrackingSetupBuilder &)=delete

TrackingSetupBuilder &	operator= (TrackingSetupBuilder &&)=delete

Static Public Member Functions
static TrackingSetupBuilder *	Instance ()
	Instance access.

Private Types
template<typename T >
using	DetectorIDArray_t = cbm::core::EnumArray<cbm::algo::ca::EDetectorID, T>

Private Member Functions
	TrackingSetupBuilder ()=default
	Default constructor.

	~TrackingSetupBuilder ()=default
	Destructor.

void	CheckDetectorPresence ()
	Check detector presence.

void	SetMaterialCacheFile (const TString &filename, size_t geoHash)
	Sets the material budget cache file name.

void	Init ()
	Initializes the instance.

Private Attributes
cbm::algo::kf::SetupBuilder	fBuilder {}
	KF-setup builder.

DetectorIDArray_t< bool >	fvbDetInGeometry {{false}}
	Is detector subsystem in geometry?

DetectorIDArray_t< bool >	fvbDetHasHits {{false}}
	Does detector subsystem have hits?

std::shared_ptr< cbm::algo::kf::Setup< double > >	fpGeoSetup {nullptr}
	An instance of the tracking KF-setup in a double precision.

bool	fbInitialized {false}
	Checks, if the setup was already initialized.

bool	fbIgnoreHitPresence {false}
	Ignores hit presence, when active subsystems are determined.

Static Private Attributes
static constexpr DetectorIDArray_t< const char * >	kDetHitBrName
	Hit branch names vs. cbm::algo::ca::EDetectorID.

static constexpr double	kMatCreatorPitch {0.1}
	Material budget map minimal bin size [cm].

static constexpr int	kMatCreatorMaxNbins {100}
	Max number of bins in the material budget map in x(y) axis.

static constexpr int	kMatCreatorNrays {3}
	Number of rays per dimension for the material budget.

static constexpr bool	kMatCreatorSafeMode {true}
	Safe mode of the material map creation.

static constexpr double	kTargFieldInitStep {2.5}
	Step between nodes in the target field initialization [cm].

static constexpr double	kTargMaterialOffset {1}
	Offset between target upper limit and its material zMax [cm].

static TrackingSetupBuilder *	fpInstance {nullptr}

static std::mutex	fMutex {}

Detailed Description

Encapsulation of the kf::Setup initialization routines for CBM.

Definition at line 24 of file CbmKfTrackingSetupBuilder.h.

Member Typedef Documentation

◆ DetectorIDArray_t

template<typename T >

using cbm::kf::TrackingSetupBuilder::DetectorIDArray_t = cbm::core::EnumArray<cbm::algo::ca::EDetectorID, T>

private

Definition at line 67 of file CbmKfTrackingSetupBuilder.h.

Constructor & Destructor Documentation

◆ TrackingSetupBuilder() [1/3]

cbm::kf::TrackingSetupBuilder::TrackingSetupBuilder ( const TrackingSetupBuilder & )

delete

◆ TrackingSetupBuilder() [2/3]

cbm::kf::TrackingSetupBuilder::TrackingSetupBuilder ( TrackingSetupBuilder && )

delete

◆ TrackingSetupBuilder() [3/3]

cbm::kf::TrackingSetupBuilder::TrackingSetupBuilder ( )

privatedefault

Default constructor.

◆ ~TrackingSetupBuilder()

cbm::kf::TrackingSetupBuilder::~TrackingSetupBuilder ( )

privatedefault

Destructor.

Member Function Documentation

◆ CheckDetectorPresence()

void TrackingSetupBuilder::CheckDetectorPresence ( )

private

Check detector presence.

Definition at line 38 of file CbmKfTrackingSetupBuilder.cxx.

References fbIgnoreHitPresence, fvbDetHasHits, fvbDetInGeometry, CbmSetup::Instance(), CbmSetup::IsActive(), kDetHitBrName, cbm::algo::ca::ToCbmModuleId(), and ToString().

Referenced by Init(), Instance(), and SetIgnoreHitPresence().

◆ GetSharedGeoSetup()

std::shared_ptr< const cbm::algo::kf::Setup< double > > TrackingSetupBuilder::GetSharedGeoSetup ( )

Gets a shared pointer to the geometry setup.

Note: The original magnetic field is defined.; Use-cases: precise fit in physical analyses and QA.

Definition at line 64 of file CbmKfTrackingSetupBuilder.cxx.

References fpGeoSetup, and MakeSetup().

Referenced by CbmKfTrackFitter::Init().

◆ HasHits()

bool cbm::kf::TrackingSetupBuilder::HasHits ( cbm::algo::ca::EDetectorID detID ) const

inline

Checks, if a tracking detector has hits.

Definition at line 49 of file CbmKfTrackingSetupBuilder.h.

References fvbDetHasHits.

◆ Init()

void TrackingSetupBuilder::Init ( )

private

Initializes the instance.

Note: Is executed on the first call of MakeSetup function

Definition at line 76 of file CbmKfTrackingSetupBuilder.cxx.

References cbm::algo::kf::SetupBuilder::AddLayer(), CheckDetectorPresence(), fbInitialized, fBuilder, fvbDetInGeometry, cbm::kf::Target::Instance(), CbmMuchTrackingInterface::Instance(), CbmMvdTrackingInterface::Instance(), CbmStsTrackingInterface::Instance(), CbmTofTrackingInterface::Instance(), CbmTrdTrackingInterface::Instance(), kMatCreatorNrays, kMatCreatorSafeMode, cbm::algo::kf::defs::MinField, cbm::algo::kf::SetupBuilder::Reset(), cbm::algo::kf::SetupBuilder::SetFieldFunction(), cbm::algo::kf::SetupBuilder::SetMaterialMapFactory(), and cbm::algo::kf::SetupBuilder::SetTargetProperty().

Referenced by MakeSetup().

◆ Instance()

TrackingSetupBuilder * TrackingSetupBuilder::Instance ( )

static

Instance access.

Definition at line 143 of file CbmKfTrackingSetupBuilder.cxx.

References CheckDetectorPresence(), fMutex, fpInstance, CbmSetup::GetProvider(), CbmGeoSetupProvider::GetSetup(), CbmGeoSetup::GetTag(), CbmSetup::Instance(), and SetMaterialCacheFile().

Referenced by CbmOnlineParWrite::AddCa(), CbmKfTrackFitter::Init(), and CbmL1::Init().

◆ IsInGeometry()

bool cbm::kf::TrackingSetupBuilder::IsInGeometry ( cbm::algo::ca::EDetectorID detID ) const

inline

Checks, if a tracking detector is used (is in geometry and has hits)

Definition at line 46 of file CbmKfTrackingSetupBuilder.h.

References fvbDetInGeometry.

◆ MakeSetup()

template<typename T >

cbm::algo::kf::Setup< T > cbm::kf::TrackingSetupBuilder::MakeSetup ( cbm::algo::kf::EFieldMode fldMode )

inline

Makes setup object.

Parameters

fldMode Field mode (kf::EFiledMode)

Definition at line 37 of file CbmKfTrackingSetupBuilder.h.

References fbInitialized, fBuilder, Init(), and cbm::algo::kf::SetupBuilder::MakeSetup().

Referenced by GetSharedGeoSetup().

◆ operator=() [1/2]

TrackingSetupBuilder & cbm::kf::TrackingSetupBuilder::operator= ( const TrackingSetupBuilder & )

delete

◆ operator=() [2/2]

TrackingSetupBuilder & cbm::kf::TrackingSetupBuilder::operator= ( TrackingSetupBuilder && )

delete

◆ SetIgnoreHitPresence()

void cbm::kf::TrackingSetupBuilder::SetIgnoreHitPresence ( bool ok = true )

inline

Sets hits ignoring (DEBUG FLAG)

Definition at line 52 of file CbmKfTrackingSetupBuilder.h.

References CheckDetectorPresence(), fbIgnoreHitPresence, and fbInitialized.

◆ SetMaterialCacheFile()

void cbm::kf::TrackingSetupBuilder::SetMaterialCacheFile	(	const TString &	filename,
		size_t	geoHash )

inlineprivate

Sets the material budget cache file name.

Parameters

filename	Material budget cache file name
geoHash	A hash of the geometry

If provided, the instance will try to read the material budget maps from the file. If the file does not exist,or the geometry hash was changed since the last time (reference hash differs from the one read from the file), a warning will be produced, the material budget maps will be recreated on the fly and they will be stored again to the file (meaning a new cache file will be generated over the existing one).

Definition at line 90 of file CbmKfTrackingSetupBuilder.h.

References fBuilder, and cbm::algo::kf::SetupBuilder::SetMaterialCacheFile().

Referenced by Instance().

Member Data Documentation

◆ fbIgnoreHitPresence

bool cbm::kf::TrackingSetupBuilder::fbIgnoreHitPresence {false}

private

Ignores hit presence, when active subsystems are determined.

Definition at line 123 of file CbmKfTrackingSetupBuilder.h.

Referenced by CheckDetectorPresence(), and SetIgnoreHitPresence().

◆ fbInitialized

bool cbm::kf::TrackingSetupBuilder::fbInitialized {false}

private

Checks, if the setup was already initialized.

Note: Each call of the setup initializer resets the setup builder, so the initialization is called in the next MakeSetup call Check, if the setup builder initialized

Definition at line 122 of file CbmKfTrackingSetupBuilder.h.

Referenced by Init(), MakeSetup(), and SetIgnoreHitPresence().