CFEL - ASG Software Suite  2.5.0
CASS
Public Member Functions | Private Attributes | List of all members
cass::pixeldetector::commonmode::MeanCalculator Class Reference

Calculate the common mode by taking mean of pixel values. More...

#include <commonmode_calculators.h>

+ Inheritance diagram for cass::pixeldetector::commonmode::MeanCalculator:
+ Collaboration diagram for cass::pixeldetector::commonmode::MeanCalculator:

Public Member Functions

 MeanCalculator ()
 constructor More...
 
Detector::pixel_t operator() (Detector::frame_t::const_iterator pixel, size_t idx) const
 the operation More...
 
void loadSettings (CASSSettings &s)
 load the settings of this calculator More...
 
- Public Member Functions inherited from cass::pixeldetector::commonmode::CalculatorBase
virtual ~CalculatorBase ()
 virtual destructor More...
 
void load (CASSSettings &s)
 load all common settings More...
 
size_t width () const
 retrieve the number of pixels (or the width of calculation More...
 

Private Attributes

size_t _nbrMaximumElementsToRemove
 number of maximum elements to remove More...
 
size_t _nbrMinimumElementsToRemove
 number of minimum elements to remove More...
 
int _minNbrPixels
 mininmal number of pixels that should be present when calculating the mean More...
 

Additional Inherited Members

- Public Types inherited from cass::pixeldetector::commonmode::CalculatorBase
typedef std::tr1::shared_ptr< CalculatorBaseshared_pointer
 typedef the shared pointer of this More...
 
- Static Public Member Functions inherited from cass::pixeldetector::commonmode::CalculatorBase
static shared_pointer instance (const std::string &type)
 create an instance of the requested functor More...
 
- Protected Attributes inherited from cass::pixeldetector::commonmode::CalculatorBase
std::tr1::shared_ptr< CommonData_commondata
 the commonly used data container More...
 
size_t _nbrPixels
 how many pixels should be used for calculating the common mode More...
 
float _multiplier
 the multiplier to identify pixels that contain information More...
 

Detailed Description

Calculate the common mode by taking mean of pixel values.

This functor calculates the mean value of the pixels. To create the list of pixels it will check whether the pixel might contain an event such as an photon. If so it will not be included in the mean. There must be a minimum number of pixels without an event before the common mode is calculated.

The user has the option to not include a number of highest and lowest pixel values when calculating the mean. This helps to get rid of possible extremes.

User definable Parameters:

PixelDetectors/%name%/HLLProcessing/MeanCommonMode/{NbrMinDisregardedValues}
The number of lowest values that should be disreagarded when calculating the mean value. Default is 5.

PixelDetectors/%name%/HLLProcessing/MeanCommonMode/{NbrMaxDisregardedValues}
The number of highest values that should be disreagarded when calculating the mean value. Default is 0.

PixelDetectors/%name%/HLLProcessing/MeanCommonMode/{MinNbrPixels}
The minimal number of Pixels that should be found in the range before the common mode value will be calculated. Default is 8

Author
Lutz Foucar

Definition at line 92 of file commonmode_calculators.h.

Constructor & Destructor Documentation

cass::pixeldetector::commonmode::MeanCalculator::MeanCalculator ( )
inline

constructor

Definition at line 96 of file commonmode_calculators.h.

Member Function Documentation

void MeanCalculator::loadSettings ( CASSSettings s)
virtual

load the settings of this calculator

Parameters
sthe CASSSettings object to read the information from

Implements cass::pixeldetector::commonmode::CalculatorBase.

Definition at line 142 of file commonmode_calculators.cpp.

References QSettings::beginGroup(), QSettings::endGroup(), and QSettings::value().

Detector::pixel_t MeanCalculator::operator() ( Detector::frame_t::const_iterator  pixel,
size_t  idx 
) const
virtual

the operation

determine the common mode level and return it.

Returns
the common mode level
Parameters
pixelthe start pixel within the frame to start the common mode calculation
idxindex of the first pixel.

Implements cass::pixeldetector::commonmode::CalculatorBase.

Definition at line 114 of file commonmode_calculators.cpp.

References cass::pixeldetector::commonmode::createPixelList().

Member Data Documentation

int cass::pixeldetector::commonmode::MeanCalculator::_minNbrPixels
private

mininmal number of pixels that should be present when calculating the mean

Definition at line 123 of file commonmode_calculators.h.

size_t cass::pixeldetector::commonmode::MeanCalculator::_nbrMaximumElementsToRemove
private

number of maximum elements to remove

Definition at line 117 of file commonmode_calculators.h.

size_t cass::pixeldetector::commonmode::MeanCalculator::_nbrMinimumElementsToRemove
private

number of minimum elements to remove

Definition at line 120 of file commonmode_calculators.h.


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