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

pixel detector common mode background calculation More...

#include <pixel_detector_calibration.h>

+ Inheritance diagram for cass::pp333:
+ Collaboration diagram for cass::pp333:

Public Member Functions

 pp333 (const name_t &)
 constructor. More...
 
virtual void process (const CASSEvent &, result_t &)
 overwrite default behaviour don't do anything More...
 
virtual void loadSettings (size_t)
 load the settings of this pp More...
 
- Public Member Functions inherited from cass::Processor
 Processor (const name_t &name)
 constructor More...
 
virtual ~Processor ()
 virtual destructor More...
 
virtual void processEvent (const CASSEvent &event)
 process the event More...
 
virtual const result_tresult (const CASSEvent::id_t eventid=0)
 retrieve a result for a given id. More...
 
virtual void releaseEvent (const CASSEvent &event)
 tell the list that the result for event can be overwritten More...
 
result_t::shared_pointer resultCopy (const uint64_t eventid)
 retrieve histogram for id More...
 
virtual void load ()
 load the general settings More...
 
virtual void aboutToQuit ()
 function that will be called when the processor is about to be deleted More...
 
const names_tdependencies ()
 Define all processors keys a processor depends on. More...
 
void clearDependencies ()
 clear the dependenies More...
 
void clearHistograms ()
 clear the histograms More...
 
virtual void processCommand (std::string command)
 process command in pp More...
 
const name_t name () const
 retrieve the name of this processor More...
 
bool hide () const
 retrieve the hide flag of this processor More...
 
const std::string & comment () const
 retrieve the comment of this processor More...
 

Protected Member Functions

float meanCalc (result_t::const_iterator begin, result_t::const_iterator end)
 function to calulate the common mode level as mean value More...
 
float medianCalc (result_t::const_iterator begin, result_t::const_iterator end)
 function to calulate the common mode level via the median value More...
 
- Protected Member Functions inherited from cass::Processor
virtual void createHistList (result_t::shared_pointer result)
 create result list. More...
 
void setupGeneral ()
 general setup of the processor More...
 
bool setupCondition (bool defaultConditionType=true)
 setup the condition. More...
 
shared_pointer setupDependency (const std::string &depVarName, const name_t &name="")
 setup the dependecy. More...
 

Private Attributes

shared_pointer _image
 the image to create the hotpixel map from More...
 
size_t _width
 the number of times a pixel is high before masking it as hot pixel More...
 
float _snr
 the signal to noise ratio in case one uses the mean calculator More...
 
std::tr1::function< float(result_t::const_iterator, result_t::const_iterator)> _calcCommonmode
 the function that calculates the commond mode level More...
 

Additional Inherited Members

- Public Types inherited from cass::Processor
typedef std::tr1::shared_ptr< Processorshared_pointer
 a shared pointer of this More...
 
typedef std::string name_t
 define the name type More...
 
typedef std::list< name_tnames_t
 define the list of names More...
 
typedef CachedList::item_type result_t
 define the results More...
 
typedef CachedList::item_sp resultsp_t
 define the shared pointer to the result More...
 
- Protected Attributes inherited from cass::Processor
const name_t _name
 the processors name More...
 
bool _hide
 flag to tell whether this pp should be hidden in the dropdown list More...
 
std::string _comment
 optional comment that one can add to a processor. More...
 
CachedList _resultList
 the list of results More...
 
names_t _dependencies
 the list of dependencies More...
 
shared_pointer _condition
 pointer to the processor that will contain the condition More...
 

Detailed Description

pixel detector common mode background calculation

Available PostProcessors:
"333": pixel detector common mode background calculation
See also
Processor for a list of all commonly available cass.ini settings.
User definable Parameters:

Processor/%name%/{Image}
the image of the pixel detector

Processor/%name%/{Width}
The width of the subpart of the detector for which the common mode level needs to be calculated.

Processor/%name%/{CalculationType}
The type of calculation used to calculate the common mode level. Default is "mean". Possible values are:

  • "mean": Iterative retrieval of the mean value of distribution of pixels. In each iteration the outliers of the distribution are remove from the distribution.
  • "median": Calculates the mean of the distribution of pixels.

Processor/%name%/{SNR}
In case of using the mean calculator the signal to noise ratio is indicating which values to remove from the distribution before recalculating the mean. Default is 4

Author
Lutz Foucar

Definition at line 568 of file pixel_detector_calibration.h.

Constructor & Destructor Documentation

pp333::pp333 ( const name_t name)

constructor.

Definition at line 818 of file pixel_detector_calibration.cpp.

References loadSettings().

Member Function Documentation

void pp333::loadSettings ( size_t  )
virtual
float pp333::meanCalc ( result_t::const_iterator  begin,
result_t::const_iterator  end 
)
protected

function to calulate the common mode level as mean value

Returns
the commonmode level
Parameters
beginiterator to the beginning of the distribution
enditerator to the end of the distribution

Definition at line 855 of file pixel_detector_calibration.cpp.

References _snr, cass::CummulativeStatisticsNoOutlier< Type >::addDistribution(), and cass::CummulativeStatisticsNoOutlier< Type >::mean().

Referenced by loadSettings().

float pp333::medianCalc ( result_t::const_iterator  begin,
result_t::const_iterator  end 
)
protected

function to calulate the common mode level via the median value

Returns
the commonmode level
Parameters
beginiterator to the beginning of the distribution
enditerator to the end of the distribution

Definition at line 863 of file pixel_detector_calibration.cpp.

References cass::MedianCalculator< Type >::addDistribution(), and cass::MedianCalculator< Type >::median().

Referenced by loadSettings().

void pp333::process ( const CASSEvent evt,
result_t result 
)
virtual

overwrite default behaviour don't do anything

retrieve iterators to the storages and the size of the image

go though all common mode parts of image

calculate the common mode for the part

fill the result part with the calculated common mode

Reimplemented from cass::Processor.

Definition at line 871 of file pixel_detector_calibration.cpp.

References _calcCommonmode, _image, _width, cass::Result< T >::begin(), cass::CASSEvent::id(), cass::Result< T >::lock, and cass::Result< T >::shape().

Member Data Documentation

std::tr1::function<float(result_t::const_iterator, result_t::const_iterator)> cass::pp333::_calcCommonmode
private

the function that calculates the commond mode level

Definition at line 610 of file pixel_detector_calibration.h.

Referenced by loadSettings(), and process().

shared_pointer cass::pp333::_image
private

the image to create the hotpixel map from

Definition at line 600 of file pixel_detector_calibration.h.

Referenced by loadSettings(), and process().

float cass::pp333::_snr
private

the signal to noise ratio in case one uses the mean calculator

Definition at line 606 of file pixel_detector_calibration.h.

Referenced by loadSettings(), and meanCalc().

size_t cass::pp333::_width
private

the number of times a pixel is high before masking it as hot pixel

Definition at line 603 of file pixel_detector_calibration.h.

Referenced by loadSettings(), and process().


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