Belle II Software  release-08-01-10
NoiseMap Class Reference

Base Class to represent strip-dependent noise map. More...

#include <NoiseMap.h>

Collaboration diagram for NoiseMap:

Public Member Functions

 NoiseMap ()
 Constructor

 
virtual ~NoiseMap ()
 Destructor.
 
void setADU (double eInADU)
 Set charge per ADC unit. More...
 
void setNoiseLevel (float noise)
 Override the noise level.
 
virtual void setSensorID (VxdID sensorID, bool side)
 Set the sensorID currently used.
 
float getSignificance (const Sample &sample) const
 Return the sigma-significance of a signal, that is, signal divided by noise level. More...
 
virtual float getNoise (short) const
 Return the noise level for a given strip. More...
 
virtual float getNoise (const Sample &) const
 Return the noise value for a given strip. More...
 
bool operator() (const Sample &sample, float significance) const
 Check whether a signal exceeds a given significance. More...
 
bool operator() (float signal, float significance) const
 Check whether a signal exceeds a given significance using the average noise level. More...
 

Protected Attributes

double m_eInADU
 Charge corresponding to 1 ADU.
 
VxdID m_sensorID
 VxdID of the current sensor.
 
bool m_isU
 Side of current sensor.
 
float m_noiseLevel
 Noise level in strips.
 

Detailed Description

Base Class to represent strip-dependent noise map.

Currently there is only sensor and side dependence implemented.

Definition at line 29 of file NoiseMap.h.

Member Function Documentation

◆ getNoise() [1/2]

virtual float getNoise ( const Sample &  ) const
inlinevirtual

Return the noise value for a given strip.

Parameters
(notused) Sample at whose position we want noise level
Returns
noise level for the Sample's strip

Definition at line 74 of file NoiseMap.h.

74 { return m_noiseLevel; }
float m_noiseLevel
Noise level in strips.
Definition: NoiseMap.h:98

◆ getNoise() [2/2]

virtual float getNoise ( short  ) const
inlinevirtual

Return the noise level for a given strip.

Parameters
(notused) number of the strip
Returns
noise level

Definition at line 68 of file NoiseMap.h.

◆ getSignificance()

float getSignificance ( const Sample &  sample) const
inline

Return the sigma-significance of a signal, that is, signal divided by noise level.

Parameters
sampleSample of a strip.
Returns
The ratio of maximum strip signal and noise level.

Definition at line 63 of file NoiseMap.h.

◆ operator()() [1/2]

bool operator() ( const Sample &  sample,
float  significance 
) const
inline

Check whether a signal exceeds a given significance.

Parameters
samplestrip to check
significanceminimum significance @true if the maximum signal of the strip exceeds the given significance.

Definition at line 81 of file NoiseMap.h.

◆ operator()() [2/2]

bool operator() ( float  signal,
float  significance 
) const
inline

Check whether a signal exceeds a given significance using the average noise level.

Parameters
signalsignal to check
significanceminimum significance

Definition at line 88 of file NoiseMap.h.

◆ setADU()

void setADU ( double  eInADU)
inline

Set charge per ADC unit.

If signals are in ADC units, the default setting of 1 should be overriden.

Parameters
eInADUcharge in electrons corresponding to 1 ADU.

Definition at line 42 of file NoiseMap.h.


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