Class for the simulation of a sensor in the CBM-STS. More...

#include <CbmStsSimSensor.h>

Inheritance diagram for CbmStsSimSensor:

Collaboration diagram for CbmStsSimSensor:

Public Member Functions
	CbmStsSimSensor (CbmStsElement *element=nullptr)
	Standard constructor.

	CbmStsSimSensor (const CbmStsSimSensor &)=delete
	Copy constructor (disabled)

CbmStsSimSensor &	operator= (const CbmStsSimSensor &)=delete
	Assignment operator (disabled)

virtual	~CbmStsSimSensor ()
	Destructor

const CbmStsParSensorCond *	GetConditions () const
	Sensor conditions.

const CbmLink &	GetCurrentLink () const
	Current link object.

CbmStsElement *	GetElement () const
	Corresponding element in STS setup.

CbmStsSimModule *	GetModule () const
	Simulation module.

virtual Bool_t	Init ()
	Initialise the sensor, if needed.

Int_t	GetSensorId () const
	Sensor ID.

Int_t	ProcessPoint (const CbmStsPoint *point, Double_t eventTime, const CbmLink &link)
	Process one MC Point.

void	SetConditions (const CbmStsParSensorCond *conditions)

void	SetElement (CbmStsElement *element)
	Set the corresponding STS setup element.

void	SetField (Double_t bX, Double_t bY, Double_t bZ)
	Set the magnetic field in the sensor centre.

void	SetModule (CbmStsSimModule *module)
	Set the corresponding simulation module.

void	SetSimSettings (const CbmStsParSim *settings)
	Set the simulation settings.

virtual std::string	ToString () const =0
	Set the sensor parameters.

Static Public Member Functions
static UInt_t	GetAddressFromName (TString name)
	Get the address from the sensor name (static)

Protected Member Functions
virtual Int_t	CalculateResponse (CbmStsSensorPoint *point)=0
	Link to currently processed MCPoint.

	ClassDef (CbmStsSimSensor, 1)

Protected Attributes
CbmStsElement *	fElement = nullptr

CbmStsSimModule *	fModule = nullptr
	Setup element.

const CbmStsParSim *	fSettings = nullptr
	Simulation module.

const CbmStsParSensorCond *	fConditions = nullptr
	Simulation settings.

Double_t	fBx = 0.
	Operating conditions.

Double_t	fBy = 0.
	y component of magnetic field in sensor centre

Double_t	fBz = 0.
	z component of magnetic field in sensor centre

CbmLink	fCurrentLink = {}

Detailed Description

Class for the simulation of a sensor in the CBM-STS.

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

Since: 16.03.2020

The interface to the simulation is the method ProcessPoint(), which performs the coordinate transformation from the global system to the sensor system, having the sensor midpoint as origin. The analog response has to be implemented in the pure virtual method CalulateResponse().

Definition at line 38 of file CbmStsSimSensor.h.

Constructor & Destructor Documentation

◆ CbmStsSimSensor() [1/2]

CbmStsSimSensor::CbmStsSimSensor ( CbmStsElement * element = nullptr )

Standard constructor.

Parameters

setupSensor Pointer to sensor element in CbmStsSetup

◆ CbmStsSimSensor() [2/2]

CbmStsSimSensor::CbmStsSimSensor ( const CbmStsSimSensor & )

delete

Copy constructor (disabled)

◆ ~CbmStsSimSensor()

virtual CbmStsSimSensor::~CbmStsSimSensor ( )

inlinevirtual

Destructor

Definition at line 56 of file CbmStsSimSensor.h.

Member Function Documentation

◆ CalculateResponse()

virtual Int_t CbmStsSimSensor::CalculateResponse ( CbmStsSensorPoint * point )

protectedpure virtual

Link to currently processed MCPoint.

Perform response simulation for one MC Point

Parameters

point Pointer to CbmStsSensorPoint with relevant parameters

Returns: Status variable, depends on concrete type

Perform the appropriate action for a particle trajectory in the sensor characterised by the CbmStsSensorPoint object. This is specific to the sensor type and has to be implemented in the derived class.

Implemented in CbmStsSimSensorDssd.

Referenced by ProcessPoint().

◆ ClassDef()

CbmStsSimSensor::ClassDef	(	CbmStsSimSensor	,
		1	)

protected

◆ GetAddressFromName()

UInt_t CbmStsSimSensor::GetAddressFromName ( TString name )

static

Get the address from the sensor name (static)

Parameters

name	Name of sensor @value Unique element address

Definition at line 37 of file CbmStsSimSensor.cxx.

References CbmStsAddress::GetAddress().

◆ GetConditions()

const CbmStsParSensorCond * CbmStsSimSensor::GetConditions ( ) const

inline

Sensor conditions.

Returns: Sensor condition object

Definition at line 69 of file CbmStsSimSensor.h.

References fConditions.

Referenced by CbmStsSimSensorDssd::CalculateResponse(), CbmStsSimSensorDssd::LorentzShift(), CbmStsSimSensorDssdOrtho::PropagateCharge(), and CbmStsSimSensorDssdStereo::PropagateCharge().

◆ GetCurrentLink()

const CbmLink & CbmStsSimSensor::GetCurrentLink ( ) const

inline

Current link object.

Returns: Current link object (to CbmStsPoint)

Definition at line 75 of file CbmStsSimSensor.h.

References fCurrentLink.

Referenced by CbmStsSimSensorDssd::RegisterCharge().

◆ GetElement()

CbmStsElement * CbmStsSimSensor::GetElement ( ) const

inline

Corresponding element in STS setup.

Returns: Sensor element

Definition at line 81 of file CbmStsSimSensor.h.

References fElement.

◆ GetModule()

CbmStsSimModule * CbmStsSimSensor::GetModule ( ) const

inline

Simulation module.

Returns: Corresponding simulation module

Definition at line 87 of file CbmStsSimSensor.h.

References fModule.

Referenced by CbmStsSimSensorDssd::CalculateResponse(), and CbmStsSimSensorDssd::RegisterCharge().

◆ GetSensorId()

Int_t CbmStsSimSensor::GetSensorId ( ) const

Sensor ID.

Returns: Sensor number with module

Definition at line 52 of file CbmStsSimSensor.cxx.

References fElement, CbmStsElement::GetAddress(), CbmStsAddress::GetElementId(), and kStsSensor.

Referenced by CbmStsSimSensorDssdOrtho::Init(), CbmStsSimSensorDssd::RegisterCharge(), and CbmStsSimSensorDssdOrtho::SetParameters().

◆ Init()

virtual Bool_t CbmStsSimSensor::Init ( )

inlinevirtual

Initialise the sensor, if needed.

Returns: kTRUE is successfully initialised

The implementation depends on the concrete sensor class.

Reimplemented in CbmStsSimSensorDssdOrtho, and CbmStsSimSensorDssdStereo.

Definition at line 95 of file CbmStsSimSensor.h.

◆ operator=()

CbmStsSimSensor & CbmStsSimSensor::operator= ( const CbmStsSimSensor & )

delete

Assignment operator (disabled)

◆ ProcessPoint()

Int_t CbmStsSimSensor::ProcessPoint	(	const CbmStsPoint *	point,
		Double_t	eventTime,
		const CbmLink &	link )

Process one MC Point.

Parameters

point Pointer to CbmStsPoint object

Returns: Status variable, depends on sensor type

The point coordinates are converted into the internal coordinate system. The appropriate analogue response is then calculated with the pure virtual method CalculateResponse.

Definition at line 61 of file CbmStsSimSensor.cxx.

References CalculateResponse(), fCurrentLink, fElement, CbmStsPoint::GetPid(), CbmStsElement::GetPnode(), CbmStsPoint::GetPxOut(), CbmStsPoint::GetPyOut(), CbmStsPoint::GetPzOut(), CbmStsPoint::GetXIn(), CbmStsPoint::GetXOut(), CbmStsPoint::GetYIn(), CbmStsPoint::GetYOut(), CbmStsPoint::GetZIn(), CbmStsPoint::GetZOut(), and CbmStsPoint::IsEntry().

◆ SetConditions()

void CbmStsSimSensor::SetConditions ( const CbmStsParSensorCond * conditions )

inline

Set the sensor conditions

Parameters

conditions Pointer to conditions parameters

Definition at line 118 of file CbmStsSimSensor.h.

References fConditions.

◆ SetElement()

void CbmStsSimSensor::SetElement ( CbmStsElement * element )

inline

Set the corresponding STS setup element.

Parameters

Pointer to setup element

Definition at line 124 of file CbmStsSimSensor.h.

References fElement.

◆ SetField()

void CbmStsSimSensor::SetField	(	Double_t	bX,
		Double_t	bY,
		Double_t	bZ )

inline

Set the magnetic field in the sensor centre.

Parameters

bX	x component of magnetic field [T]
bY	y component of magnetic field [T]
bZ	z component of magnetic field [T]

The magnetic field is neede for the calculation of the Lorentz shift of charge carries in the sensor. The field is approximated to be constant.

Definition at line 136 of file CbmStsSimSensor.h.

References fBx, fBy, and fBz.

◆ SetModule()

void CbmStsSimSensor::SetModule ( CbmStsSimModule * module )

inline

Set the corresponding simulation module.

Parameters

module Pointer to module

Definition at line 147 of file CbmStsSimSensor.h.

References fModule.

◆ SetSimSettings()

void CbmStsSimSensor::SetSimSettings ( const CbmStsParSim * settings )

inline

Set the simulation settings.

Parameters

Simulation setting parameteres

Definition at line 153 of file CbmStsSimSensor.h.

References fSettings.

◆ ToString()

virtual std::string CbmStsSimSensor::ToString ( ) const

pure virtual

Set the sensor parameters.

Parameters

par	Sensor parameter object

String output

Implemented in CbmStsSimSensorDssd, CbmStsSimSensorDssdOrtho, and CbmStsSimSensorDssdStereo.

Member Data Documentation

◆ fBx

Double_t CbmStsSimSensor::fBx = 0.

protected

Operating conditions.

x component of magnetic field in sensor centre

Definition at line 174 of file CbmStsSimSensor.h.

Referenced by SetField().

◆ fBy

Double_t CbmStsSimSensor::fBy = 0.

protected

y component of magnetic field in sensor centre

Definition at line 175 of file CbmStsSimSensor.h.

Referenced by SetField().

◆ fBz

Double_t CbmStsSimSensor::fBz = 0.

protected

z component of magnetic field in sensor centre

Definition at line 176 of file CbmStsSimSensor.h.

Referenced by SetField().

◆ fConditions

const CbmStsParSensorCond* CbmStsSimSensor::fConditions = nullptr

protected

Simulation settings.

Definition at line 173 of file CbmStsSimSensor.h.

Referenced by GetConditions(), SetConditions(), and CbmStsSimSensorDssdStereo::ToString().

◆ fCurrentLink

CbmLink CbmStsSimSensor::fCurrentLink = {}

protected

Definition at line 177 of file CbmStsSimSensor.h.

Referenced by GetCurrentLink(), and ProcessPoint().

◆ fElement

CbmStsElement* CbmStsSimSensor::fElement = nullptr

protected

Definition at line 169 of file CbmStsSimSensor.h.

Referenced by GetElement(), GetSensorId(), CbmStsSimSensorDssdOrtho::Init(), CbmStsSimSensorDssdStereo::Init(), ProcessPoint(), SetElement(), CbmStsSimSensorDssdOrtho::SetParameters(), CbmStsSimSensorDssdOrtho::ToString(), and CbmStsSimSensorDssdStereo::ToString().

◆ fModule

CbmStsSimModule* CbmStsSimSensor::fModule = nullptr

protected

Setup element.

Definition at line 170 of file CbmStsSimSensor.h.

Referenced by GetModule(), and SetModule().

◆ fSettings

const CbmStsParSim* CbmStsSimSensor::fSettings = nullptr

protected

Simulation module.

Definition at line 171 of file CbmStsSimSensor.h.

Referenced by CbmStsSimSensorDssd::CalculateResponse(), CbmStsSimSensorDssd::ProduceCharge(), CbmStsSimSensorDssdOrtho::PropagateCharge(), CbmStsSimSensorDssdStereo::PropagateCharge(), and SetSimSettings().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CbmStsSimSensor() [1/2]

◆ CbmStsSimSensor() [2/2]

◆ ~CbmStsSimSensor()

Member Function Documentation

◆ CalculateResponse()

◆ ClassDef()

◆ GetAddressFromName()

◆ GetConditions()

◆ GetCurrentLink()

◆ GetElement()

◆ GetModule()

◆ GetSensorId()

◆ Init()

◆ operator=()

◆ ProcessPoint()

◆ SetConditions()

◆ SetElement()

◆ SetField()

◆ SetModule()

◆ SetSimSettings()

◆ ToString()

Member Data Documentation

◆ fBx

◆ fBy

◆ fBz

◆ fConditions

◆ fCurrentLink

◆ fElement

◆ fModule

◆ fSettings