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

Threshold result. More...

#include <operations.h>

+ Inheritance diagram for cass::pp40:
+ Collaboration diagram for cass::pp40:

Public Member Functions

 pp40 (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 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

result_t::value_t threshold (const result_t::value_t &value, const result_t::value_t &thres)
 the thresholding function More...
 
void applyConstantThreshold (const result_t &in, result_t &out, const CASSEvent::id_t &id)
 apply a constant threshold More...
 
void applyIdxwiseThreshold (const result_t &in, result_t &out, const CASSEvent::id_t &id)
 apply a indexwise threshold More...
 
- Protected Member Functions inherited from cass::Processor
virtual void process (const CASSEvent &event, result_t &result)
 process the event More...
 
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

std::tr1::function< void(const result_t &, result_t &, const CASSEvent::id_t &)> _applyThresh
 the funtion that applies the threshold to the input More...
 
shared_pointer _threshPP
 pp containing the indexwise threshold More...
 
shared_pointer _one
 pp containing input result More...
 
result_t::value_t _userVal
 the user value that will be set when the threshold is applied More...
 
result_t::value_t _threshold
 the threshold 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

Threshold result.

Available PostProcessors:
"40": Threshold result
See also
Processor for a list of all commonly available cass.ini settings.
User definable Parameters:

Processor/%name%/{InputName}
processor name with result that should be thresholded. Default is 0.

Processor/%name%/{Threshold}
Either an result or a constant value with which the input result will be thresholded.

Processor/%name%/{UserVal}
The value that will be set when the input value is below the threshold. Default is 0.

Author
Thomas White
Lutz Foucar

Definition at line 483 of file operations.h.

Constructor & Destructor Documentation

pp40::pp40 ( const name_t name)

constructor

Definition at line 613 of file operations.cpp.

References loadSettings().

Member Function Documentation

void pp40::applyConstantThreshold ( const result_t in,
result_t out,
const CASSEvent::id_t id 
)
protected

apply a constant threshold

Parameters
inthe input result that should be thresholded
outthe result where the thresholded values will be written to
idthe event id of the current event

Definition at line 660 of file operations.cpp.

References _threshold, cass::Result< T >::begin(), cass::Result< T >::datasize(), and threshold().

Referenced by loadSettings().

void pp40::applyIdxwiseThreshold ( const result_t in,
result_t out,
const CASSEvent::id_t id 
)
protected

apply a indexwise threshold

Parameters
inthe input result that should be thresholded
outthe result where the thresholded values will be written to
idthe event id of the current event

Definition at line 669 of file operations.cpp.

References _threshPP, cass::Result< T >::begin(), cass::Result< T >::datasize(), and threshold().

Referenced by loadSettings().

void pp40::loadSettings ( size_t  )
virtual
void pp40::process ( const CASSEvent ,
result_t  
)
virtual

process event

only threshold the area containing data

Definition at line 681 of file operations.cpp.

References _applyThresh, _one, cass::CASSEvent::id(), and cass::Result< T >::lock.

Processor::result_t::value_t pp40::threshold ( const result_t::value_t value,
const result_t::value_t thres 
)
protected

the thresholding function

will check whether the input is bigger than the threshold and return the input if so, otherwise it will retrun the user value.

Parameters
valuethe value to check for
threshthe threshold for the value

Definition at line 654 of file operations.cpp.

References _userVal.

Referenced by applyConstantThreshold(), and applyIdxwiseThreshold().

Member Data Documentation

std::tr1::function<void(const result_t&, result_t&, const CASSEvent::id_t&)> cass::pp40::_applyThresh
protected

the funtion that applies the threshold to the input

Definition at line 498 of file operations.h.

Referenced by loadSettings(), and process().

shared_pointer cass::pp40::_one
protected

pp containing input result

Definition at line 532 of file operations.h.

Referenced by loadSettings(), and process().

result_t::value_t cass::pp40::_threshold
protected

the threshold

Definition at line 538 of file operations.h.

Referenced by applyConstantThreshold(), and loadSettings().

shared_pointer cass::pp40::_threshPP
protected

pp containing the indexwise threshold

Definition at line 529 of file operations.h.

Referenced by applyIdxwiseThreshold(), and loadSettings().

result_t::value_t cass::pp40::_userVal
protected

the user value that will be set when the threshold is applied

Definition at line 535 of file operations.h.

Referenced by loadSettings(), and threshold().


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