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

get the local background from image. More...

#include <hitfinder.h>

+ Inheritance diagram for cass::pp203:
+ Collaboration diagram for cass::pp203:

Public Member Functions

 pp203 (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::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 Attributes

shared_pointer _hist
 pp containing 2d histogram More...
 
std::pair< size_t, size_t > _boxSize
 the size of the box used for the median filter More...
 
std::pair< size_t, size_t > _sectionSize
 size of a image section 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

get the local background from image.

Available PostProcessors:
"203": get the local background from image

splits up the image into sections of user choosable size. In each of these sections the local background is determined by taking a box of a user choosable size and determining the median of the pixel values inside this box.

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

Processor/%name%/{ImageName}
the processor name that contain the 2d histogram. Default is "blubb".

Processor/%name%/{SectionSizeX|SectionSizeY}
Size of the subsection of the image. Default is 1024|512.

Processor/%name%/{BoxSizeX|BoxSizeY}
size in x and y of the box that is used for determining the median background. Default is 10|10.

Author
Lutz Foucar
Wolfgang Kabsch

Definition at line 47 of file hitfinder.h.

Constructor & Destructor Documentation

pp203::pp203 ( const name_t name)

constructor

Definition at line 28 of file hitfinder.cpp.

References loadSettings().

Member Function Documentation

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

Member Data Documentation

std::pair<size_t,size_t> cass::pp203::_boxSize
protected

the size of the box used for the median filter

Definition at line 64 of file hitfinder.h.

Referenced by loadSettings(), and process().

shared_pointer cass::pp203::_hist
protected

pp containing 2d histogram

Definition at line 61 of file hitfinder.h.

Referenced by loadSettings(), and process().

std::pair<size_t,size_t> cass::pp203::_sectionSize
protected

size of a image section

Definition at line 67 of file hitfinder.h.

Referenced by loadSettings(), and process().


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