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

calculate median of last values. More...

#include <rankfilter.h>

+ Inheritance diagram for cass::pp301:
+ Collaboration diagram for cass::pp301:

Public Member Functions

 pp301 (const name_t &)
 constructor More...
 
virtual void process (const CASSEvent &, result_t &)
 process event More...
 
virtual void loadSettings (size_t)
 load the settings of this pp 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_tresult (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...
 
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 Attributes

shared_pointer _one
 pp containing first histogram More...
 
unsigned int _medianSize
 last N items to be used for median calculation More...
 
std::deque< float > _medianStorage
 storage of last values for median calculation More...
 
QMutex _mutex
 mutex to lock the median storage 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...
 

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

Detailed Description

calculate median of last values.

Available PostProcessors:
"301": calculate median of last values

If input histogram is > 0d, its values get summed up prior to median calculation.

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

Processor/%name%/{InputName}
the processor name that contain the first histogram. Default is 0.

Processor/%name%/{MedianSize}
how many last values should be included in median calculation. default is 100.

Todo:
make more general: operate on bins. now operates on sum.
Author
Stephan Kassemeyer.
Lutz Foucar

Definition at line 42 of file rankfilter.h.

Constructor & Destructor Documentation

pp301::pp301 ( const name_t name)

constructor

Definition at line 28 of file rankfilter.cpp.

References loadSettings().

Member Function Documentation

void pp301::loadSettings ( size_t  )
virtual
void pp301::process ( const CASSEvent evt,
result_t result 
)
virtual

Member Data Documentation

unsigned int cass::pp301::_medianSize
protected

last N items to be used for median calculation

Definition at line 59 of file rankfilter.h.

Referenced by loadSettings(), and process().

std::deque<float> cass::pp301::_medianStorage
protected

storage of last values for median calculation

Definition at line 62 of file rankfilter.h.

Referenced by process().

QMutex cass::pp301::_mutex
protected

mutex to lock the median storage

Definition at line 65 of file rankfilter.h.

Referenced by process().

shared_pointer cass::pp301::_one
protected

pp containing first histogram

Definition at line 56 of file rankfilter.h.

Referenced by loadSettings(), and process().


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