CLAM::FrameTransformation Class Reference

#include <FrameTransformation.hxx>

List of all members.

Public Member Functions

 FrameTransformation ()
virtual bool Do (const Frame &in, Frame &out)=0
const ProcessingConfigGetConfig () const
 Configuration getter.
virtual bool ConcreteStart ()
 Processing objects have to redefine this method when starting them implies some internal changes.
virtual bool InitControls ()
 Virtual function to override when needing to give different default values to the controls.

Protected Attributes

FrameTransformationConfig mConfig
FloatInControl mAmount

Detailed Description

Definition at line 11 of file FrameTransformation.hxx.

Constructor & Destructor Documentation

CLAM::FrameTransformation::FrameTransformation (  )  [inline]

Definition at line 14 of file FrameTransformation.hxx.

References FrameTransformation(), and mAmount.

Referenced by FrameTransformation().

Member Function Documentation

virtual bool CLAM::FrameTransformation::ConcreteStart ( void   )  [inline, virtual]

Processing objects have to redefine this method when starting them implies some internal changes.

ie: adquiring resources.

Whether start changes have been successful

Reimplemented from CLAM::Processing.

Definition at line 22 of file FrameTransformation.hxx.

References mConfig.

virtual bool CLAM::FrameTransformation::Do ( const Frame in,
Frame out 
) [pure virtual]
const ProcessingConfig& CLAM::FrameTransformation::GetConfig (  )  const [inline, virtual]

Configuration getter.

Gets the configuration parameters used to create the object.

Const reference to the configuration object. The usual way to perform a configuration change in the processing object is to take a copy of this reference, to change it and to send it with the Configure method. If not overriden, it returns a NullProcessingConfig.

Reimplemented from CLAM::Processing.

Reimplemented in CLAM::SMSHarmonizer, and CLAM::SMSSineFilter.

Definition at line 20 of file FrameTransformation.hxx.

virtual bool CLAM::FrameTransformation::InitControls (  )  [inline, virtual]

Member Data Documentation

The documentation for this class was generated from the following file:
Generated by  doxygen 1.6.3