CLAM::SpectralNotch Class Reference

#include <SpectralNotch.hxx>

List of all members.

Public Member Functions
const char *	GetClassName () const
	Override it in every subclass and retur the name of that class.
	SpectralNotch ()
	~SpectralNotch ()
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 SpectralNotch.hxx.

---

Constructor & Destructor Documentation

CLAM::SpectralNotch::SpectralNotch

(

)

[inline]

Definition at line 51 of file SpectralNotch.hxx.

References CLAM::Processing::Configure().

CLAM::SpectralNotch::~SpectralNotch

(

)

[inline]

Definition at line 62 of file SpectralNotch.hxx.

---

Member Function Documentation

bool CLAM::SpectralNotch::Do

(

)

[inline, virtual]

Supervised mode execution method (using ports).

Returns:

A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 81 of file SpectralNotch.hxx.

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

Referenced by Do().

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

Implements CLAM::FrameTransformationTmpl< Spectrum >.

Definition at line 39 of file SpectralNotch.cxx.

References CLAM::InControl< ControlDataType >::GetLastValue(), CLAM::Spectrum::GetSize(), log2lin(), and Round().

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

Implements CLAM::FrameTransformation.

Definition at line 73 of file SpectralNotch.hxx.

References Do().

const char* CLAM::SpectralNotch::GetClassName

(

)

const [inline, virtual]

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

Implements CLAM::Processing.

Definition at line 46 of file SpectralNotch.hxx.

virtual bool CLAM::SpectralNotch::InitControls

(

)

[inline, virtual]

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

Reimplemented from CLAM::FrameTransformation.

Definition at line 64 of file SpectralNotch.hxx.

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

---

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

• SpectralNotch.hxx
• SpectralNotch.cxx