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

calculate intensity correction More...

#include <partial_covariance.h>

+ Inheritance diagram for cass::pp412:
+ Collaboration diagram for cass::pp412:

Public Member Functions

 pp412 (const name_t &)
 constructor More...
 
virtual void process (const CASSEvent &, result_t &)
 process event More...
 
virtual void loadSettings (size_t)
 load the settings 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 Member Functions

void calcCovariance (const result_t &waveTrace, const result_t &waveTraceAve, const float intensity, const float intensityAveOld, result_t &correction, float n)
 calculate covariance 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 _hist1D
 pp containing input histogram 1D More...
 
shared_pointer _hist0D
 pp containing input histogram 0D More...
 
shared_pointer _ave1D
 pp containing input histogram 1D it should be averaged _hist1D More...
 
shared_pointer _ave0D
 pp containing input histogram 0D it should be averaged _hist0D 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...
 

Detailed Description

calculate intensity correction

Available PostProcessors:
"412": calculate intensity correction of covariance map

calculate the covariance between wavetrace and intensity by on-line algorithm $cov_n=\frac{1}{n}((n-1)cov_{n-1}+(x_n-aveX_n))(y_n-aveY_{n-1}))$

User definable Parameters:

Processor/%name%/{TofName}
input 1D histogram that is the time of flight wavetrace.

Processor/%name%/{AveTofName}
input 1D averaged histogram that is the time of flight wavetrace.

Processor/%name%/{IntensityName}
input 1D histogram that is intensity.

Processor/%name%/{AveIntensityName}
input 0D averaged histogram that is intensity.

Author
Koji Motomura

Definition at line 749 of file partial_covariance.h.

Constructor & Destructor Documentation

pp412::pp412 ( const name_t name)

constructor

Definition at line 848 of file partial_covariance.cpp.

References loadSettings().

Member Function Documentation

void pp412::calcCovariance ( const result_t waveTrace,
const result_t waveTraceAve,
const float  intensity,
const float  intensityAveOld,
result_t correction,
float  n 
)
protected

calculate covariance

calculate covariance between wavetrace (1d) and intensity (0d).

Parameters
waveTraceinput wavetrace
waveTraceAveaveraged wavetrace
intensity0d intensity value
intensityAveOldaveraged intensity value
correctionoutput histogram calculated covariance
nnumber of present event

Definition at line 873 of file partial_covariance.cpp.

References _hist1D, and cass::Result< float >::xAxis.

Referenced by process().

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

Member Data Documentation

shared_pointer cass::pp412::_ave0D
protected

pp containing input histogram 0D it should be averaged _hist0D

Definition at line 773 of file partial_covariance.h.

Referenced by loadSettings(), and process().

shared_pointer cass::pp412::_ave1D
protected

pp containing input histogram 1D it should be averaged _hist1D

Definition at line 770 of file partial_covariance.h.

Referenced by loadSettings(), and process().

shared_pointer cass::pp412::_hist0D
protected

pp containing input histogram 0D

Definition at line 767 of file partial_covariance.h.

Referenced by loadSettings(), and process().

shared_pointer cass::pp412::_hist1D
protected

pp containing input histogram 1D

Definition at line 764 of file partial_covariance.h.

Referenced by calcCovariance(), loadSettings(), and process().


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