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

generate a 2d Histogram from values of 2 columns of a table More...

#include <table_operations.h>

+ Inheritance diagram for cass::pp79:
+ Collaboration diagram for cass::pp79:

Public Member Functions

 pp79 (const name_t &)
 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 std::tr1::function< result_t::value_t(result_t::const_iterator)> func_t
 define the function to return the weight value More...
 

Protected Member Functions

func_t::result_type weightFromTable (func_t::argument_type tableIt)
 returns the weight value from a table More...
 
func_t::result_type constantWeight (func_t::argument_type unused)
 returns a 1 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 _table
 pp containing input table More...
 
size_t _xcolIdx
 index of the column with the x-values that needs to be extracted More...
 
size_t _ycolIdx
 index of the column with the y-values that needs to be extracted More...
 
int _weightcolIdx
 index of the column with the weights that needs to be exracted More...
 
func_t _getWeight
 the function to return the weight 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

generate a 2d Histogram from values of 2 columns of a table

Available PostProcessors:
"79": generate a 2d Histogram from values of 2 columns of a table
See also
Processor for a list of all commonly available cass.ini settings.
User definable Parameters:

Processor/%name%/{TableName}
name of processor that contains the table like histogram subset from. Default is "".

Processor/%name%/{XColumnIndex|YColumnIndex}
The index of the column in the table that one wants to have extracted and put on the x- and y-axis. Please refer to the Processor description of the Processor that contains the table to find out what column indizes are available. Default is "0".

Processor/%name%/{WeightColumnIndex}
Optional index of the column that will be used for the weights when histogramming the x and y values. If negative number is given the absolute value of it will be used as weight. Default is -1

Processor/%name%/{XNbrBins|XLow|XUp|YNbrBins|YLow|YUp}
properties of the 2d result

Author
Lutz Foucar

Definition at line 194 of file table_operations.h.

Member Typedef Documentation

typedef std::tr1::function<result_t::value_t(result_t::const_iterator)> cass::pp79::func_t
protected

define the function to return the weight value

Definition at line 208 of file table_operations.h.

Constructor & Destructor Documentation

pp79::pp79 ( const name_t name)

constructor

Definition at line 195 of file table_operations.cpp.

References loadSettings().

Member Function Documentation

pp79::func_t::result_type pp79::constantWeight ( func_t::argument_type  unused)
protected

returns a 1

Parameters
1
unusedunused parameter

Definition at line 248 of file table_operations.cpp.

References _weightcolIdx.

Referenced by loadSettings().

void pp79::loadSettings ( size_t  )
virtual
void pp79::process ( const CASSEvent evt,
result_t result 
)
virtual
pp79::func_t::result_type pp79::weightFromTable ( func_t::argument_type  tableIt)
protected

returns the weight value from a table

Parameters
theweight
tableItthe iterator that points to the row of the table to exract the weight from

Definition at line 243 of file table_operations.cpp.

References _weightcolIdx.

Referenced by loadSettings().

Member Data Documentation

func_t cass::pp79::_getWeight
protected

the function to return the weight

Definition at line 240 of file table_operations.h.

Referenced by loadSettings(), and process().

shared_pointer cass::pp79::_table
protected

pp containing input table

Definition at line 228 of file table_operations.h.

Referenced by loadSettings(), and process().

int cass::pp79::_weightcolIdx
protected

index of the column with the weights that needs to be exracted

Definition at line 237 of file table_operations.h.

Referenced by constantWeight(), loadSettings(), and weightFromTable().

size_t cass::pp79::_xcolIdx
protected

index of the column with the x-values that needs to be extracted

Definition at line 231 of file table_operations.h.

Referenced by loadSettings(), and process().

size_t cass::pp79::_ycolIdx
protected

index of the column with the y-values that needs to be extracted

Definition at line 234 of file table_operations.h.

Referenced by loadSettings(), and process().


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