CLAM::SpectralGate Class Reference

#include <SpectralGate.hxx>

List of all members.

Public Member Functions

const char * GetClassName () const
 Override it in every subclass and retur the name of that class.
 SpectralGate ()
 ~SpectralGate ()
virtual bool InitControls ()
 Virtual function to override when needing to give different default values to the controls.
bool Do (const Frame &in, Frame &out)
bool Do (const Spectrum &in, Spectrum &out)
bool Do ()
 Supervised mode execution method (using ports).


Detailed Description

Definition at line 36 of file SpectralGate.hxx.


Constructor & Destructor Documentation

CLAM::SpectralGate::SpectralGate (  )  [inline]

Definition at line 47 of file SpectralGate.hxx.

References CLAM::Processing::Configure().

CLAM::SpectralGate::~SpectralGate (  )  [inline]

Definition at line 55 of file SpectralGate.hxx.


Member Function Documentation

bool CLAM::SpectralGate::Do (  )  [inline, virtual]

Supervised mode execution method (using ports).

Returns:
A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 72 of file SpectralGate.hxx.

References CLAM::InPort< Token >::Consume(), CLAM::OutPort< Token >::GetData(), CLAM::InPort< Token >::GetData(), and CLAM::OutPort< Token >::Produce().

Referenced by Do().

bool CLAM::SpectralGate::Do ( const Spectrum in,
Spectrum out 
) [virtual]

bool CLAM::SpectralGate::Do ( const Frame in,
Frame out 
) [inline, virtual]

Implements CLAM::FrameTransformation.

Definition at line 64 of file SpectralGate.hxx.

References Do().

const char* CLAM::SpectralGate::GetClassName (  )  const [inline, virtual]

Override it in every subclass and retur the name of that class.

Implements CLAM::Processing.

Definition at line 42 of file SpectralGate.hxx.

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

Virtual function to override when needing to give different default values to the controls.

Reimplemented from CLAM::FrameTransformation.

Definition at line 57 of file SpectralGate.hxx.

References CLAM::InControl::DoControl(), and CLAM::FrameTransformation::mAmount.


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

Generated on Tue Feb 22 09:53:31 2011 for CLAM-Development by  doxygen 1.5.9