CFEL - ASG Software Suite  2.5.0
CASS
Public Types | Public Member Functions | Static Public Member Functions | List of all members
cass::pixeldetector::FrameProcessorBase Class Referenceabstract

base class for all frame processors More...

#include <frame_processor_base.h>

+ Inheritance diagram for cass::pixeldetector::FrameProcessorBase:

Public Types

typedef std::tr1::shared_ptr< FrameProcessorBaseshared_pointer
 typedef the shared pointer of this More...
 

Public Member Functions

virtual ~FrameProcessorBase ()
 virtual destructor More...
 
virtual Frameoperator() (Frame &frame)=0
 process the frame More...
 
virtual void loadSettings (CASSSettings &s)=0
 load the settings of this processor More...
 

Static Public Member Functions

static shared_pointer instance (const std::string &type)
 create an instance of the requested functor More...
 

Detailed Description

base class for all frame processors

a frame processor will process the pixels of a frame. For a list of possible processors see description of pixeldetector::AdvancedDetector.

Author
Lutz Foucar

Definition at line 31 of file frame_processor_base.h.

Member Typedef Documentation

typedef the shared pointer of this

Definition at line 35 of file frame_processor_base.h.

Constructor & Destructor Documentation

virtual cass::pixeldetector::FrameProcessorBase::~FrameProcessorBase ( )
inlinevirtual

virtual destructor

Definition at line 38 of file frame_processor_base.h.

Member Function Documentation

FrameProcessorBase::shared_pointer FrameProcessorBase::instance ( const std::string &  type)
static

create an instance of the requested functor

Returns
a shared pointer to the requested type
Parameters
typethe reqested type

Definition at line 43 of file frame_processor_base.cpp.

Referenced by cass::pixeldetector::AdvancedDetector::loadSettings().

virtual void cass::pixeldetector::FrameProcessorBase::loadSettings ( CASSSettings s)
pure virtual

load the settings of this processor

Parameters
sthe CASSSettings object to read the information from

Implemented in cass::pixeldetector::HLLProcessor, and cass::pixeldetector::NoProcess.

virtual Frame& cass::pixeldetector::FrameProcessorBase::operator() ( Frame frame)
pure virtual

process the frame

take the input frame, process it and then return a reference to it

Returns
reference to the processed frame
Parameters
framethe frame that should be processed

Implemented in cass::pixeldetector::HLLProcessor, and cass::pixeldetector::NoProcess.


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