SVDSignal Class Reference

The SVD signal class. More...

#include <SVDSignal.h>

Collaboration diagram for SVDSignal:

Classes
struct	Wave
	Type to store elementary waveforms. More...

Public Types
typedef std::deque< Wave >	function_list
	List of elementary waveforms.
typedef std::map< RelationElement::index_type, RelationElement::weight_type >	relations_map
	Type to store contributions to strip signal by different particles on output of SVDSignal.
typedef std::map< RelationElement::index_type, RelationElement::weight_type >::value_type	relation_value_type
	Type of relation_map elements.

Public Member Functions
	SVDSignal ()
	Default constructor.
	SVDSignal (const SVDSignal &other)
	Copy ctor.
bool	isNoise () const
	Check whether this is a noise signal. More...
void	add (double initTime, double charge, double tau, int particle=-1, int truehit=-1)
	Add a chargelet to the strip signal. More...
SVDSignal &	operator= (const SVDSignal &other)
	Make the SVDSignal assignable. More...
double	waveform (double t, double initTime, double charge, double tau, waveFunction wfun=w_betaprime) const
	Waveform shape. More...
double	waveform (double t, const Wave &wave) const
	Waveform taking parameters from a Wave struct. More...
double	operator() (double t) const
	Make SVDSignal a functor. More...
double	getCharge () const
	Return the charge collected in the strip. More...
const function_list &	getFunctions () const
	Return the list of waveform parameters. More...
const relations_map &	getMCParticleRelations () const
	Return the list of MCParticle relations. More...
const relations_map &	getTrueHitRelations () const
	Return the list of TrueHit relations. More...
std::string	toString () const
	Produce a string representation of the object.

Protected Attributes
double	m_charge
	charge of the pixel
function_list	m_functions
	list of elementary waveform parameters.
relations_map	m_particles
	Map of MCParticle associations.
relations_map	m_truehits
	Map of TrueHit associations.

Detailed Description

The SVD signal class.

The class implements the waveform appearing on an SVD strip as a result of ionization by particles passing through the detector. The class accumulates elementary waveforms formed by chargelets contributing to the charge accumulated on the strip. The elementary waveforms are currently of the form w(t|delta,tau) = charge * (t-delta)/tau * exp(1.0 - (t-delta)/tau)) for t >= delta, otherwise 0. with delta being the initial time, and tau the decay time. Maximum is attained at delta + tau and is equal to charge. The class is a functor returning values of summary waveform at a given time. Poisson and gaussian noises will be added externally.

Definition at line 52 of file SVDSignal.h.

Member Function Documentation

add()

void add ( double  initTime, double  charge, double  tau, int  particle = -1, int  truehit = -1  )

inline

Add a chargelet to the strip signal.

Negative sign of charge has a special meaning, it designates noise signal carrying otherwise no useful information.

Parameters

charge	Charge in electrons to be added
initTime	Time of arrival of the chargelet to the sensitive surface of the sensor.
tau	Characteristic time of waveform decay.
particle	Index of the particle contributing the charge, -1 for no particle/noise
truehit	Index of the truehit corresponding to the particle that contributed the charge.

Definition at line 123 of file SVDSignal.h.

      {
        m_charge = other.getCharge();

getCharge()

double getCharge ( ) const

inline

Return the charge collected in the strip.

Returns

Total charge of the waveform.

Definition at line 186 of file SVDSignal.h.

getFunctions()

const function_list& getFunctions ( ) const

inline

Return the list of waveform parameters.

Returns

The deque containing SVDSignal::Wave structs with waveform parameters.

Definition at line 191 of file SVDSignal.h.

getMCParticleRelations()

const relations_map& getMCParticleRelations ( ) const

inline

Return the list of MCParticle relations.

Returns

SVDSignal::relations_map with MCParticle relations of the signal.

Definition at line 196 of file SVDSignal.h.

getTrueHitRelations()

const relations_map& getTrueHitRelations ( ) const

inline

Return the list of TrueHit relations.

Returns

SVDSignal::relations_map with TrueHit relations of the signal.

Definition at line 201 of file SVDSignal.h.

isNoise()

bool isNoise ( ) const

inline

Check whether this is a noise signal.

If charge is negative, there is no useful information in the signal.

Returns

True if noise signal.

Definition at line 111 of file SVDSignal.h.

operator()()

double operator() ( double  t ) const

inline

Make SVDSignal a functor.

Parameters

t	The time at which output is to be calculated.

Returns

value of the waveform

Definition at line 174 of file SVDSignal.h.

operator=()

SVDSignal& operator= ( const SVDSignal &  other )

inline

Make the SVDSignal assignable.

Parameters

other

The original signal.

Returns

This signal with all quantities set to those of the other.

Definition at line 138 of file SVDSignal.h.

waveform() [1/2]

double waveform ( double  t, const Wave &  wave  ) const

inline

Waveform taking parameters from a Wave struct.

Parameters

t	The time at which the function is to be calculated.
wave	The SVDSignal::Wave struct with parameters of a waveform.

Returns

THe value of the waveform at time time.

Definition at line 167 of file SVDSignal.h.

waveform() [2/2]

double waveform ( double  t, double  initTime, double  charge, double  tau, waveFunction  wfun = w_betaprime  ) const

inline

Waveform shape.

Parameters

t	The time at which the function is to be calculated.
initTime	The initial time of the waveform.
charge	The charge (peak value) of the waveform.
tau	The scale parameter (decay time) of the waveform.
wfun	The functional form of the waveform. Default is betaprime. The function is normalized to peak value of 1.

Returns

Value of the waveform at t.

Definition at line 155 of file SVDSignal.h.

---

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

• svd/simulation/include/SVDSignal.h