Integral of 1D result. More...

#include <operations.h>

Inheritance diagram for cass::pp51:

Collaboration diagram for cass::pp51:

Public Member Functions
	pp51 (const name_t &name)
	constructor More...

virtual void	process (const CASSEvent &, result_t &)
	process event More...

virtual void	loadSettings (size_t)
	load the settings of the 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_t &	result (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_t &	dependencies ()
	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...

Private Member Functions
float	baselineFromInput (const result_t &input)
	get the baseline for the integration More...

float	constantBaseline (const result_t &)
	get constant baseline More...

Private Attributes
shared_pointer	_input
	processor containing the 1d result we want to integrate More...

std::pair< int, int >	_range
	range we want to have the integral over in result bins More...

std::pair< int, int >	_baselineRange
	range we want to have the baseline for the integral over in result bins More...

std::tr1::function< float(const result_t &)>	_baseline
	the function that will return the baseline 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 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...

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

Integral of 1D result.

Available PostProcessors:: "51": Integral of 1D result

integrate the values of a 1d result within a user set range

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

User definable Parameters:

Processor/%name%/{InputName}
processor name with 1D-result that we create the intgral from. Default is Unknown.

Processor/%name%/{XLow|XUp}
Upper and lower bound of the area to integrate. The endpoints are defined like $ [XLow,Xup[ $ . Default is -1e6 ... 1e6

Processor/%name%/{BaselineXLow|BaselineXUp}
Upper and lower bound of the area that determines the baseline for the integration. If these values are not set, then a baseline of 0 is taken. The endpoints are defined like $ [XLow,Xup[ $ . Default is -1e6 ... 1e6

Author: Lutz Foucar

Definition at line 726 of file operations.h.

Constructor & Destructor Documentation

pp51::pp51 ( const name_t & name )

constructor

Definition at line 920 of file operations.cpp.

References loadSettings().

Member Function Documentation

float pp51::baselineFromInput ( const result_t & input )

private

get the baseline for the integration

Returns: the baseline value

Parameters

input the input trace from which the baseline will be determined

Definition at line 1036 of file operations.cpp.

References _baselineRange, and cass::Result< T >::begin().

Referenced by loadSettings().

float cass::pp51::constantBaseline ( const result_t & )

inlineprivate

get constant baseline

Returns: the constant baseline value

Parameters

input unused

Definition at line 760 of file operations.h.

Referenced by loadSettings().

void pp51::loadSettings ( size_t )

virtual

load the settings of the pp

Reimplemented from cass::Processor.

Definition at line 926 of file operations.cpp.

References _baseline, _baselineRange, cass::Processor::_condition, _input, _range, cass::Log::add(), baselineFromInput(), QSettings::beginGroup(), constantBaseline(), cass::Processor::createHistList(), QString::fromStdString(), cass::Log::INFO, input, cass::Processor::name(), cass::Processor::setupCondition(), cass::Processor::setupDependency(), cass::Processor::setupGeneral(), cass::toString(), QSettings::value(), and cass::Result< float >::xAxis.

Referenced by pp51().

void pp51::process	(	const CASSEvent &	evt,
		result_t &	result
	)

virtual

process event

Reimplemented from cass::Processor.

Definition at line 1045 of file operations.cpp.

References _baseline, _input, _range, cass::Result< T >::begin(), cass::CASSEvent::id(), input, cass::Result< T >::lock, and cass::Result< T >::setValue().

Member Data Documentation

std::tr1::function<float(const result_t&)> cass::pp51::_baseline

private

the function that will return the baseline

Definition at line 763 of file operations.h.

Referenced by loadSettings(), and process().

std::pair<int,int> cass::pp51::_baselineRange

private

range we want to have the baseline for the integral over in result bins

Definition at line 746 of file operations.h.

Referenced by baselineFromInput(), and loadSettings().

shared_pointer cass::pp51::_input

private

processor containing the 1d result we want to integrate

Definition at line 740 of file operations.h.

Referenced by loadSettings(), and process().

std::pair<int,int> cass::pp51::_range

private

range we want to have the integral over in result bins

Definition at line 743 of file operations.h.

Referenced by loadSettings(), and process().

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation