Belle II Software development
NoiseMap Class Reference

Base Class to represent pixel dependent Noise Map. More...

#include <NoiseMap.h>

Public Member Functions

 NoiseMap ()
 Constructor

 
virtual ~NoiseMap ()
 Destructor.
 
void setNoiseLevel (float noise)
 Set the noise level.
 
virtual void setSensorID (VxdID)
 Set the sensorID currently used.
 
float getSignificance (const Pixel &px) const
 Return the significance of a signal, that is signal divided by noise level.
 
virtual float getNoise (const Pixel &) const
 Return the noise value for a given pixel.
 
bool operator() (const Pixel &px, float significance) const
 Check wether a signal exceeds a given significance.
 
bool operator() (float signal, float significance) const
 Check wether a signal exceeds a given significance using the average noise level.
 

Protected Attributes

float m_noiseLevel
 Noise level.
 

Detailed Description

Base Class to represent pixel dependent Noise Map.

Currently there is no area dependence implemented.

Definition at line 25 of file NoiseMap.h.

Constructor & Destructor Documentation

◆ NoiseMap()

NoiseMap ( )
inline

Constructor

Definition at line 28 of file NoiseMap.h.

28: m_noiseLevel(0) {}
float m_noiseLevel
Noise level.
Definition: NoiseMap.h:60

◆ ~NoiseMap()

virtual ~NoiseMap ( )
inlinevirtual

Destructor.

Definition at line 30 of file NoiseMap.h.

30{}

Member Function Documentation

◆ getNoise()

virtual float getNoise ( const Pixel ) const
inlinevirtual

Return the noise value for a given pixel.

Definition at line 44 of file NoiseMap.h.

44{ return m_noiseLevel; }

◆ getSignificance()

float getSignificance ( const Pixel px) const
inline

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

Definition at line 41 of file NoiseMap.h.

41{ return px.getCharge() / getNoise(px); }
virtual float getNoise(const Pixel &) const
Return the noise value for a given pixel.
Definition: NoiseMap.h:44

◆ operator()() [1/2]

bool operator() ( const Pixel px,
float  significance 
) const
inline

Check wether a signal exceeds a given significance.

Parameters
pxpixel to check
significanceminimum significance

Definition at line 50 of file NoiseMap.h.

50{ return getSignificance(px) >= significance; }
float getSignificance(const Pixel &px) const
Return the significance of a signal, that is signal divided by noise level.
Definition: NoiseMap.h:41

◆ operator()() [2/2]

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

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

Parameters
signalsignal to check
significanceminimum significance

Definition at line 56 of file NoiseMap.h.

56{ return signal / m_noiseLevel >= significance; }

◆ setNoiseLevel()

void setNoiseLevel ( float  noise)
inline

Set the noise level.

Definition at line 33 of file NoiseMap.h.

33{ m_noiseLevel = noise; }

◆ setSensorID()

virtual void setSensorID ( VxdID  )
inlinevirtual

Set the sensorID currently used.

Should be utilised later or in derived classes to obtain the correct noiseMap.

Definition at line 38 of file NoiseMap.h.

38{}

Member Data Documentation

◆ m_noiseLevel

float m_noiseLevel
protected

Noise level.

Definition at line 60 of file NoiseMap.h.


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