CbmRoot
Loading...
Searching...
No Matches
Classes | Public Member Functions | Private Types | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
CbmGenerateMaterialMaps Class Reference

Steer class for executing the material budget maps generator independently from tracking. More...

#include <CbmGenerateMaterialMaps.h>

Inheritance diagram for CbmGenerateMaterialMaps:
[legend]
Collaboration diagram for CbmGenerateMaterialMaps:
[legend]

Classes

struct  Config
 
struct  MaterialSlice
 Input parameters for the material map generation. More...
 

Public Member Functions

 CbmGenerateMaterialMaps ()
 Default constructor.
 
 CbmGenerateMaterialMaps (const char *name, int verbose)
 Constructor from parameters.
 
virtual ~CbmGenerateMaterialMaps ()=default
 Destructor.
 
 CbmGenerateMaterialMaps (const CbmGenerateMaterialMaps &)=delete
 Copy constructor.
 
 CbmGenerateMaterialMaps (CbmGenerateMaterialMaps &&)=delete
 Move constructor.
 
CbmGenerateMaterialMaps & operator= (const CbmGenerateMaterialMaps &)=delete
 Copy assignment operator.
 
CbmGenerateMaterialMaps & operator= (CbmGenerateMaterialMaps &&)=delete
 Move assignment operator.
 
InitStatus Init ()
 Initializer.
 
InitStatus ReInit ()
 Re-initializer.
 
void Finish ()
 Finish function.
 
void SetOutputName (const char *fileName)
 Sets output file name.
 
void SetUserConfig (const char *userConfig)
 Sets user configuration file.
 
const std::map< std::string, MaterialMap > & GetMaterial () const
 Gets material map.
 

Private Types

using MaterialMap = cbm::algo::kf::MaterialMap
 

Private Member Functions

void WriteMaterialMaps ()
 Writes material budget maps to file.
 
 ClassDef (CbmGenerateMaterialMaps, 0)
 

Private Attributes

Config fConfig
 Offset from target to start generating mat. maps [cm].
 
std::string fsUserConfig = ""
 User configuration file.
 
std::string fsOutputFile = "matBudget.root"
 Output file name.
 
std::map< std::string, MaterialMap > fmMaterial
 Material budget maps.
 
std::unique_ptr<::kf::tools::MaterialMapFactory > fpMaterialFactory {nullptr}
 Material factory instance.
 
double fTargetZ
 z-coordinate of the target center
 

Static Private Attributes

static constexpr double kXYoffset = 1.3
 
static constexpr double kTargetOffset = 1.
 Offset from station boarders [scale].
 

Detailed Description

Steer class for executing the material budget maps generator independently from tracking.

Definition at line 25 of file CbmGenerateMaterialMaps.h.

Member Typedef Documentation

◆ MaterialMap

using CbmGenerateMaterialMaps::MaterialMap = cbm::algo::kf::MaterialMap
private

Definition at line 26 of file CbmGenerateMaterialMaps.h.

Constructor & Destructor Documentation

◆ CbmGenerateMaterialMaps() [1/4]

CbmGenerateMaterialMaps::CbmGenerateMaterialMaps ( )

Default constructor.

Definition at line 22 of file CbmGenerateMaterialMaps.cxx.

References CbmGenerateMaterialMaps().

Referenced by CbmGenerateMaterialMaps(), CbmGenerateMaterialMaps(), CbmGenerateMaterialMaps(), ClassDef(), operator=(), and operator=().

◆ CbmGenerateMaterialMaps() [2/4]

CbmGenerateMaterialMaps::CbmGenerateMaterialMaps ( const char * name,
int verbose )

Constructor from parameters.

Parameters
nameName of the task
verboseVerbosity level

Definition at line 26 of file CbmGenerateMaterialMaps.cxx.

◆ ~CbmGenerateMaterialMaps()

virtual CbmGenerateMaterialMaps::~CbmGenerateMaterialMaps ( )
virtualdefault

Destructor.

◆ CbmGenerateMaterialMaps() [3/4]

CbmGenerateMaterialMaps::CbmGenerateMaterialMaps ( const CbmGenerateMaterialMaps & )
delete

Copy constructor.

References CbmGenerateMaterialMaps().

◆ CbmGenerateMaterialMaps() [4/4]

CbmGenerateMaterialMaps::CbmGenerateMaterialMaps ( CbmGenerateMaterialMaps && )
delete

Move constructor.

References CbmGenerateMaterialMaps().

Member Function Documentation

◆ ClassDef()

CbmGenerateMaterialMaps::ClassDef ( CbmGenerateMaterialMaps ,
0  )
private

References CbmGenerateMaterialMaps().

◆ Finish()

void CbmGenerateMaterialMaps::Finish ( )

Finish function.

Definition at line 30 of file CbmGenerateMaterialMaps.cxx.

◆ GetMaterial()

const std::map< std::string, MaterialMap > & CbmGenerateMaterialMaps::GetMaterial ( ) const
inline

Gets material map.

Definition at line 107 of file CbmGenerateMaterialMaps.h.

References fmMaterial.

◆ Init()

InitStatus CbmGenerateMaterialMaps::Init ( )

Initializer.

Definition at line 34 of file CbmGenerateMaterialMaps.cxx.

References fConfig, fmMaterial, fpMaterialFactory, fsUserConfig, fTargetZ, cbm::kf::Target::GetZ(), cbm::kf::Target::Instance(), cbm::RecoSetupManager::Instance(), kXYoffset, cbm::util::yaml::ReadFromFile(), and WriteMaterialMaps().

◆ operator=() [1/2]

CbmGenerateMaterialMaps & CbmGenerateMaterialMaps::operator= ( CbmGenerateMaterialMaps && )
delete

Move assignment operator.

References CbmGenerateMaterialMaps().

◆ operator=() [2/2]

CbmGenerateMaterialMaps & CbmGenerateMaterialMaps::operator= ( const CbmGenerateMaterialMaps & )
delete

Copy assignment operator.

References CbmGenerateMaterialMaps().

◆ ReInit()

InitStatus CbmGenerateMaterialMaps::ReInit ( )

Re-initializer.

Definition at line 136 of file CbmGenerateMaterialMaps.cxx.

◆ SetOutputName()

void CbmGenerateMaterialMaps::SetOutputName ( const char * fileName)
inline

Sets output file name.

Definition at line 101 of file CbmGenerateMaterialMaps.h.

References fsOutputFile.

◆ SetUserConfig()

void CbmGenerateMaterialMaps::SetUserConfig ( const char * userConfig)
inline

Sets user configuration file.

Definition at line 104 of file CbmGenerateMaterialMaps.h.

References fsUserConfig.

◆ WriteMaterialMaps()

void CbmGenerateMaterialMaps::WriteMaterialMaps ( )
private

Writes material budget maps to file.

The material maps are represented with ROOT histograms. The value of the material thickness is represented in units of radiational length

Definition at line 140 of file CbmGenerateMaterialMaps.cxx.

References fConfig, fmMaterial, fsOutputFile, fTargetZ, and kf::tools::RootUtils::ToHistogram().

Referenced by Init().

Member Data Documentation

◆ fConfig

Config CbmGenerateMaterialMaps::fConfig
private

Offset from target to start generating mat. maps [cm].

Configuration for the task

Definition at line 114 of file CbmGenerateMaterialMaps.h.

Referenced by Init(), and WriteMaterialMaps().

◆ fmMaterial

std::map<std::string, MaterialMap> CbmGenerateMaterialMaps::fmMaterial
private

Material budget maps.

Definition at line 117 of file CbmGenerateMaterialMaps.h.

Referenced by GetMaterial(), Init(), and WriteMaterialMaps().

◆ fpMaterialFactory

std::unique_ptr<::kf::tools::MaterialMapFactory> CbmGenerateMaterialMaps::fpMaterialFactory {nullptr}
private

Material factory instance.

Definition at line 118 of file CbmGenerateMaterialMaps.h.

Referenced by Init().

◆ fsOutputFile

std::string CbmGenerateMaterialMaps::fsOutputFile = "matBudget.root"
private

Output file name.

Definition at line 116 of file CbmGenerateMaterialMaps.h.

Referenced by SetOutputName(), and WriteMaterialMaps().

◆ fsUserConfig

std::string CbmGenerateMaterialMaps::fsUserConfig = ""
private

User configuration file.

Definition at line 115 of file CbmGenerateMaterialMaps.h.

Referenced by Init(), and SetUserConfig().

◆ fTargetZ

double CbmGenerateMaterialMaps::fTargetZ
private

z-coordinate of the target center

Definition at line 120 of file CbmGenerateMaterialMaps.h.

Referenced by Init(), and WriteMaterialMaps().

◆ kTargetOffset

double CbmGenerateMaterialMaps::kTargetOffset = 1.
staticconstexprprivate

Offset from station boarders [scale].

Definition at line 112 of file CbmGenerateMaterialMaps.h.

◆ kXYoffset

double CbmGenerateMaterialMaps::kXYoffset = 1.3
staticconstexprprivate

Definition at line 111 of file CbmGenerateMaterialMaps.h.

Referenced by Init().

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