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

returns a list of local extreme points in a 1D result More...

#include <operations.h>

+ Inheritance diagram for cass::pp91:
+ Collaboration diagram for cass::pp91:

Public Member Functions

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

enum  ColumnNames { Index = 0, Position = 1, Value = 2, nbrOf }
 enum describing the contents of the resulting table More...
 
typedef result_t::storage_t table_t
 definition of the table More...
 

Protected Attributes

shared_pointer _input
 pp containing input histogram More...
 
size_t _range
 the requested x-axis limits in histogram coordinates More...
 
std::tr1::function< bool(const result_t::value_t &, const result_t::value_t &)> _op
 operation to find the extreme point 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

returns a list of local extreme points in a 1D result

Available PostProcessors:
"91": returns a list of local extreme points in a 1D result

It will look for a maximum or minimum value that is a user defined range. If data is the 1D array the range is as follows: $ range \leq i < size-range $, where i is the index of the array and size is the size of the array. The local extreme point has to be the highest (in case of maxima) or the lowest (in case of minima) value within the range: $ i-range \leq j < i+range $ where i is the index of the value to check whether it is a extreme point and j the index of the values to compare to. One can choose whether one want to find the local minima or the local maxima

All found extreme points will be added to a table like result

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

Processor/%name%/{InputName}
Name of the Processor that contains the 1D result where the local extreme points will be retrieved from

Processor/%name%/{Range}
The range to check for the local extreme points. Default is 10

Processor/%name%/{ExtremePointType}
The type of extreme points that should be extracted from input. Default is "minima". Possible values are:

  • "minima": extracts the local minima from the 1D result
  • "maxima": extracts the local maxima from the 1D result
Author
Lutz Foucar

Definition at line 2376 of file operations.h.

Member Typedef Documentation

definition of the table

Definition at line 2390 of file operations.h.

Member Enumeration Documentation

enum cass::pp91::ColumnNames
protected

enum describing the contents of the resulting table

Enumerator
Index 
Position 
Value 
nbrOf 

Definition at line 2393 of file operations.h.

Constructor & Destructor Documentation

pp91::pp91 ( const name_t name)

constructor

Definition at line 3290 of file operations.cpp.

References loadSettings().

Member Function Documentation

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

Member Data Documentation

shared_pointer cass::pp91::_input
protected

pp containing input histogram

Definition at line 2402 of file operations.h.

Referenced by loadSettings(), and process().

std::tr1::function<bool(const result_t::value_t&, const result_t::value_t&)> cass::pp91::_op
protected

operation to find the extreme point

Definition at line 2408 of file operations.h.

Referenced by loadSettings(), and process().

size_t cass::pp91::_range
protected

the requested x-axis limits in histogram coordinates

Definition at line 2405 of file operations.h.

Referenced by loadSettings(), and process().


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