pixel detector gain calibrations More...

#include <pixel_detector_calibration.h>

Inheritance diagram for cass::pp331:

Collaboration diagram for cass::pp331:

Public Member Functions
	pp331 (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...

virtual void	aboutToQuit ()
	write the calibrations before quitting More...

virtual void	processCommand (std::string command)
	receive commands from the gui More...

Public Member Functions inherited from cass::AccumulatingProcessor
	AccumulatingProcessor (const name_t &name)
	constructor More...

virtual	~AccumulatingProcessor ()
	virtual destructor More...

virtual void	processEvent (const CASSEvent &evt)
	process the event More...

virtual const result_t &	result (const CASSEvent::id_t)
	retrieve a result. More...

virtual void	releaseEvent (const CASSEvent &)
	overwrite default behaviour to do nothing More...

virtual void	createHistList (result_t::shared_pointer result)
	create the list of results More...

Public Member Functions inherited from cass::Processor
	Processor (const name_t &name)
	constructor More...

virtual	~Processor ()
	virtual destructor More...

result_t::shared_pointer	resultCopy (const uint64_t eventid)
	retrieve histogram for id More...

virtual void	load ()
	load the general settings More...

const names_t &	dependencies ()
	Define all processors keys a processor depends on. More...

void	clearDependencies ()
	clear the dependenies More...

void	clearHistograms ()
	clear the histograms 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
void	loadCalibration ()
	write the calibration data to file More...

void	writeCalibration ()
	write the calibration data to file More...

void	calculateGainMap (result_t &gainmap)
	write the calibration data to file 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 Types
typedef std::pair< size_t, double >	statistic_t
	definition of the statistic More...

typedef std::vector< statistic_t >	statistics_t
	defintion of the statistics More...

typedef std::pair< float, float >	range_t
	define the range type More...

Private Attributes
shared_pointer	_image
	the raw image More...

statistics_t	_statistics
	the statistics for each pixel More...

size_t	_minPhotonCount
	the number of photons that a pixel should have seen before calculating the gain More...

range_t	_aduRange
	the range of adu that indicates whether a pixel contains a photon More...

float	_constGain
	the gain value that will be assinged to the pixel that one could not calculate the gain for More...

bool	_write
	flag to tell whether the calibration should be written More...

std::string	_filename
	the filename that is used to save the calibration More...

int	_nFrames
	the number of frames after which the gain map is calculted More...

int	_counter
	counter to count how many times this has been called More...

size_t	_gainOffset
	offset to the gain part More...

size_t	_countOffset
	offset to the counts part More...

size_t	_aveOffset
	offset to the average part More...

size_t	_sizeOfImage
	the size of the input image More...

bool	_isPnCCDNoCTE
	flag to tell whether its a pnCCD we are not interested in correction the cte More...

Additional Inherited Members
Public Types inherited from cass::Processor
typedef std::tr1::shared_ptr< Processor >	shared_pointer
	a shared pointer of this More...

typedef std::string	name_t
	define the name type More...

typedef std::list< name_t >	names_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::AccumulatingProcessor
result_t::shared_pointer	_result
	the result that accumulates the events More...

size_t	_nbrEventsAccumulated
	the number of events the processor has accumulated 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 gain calibrations

Available PostProcessors:: "331": pixel detector gain calibrations

See also: Processor for a list of all commonly available cass.ini settings.

The output of this Processor consits of 3 images stiched together along the y (slow) coordinate. The ouput has the same x width as the input, but 3 times the y width as the input.

Y from 0 * y_input .. 1 * y_input-1: The calculated Gain Map Y from 1 * y_input .. 2 * y_input-1: The photons counts map Y from 2 * y_input .. 3 * y_input-1: The Average value of the photons of interest in that pixel

User definable Parameters:

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

Processor/%name%/{Filename}
the name of the file where the calibration will be written to. Default is out.cal

Processor/%name%/{WriteCal}
Flag to tell whether the calibration should be written. Default is true.

Processor/%name%/{ADURangeLow|ADURangeHigh}
The adu range that indicates that one photon has hit the pixel. Default is 0|0

Processor/%name%/{MinimumNbrPhotons}
The minimum number of photons that a pixel should have seen before the gain is calulated for this pixel. Default is 200

Processor/%name%/{DefaultGainValue}
The gain value that will be assinged to the pixels that haven't seen enough photons. Default is 1.

Processor/%name%/{NbrOfFrames}
The number of frames after which the gain map will be calculated. Default is -1, which sais that it will never be calulated during running and only when the program ends.

Processor/%name%/{IsPnCCDNoCTE}
If the detector is a pnCCD and one doesn't want to correct for the CTE this option will calcultate the gain for a column of a quadrant of the detector. Default is false

Author: Lutz Foucar

Definition at line 359 of file pixel_detector_calibration.h.

Member Typedef Documentation

typedef std::pair<float,float> cass::pp331::range_t

private

define the range type

Definition at line 404 of file pixel_detector_calibration.h.

typedef std::pair<size_t,double> cass::pp331::statistic_t

private

definition of the statistic

Definition at line 392 of file pixel_detector_calibration.h.

typedef std::vector<statistic_t> cass::pp331::statistics_t

private

defintion of the statistics

Definition at line 395 of file pixel_detector_calibration.h.

Constructor & Destructor Documentation

pp331::pp331 ( const name_t & name )

constructor.

Definition at line 487 of file pixel_detector_calibration.cpp.

References loadSettings().

Member Function Documentation

void pp331::aboutToQuit ( )

virtual

write the calibrations before quitting

Reimplemented from cass::Processor.

Definition at line 564 of file pixel_detector_calibration.cpp.

References cass::AccumulatingProcessor::_result, _write, calculateGainMap(), and writeCalibration().

void pp331::calculateGainMap ( result_t & gainmap )

protected

write the calibration data to file

calculate the average of the average pixelvalues, disregarding pixels that have not seen enough photons in the right ADU range.

assining the gain value for each pixel that has seen enough statistics. gain is calculated by formula $gain = frac{average_average_pixelvalue}{average_pixelvalue}$ If not enough photons are in the pixel, set the predefined user value