Settings for STS simulation (digitizer) More...

#include <CbmStsParSim.h>

Inheritance diagram for CbmStsParSim:

Collaboration diagram for CbmStsParSim:

Public Member Functions
	CbmStsParSim (const char name="CbmStsParSim", const char title="STS parameters", const char *context="Default")
	Constructor. More...

virtual	~CbmStsParSim ()
	Destructor. More...

virtual void	clear ()
	Reset all parameters. More...

Bool_t	CrossTalk () const
	Check whether cross-talk is applied. More...

Bool_t	Diffusion () const
	Check whether diffusion is applied. More...

CbmStsELoss	ELossModel () const
	Energy loss model. More...

Bool_t	EventMode () const
	Check whether event-by-event mode is applied. More...

virtual Bool_t	getParams (FairParamList *parList)
	Reading parameters from ASCII. Abstract in base class. More...

Bool_t	LorentzShift () const
	Check whether Lorentz shift is applied. More...

Bool_t	Noise () const
	Check whether inter-event noise is generated. More...

Bool_t	OnlyPrimaries () const
	Process only primary tracks. More...

virtual void	putParams (FairParamList *parList)
	Writing parameters to ASCII. Abstract in base class. More...

void	SetEventMode (Bool_t choice=kTRUE)
	Set event-by-event simulation mode. More...

void	SetGenerateNoise (Bool_t choice=kTRUE)
	Activate or de-activate inter-event noise. More...

void	SetOnlyPrimaries (Bool_t choice=kTRUE)
	Process only primary tracks. More...

void	SetProcesses (CbmStsELoss eLossModel, Bool_t useLorentzShift, Bool_t useDiffusion, Bool_t useCrossTalk)

std::string	ToString () const
	String output. More...

Private Member Functions
	ClassDef (CbmStsParSim, 1)

Private Attributes
Bool_t	fEventMode = kFALSE
	Event-by-event mode. More...

CbmStsELoss	fELossModel = CbmStsELoss::kUrban
	Energy loss model. More...

Bool_t	fLorentzShift = kTRUE
	Apply Lorentz shift. More...

Bool_t	fDiffusion = kTRUE
	Apply diffusion. More...

Bool_t	fCrossTalk = kTRUE
	Apply cross-talk. More...

Bool_t	fNoise = kTRUE
	Generate inter-event noise. More...

Bool_t	fOnlyPrimaries = kFALSE
	Process sonly primary tracks. More...

Detailed Description

Settings for STS simulation (digitizer)

Author: Volker Friese v.fri.nosp@m.ese@.nosp@m.gsi.d.nosp@m.e

Date: 02.04.2020

Definition at line 25 of file CbmStsParSim.h.

Constructor & Destructor Documentation

◆ CbmStsParSim()

CbmStsParSim::CbmStsParSim	(	const char *	name = `"CbmStsParSim"`,
		const char *	title = `"STS parameters"`,
		const char *	context = `"Default"`
	)

Constructor.

◆ ~CbmStsParSim()

virtual CbmStsParSim::~CbmStsParSim ( )

inlinevirtual

Destructor.

Definition at line 35 of file CbmStsParSim.h.

Member Function Documentation

◆ ClassDef()

CbmStsParSim::ClassDef	(	CbmStsParSim	,
		1
	)

private

◆ clear()

void CbmStsParSim::clear ( )

virtual

Reset all parameters.

Definition at line 24 of file CbmStsParSim.cxx.

◆ CrossTalk()

Bool_t CbmStsParSim::CrossTalk ( ) const

inline

Check whether cross-talk is applied.

Returns: If true, cross-talk between the readout channels is applied

Definition at line 45 of file CbmStsParSim.h.

References fCrossTalk.

Referenced by CbmStsSimSensorDssd::CalculateResponse(), and CbmStsDigitizeQaReport::Create().

◆ Diffusion()

Bool_t CbmStsParSim::Diffusion ( ) const

inline

Check whether diffusion is applied.

Returns: If true, diffusion in the sensors is applied

Definition at line 51 of file CbmStsParSim.h.

References fDiffusion.

Referenced by CbmStsDigitizeQaReport::Create(), CbmStsSimSensorDssdOrtho::PropagateCharge(), and CbmStsSimSensorDssdStereo::PropagateCharge().

◆ ELossModel()

CbmStsELoss CbmStsParSim::ELossModel ( ) const

inline

Energy loss model.

Returns: Energy loss model (see enum ECbmElossmModel)

Definition at line 57 of file CbmStsParSim.h.

References fELossModel.

Referenced by CbmStsDigitizeQaReport::Create(), and CbmStsSimSensorDssd::ProduceCharge().

◆ EventMode()

Bool_t CbmStsParSim::EventMode ( ) const

inline

Check whether event-by-event mode is applied.

Returns: If true, simulation will be / were done event-by-event

Definition at line 63 of file CbmStsParSim.h.

References fEventMode.

◆ getParams()

Bool_t CbmStsParSim::getParams ( FairParamList * parList )

virtual

Reading parameters from ASCII. Abstract in base class.

An ASCII I/O is not implemented. The method throws an error.

Definition at line 32 of file CbmStsParSim.cxx.

◆ LorentzShift()

Bool_t CbmStsParSim::LorentzShift ( ) const

inline

Check whether Lorentz shift is applied.

Returns: If true, Lorentz shift in the sensors is applied

Definition at line 76 of file CbmStsParSim.h.

References fLorentzShift.

Referenced by CbmStsDigitizeQaReport::Create(), CbmRecoSts::CreateModules(), CbmStsSimSensorDssdOrtho::PropagateCharge(), and CbmStsSimSensorDssdStereo::PropagateCharge().

◆ Noise()

Bool_t CbmStsParSim::Noise ( ) const

inline

Check whether inter-event noise is generated.

Returns: If true, noise will be / was generated

Definition at line 82 of file CbmStsParSim.h.

References fNoise.

Referenced by CbmStsDigitize::Exec().

◆ OnlyPrimaries()

Bool_t CbmStsParSim::OnlyPrimaries ( ) const

inline

Process only primary tracks.

Returns: If true, secondary tracks will be ignored

Definition at line 88 of file CbmStsParSim.h.

References fOnlyPrimaries.

Referenced by CbmStsDigitize::ProcessMCEvent().

◆ putParams()

void CbmStsParSim::putParams ( FairParamList * parList )

virtual

Writing parameters to ASCII. Abstract in base class.

An ASCII I/O is not implemented. The method throws an error.

Definition at line 40 of file CbmStsParSim.cxx.

◆ SetEventMode()

void CbmStsParSim::SetEventMode ( Bool_t choice = kTRUE )

inline

Set event-by-event simulation mode.

Parameters

choice If kTRUE, simulation will be performed event-by-event

By default, simulation are time-based. In event-by-event simulation, all analogue buffers will be processed and cleared after each event, such that there is no inteference of data from different events.

Definition at line 106 of file CbmStsParSim.h.

References fEventMode.

Referenced by CbmStsDigitize::InitParams(), and CbmStsDigitize::SetGlobalDefaults().

◆ SetGenerateNoise()

void CbmStsParSim::SetGenerateNoise ( Bool_t choice = kTRUE )

inline

Activate or de-activate inter-event noise.

Parameters

choice If kTRUE, inter-event noise will be generated

By default, noise is generated. This setting will have no effect for event-by-event simulation.

Definition at line 115 of file CbmStsParSim.h.

References fNoise.

Referenced by CbmStsDigitize::InitParams(), and CbmStsDigitize::SetGlobalDefaults().

◆ SetOnlyPrimaries()

void CbmStsParSim::SetOnlyPrimaries ( Bool_t choice = kTRUE )

inline

Process only primary tracks.

Parameters

choice If true, secondary tracks will be ignored

The option to process only primary tracks exists for detector studies. If set, the MC points from secondary tracks will be ignored.

Definition at line 125 of file CbmStsParSim.h.

References fOnlyPrimaries.

Referenced by CbmStsDigitize::UseOnlyPrimaries().

◆ SetProcesses()

void CbmStsParSim::SetProcesses	(	CbmStsELoss	eLossModel,
		Bool_t	useLorentzShift,
		Bool_t	useDiffusion,
		Bool_t	useCrossTalk
	)

inline

Set physics processes

Parameters

eLossModel	Energy loss model
useLorentzShift	If kTRUE, activate Lorentz shift
useDiffusion	If kTRUE, activate diffusion
useCrossTalk	If kTRUE, activate cross talk

Default is: all processes active; energy loss model is kELossUrban.

Definition at line 136 of file CbmStsParSim.h.

References fCrossTalk, fDiffusion, fELossModel, and fLorentzShift.

Referenced by CbmStsDigitize::SetGlobalDefaults(), and CbmStsDigitize::SetProcesses().

◆ ToString()

std::string CbmStsParSim::ToString ( ) const

String output.

Definition at line 47 of file CbmStsParSim.cxx.

References fCrossTalk, fDiffusion, fELossModel, fEventMode, fLorentzShift, fNoise, fOnlyPrimaries, kIdeal, kUniform, and kUrban.

Referenced by CbmRecoSts::Init(), and CbmStsDigitize::InitParams().

Member Data Documentation

◆ fCrossTalk

Bool_t CbmStsParSim::fCrossTalk = kTRUE

private

Apply cross-talk.

Definition at line 156 of file CbmStsParSim.h.

Referenced by CrossTalk(), SetProcesses(), and ToString().

◆ fDiffusion

Bool_t CbmStsParSim::fDiffusion = kTRUE

private

Apply diffusion.

Definition at line 155 of file CbmStsParSim.h.

Referenced by Diffusion(), SetProcesses(), and ToString().

◆ fELossModel

CbmStsELoss CbmStsParSim::fELossModel = CbmStsELoss::kUrban

private

Energy loss model.

Definition at line 153 of file CbmStsParSim.h.

Referenced by ELossModel(), SetProcesses(), and ToString().

◆ fEventMode

Bool_t CbmStsParSim::fEventMode = kFALSE

private

Event-by-event mode.

Definition at line 152 of file CbmStsParSim.h.

Referenced by EventMode(), SetEventMode(), and ToString().

◆ fLorentzShift

Bool_t CbmStsParSim::fLorentzShift = kTRUE

private

Apply Lorentz shift.

Definition at line 154 of file CbmStsParSim.h.

Referenced by LorentzShift(), SetProcesses(), and ToString().

◆ fNoise

Bool_t CbmStsParSim::fNoise = kTRUE

private

Generate inter-event noise.

Definition at line 157 of file CbmStsParSim.h.

Referenced by Noise(), SetGenerateNoise(), and ToString().

◆ fOnlyPrimaries

Bool_t CbmStsParSim::fOnlyPrimaries = kFALSE

private

Process sonly primary tracks.

Definition at line 158 of file CbmStsParSim.h.

Referenced by OnlyPrimaries(), SetOnlyPrimaries(), and ToString().

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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CbmStsParSim()

◆ ~CbmStsParSim()

Member Function Documentation

◆ ClassDef()

◆ clear()

◆ CrossTalk()

◆ Diffusion()

◆ ELossModel()

◆ EventMode()

◆ getParams()

◆ LorentzShift()

◆ Noise()

◆ OnlyPrimaries()

◆ putParams()

◆ SetEventMode()

◆ SetGenerateNoise()

◆ SetOnlyPrimaries()

◆ SetProcesses()

◆ ToString()

Member Data Documentation

◆ fCrossTalk

◆ fDiffusion

◆ fELossModel

◆ fEventMode

◆ fLorentzShift

◆ fNoise

◆ fOnlyPrimaries