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

return the statistic values of all bins of a result More...

#include <operations.h>

+ Inheritance diagram for cass::pp82:
+ Collaboration diagram for cass::pp82:

Public Member Functions

 pp82 (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_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 Types

typedef CummulativeStatisticsCalculator< result_t::value_tcumstat_t
 define the type of cummulative statistics used More...
 
typedef MedianCalculator< result_t::value_tmed_t
 define the median calculator used More...
 

Protected Member Functions

result_t::value_t cummulativeStatistics (const result_t &res)
 retrieve the statistics value from the cummulative statistics calculator More...
 
result_t::value_t medianCalc (const result_t &res)
 retrieve the statistics value from the median statistics calculator 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

shared_pointer _pHist
 processor containing input result More...
 
std::tr1::function< cumstat_t::value_type(const cumstat_t &)> _val
 the type of function used to retrive the wanted element More...
 
std::tr1::function< result_t::value_t(const result_t &)> _value
 function to retrieve the statistics type 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...
 

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...
 

Detailed Description

return the statistic values of all bins of a result

Available PostProcessors:
"82": user choosable statistics value of all bins of a result
See also
Processor for a list of all commonly available cass.ini settings.
User definable Parameters:

Processor/%name%/{InputName}
Processor containing the result for which the requested statistical value is calculated.

Processor/%name%/{Statistics}
Type of statistic that one wants to retrieve. Default is "sum". Possible values are:

  • sum: Sum of values of all bins
  • mean: Mean value of values of all bins
  • stdv: Standart deviation of values of all bins
  • variance: Variance of values of all bins
  • median: Median value of all bins
Author
Lutz Foucar

Definition at line 1975 of file operations.h.

Member Typedef Documentation

define the type of cummulative statistics used

Definition at line 2011 of file operations.h.

define the median calculator used

Definition at line 2014 of file operations.h.

Constructor & Destructor Documentation

pp82::pp82 ( const name_t name)

constructor

Definition at line 2620 of file operations.cpp.

References loadSettings().

Member Function Documentation

pp82::result_t::value_t pp82::cummulativeStatistics ( const result_t res)
protected

retrieve the statistics value from the cummulative statistics calculator

Returns
the statistical value
Parameters
resThe result from which the statistical value should be calculated.

Definition at line 2673 of file operations.cpp.

References _val, cass::CummulativeStatisticsCalculator< Type >::addDistribution(), cass::Result< T >::begin(), and cass::Result< T >::datasize().

Referenced by loadSettings().

void pp82::loadSettings ( size_t  )
virtual
pp82::result_t::value_t pp82::medianCalc ( const result_t res)
protected

retrieve the statistics value from the median statistics calculator

Returns
the statistical value
Parameters
resThe result from which the statistical value should be calculated.

Definition at line 2680 of file operations.cpp.

References cass::MedianCalculator< Type >::addDistribution(), cass::Result< T >::begin(), cass::Result< T >::datasize(), and cass::MedianCalculator< Type >::median().

Referenced by loadSettings().

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

process event

Reimplemented from cass::Processor.

Definition at line 2687 of file operations.cpp.

References _pHist, _value, cass::CASSEvent::id(), cass::Result< T >::lock, and cass::Result< T >::setValue().

Member Data Documentation

shared_pointer cass::pp82::_pHist
protected

processor containing input result

Definition at line 2008 of file operations.h.

Referenced by loadSettings(), and process().

std::tr1::function<cumstat_t::value_type(const cumstat_t&)> cass::pp82::_val
protected

the type of function used to retrive the wanted element

Definition at line 2017 of file operations.h.

Referenced by cummulativeStatistics(), and loadSettings().

std::tr1::function<result_t::value_t(const result_t&)> cass::pp82::_value
protected

function to retrieve the statistics type

Definition at line 2020 of file operations.h.

Referenced by loadSettings(), and process().


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