CLAM::SMSSineFilter Class Reference

#include <SMSSineFilter.hxx>

List of all members.

Public Member Functions
	SMSSineFilter ()
	Base constructor of class.
	SMSSineFilter (const FrameTransformationConfig &cfg)
	Constructor with an object of SegmentTransformationConfig class by parameter.
virtual bool	ConcreteConfigure (const ProcessingConfig &cfg)
	Configuration method interface.
const ProcessingConfig &	GetConfig () const
	Configuration getter.
	~SMSSineFilter ()
	Destructor of the class.
bool	Do (const Frame &in, Frame &out)
bool	Do (const SpectralPeakArray &in, SpectralPeakArray &out)
bool	Do ()
	Supervised mode execution method (using ports).
void	InitBPF ()

---

Detailed Description

Definition at line 68 of file SMSSineFilter.hxx.

---

Constructor & Destructor Documentation

CLAM::SMSSineFilter::SMSSineFilter

(

)

[inline]

Base constructor of class.

Calls Configure method with a SegmentTransformationConfig initialised by default

Definition at line 97 of file SMSSineFilter.hxx.

References CLAM::Processing::Configure(), CLAM::FrameTransformation::mConfig, and CLAM::DynamicType::UpdateData().

CLAM::SMSSineFilter::SMSSineFilter

(

const FrameTransformationConfig &

cfg

)

[inline]

Constructor with an object of SegmentTransformationConfig class by parameter.

Parameters:

c

SegmentTransformationConfig object created by the user

Definition at line 114 of file SMSSineFilter.hxx.

References CLAM::Processing::Configure().

CLAM::SMSSineFilter::~SMSSineFilter

(

)

[inline]

Destructor of the class.

Definition at line 134 of file SMSSineFilter.hxx.

---

Member Function Documentation

virtual bool CLAM::SMSSineFilter::ConcreteConfigure

(

const ProcessingConfig &

)

[inline, virtual]

Configuration method interface.

The Processing base class forces all the concrete classes derived from it to implement this method, which must actually perform the specific configuration tasks.

Note that the user can not call this method directly. He will use Configure instead. The argument is expected to be an object of the necesary concrete configuration class.

Parameters:

Reference

to the configuration object.

Returns:

false if the object is not yet fully configured. (For example, if some important configuration attribute such as number of ports was set to zero in the config object)

true if the processing object is left in a consistent state, and can be executed.

Exceptions:

This

method must throw a bad_cast exception if the argument is not an object of the expected configuration class.

Reimplemented from CLAM::Processing.

Definition at line 124 of file SMSSineFilter.hxx.

References CLAM::Processing::CopyAsConcreteConfig(), InitBPF(), and CLAM::FrameTransformation::mConfig.

bool CLAM::SMSSineFilter::Do

(

)

[inline, virtual]

Supervised mode execution method (using ports).

Returns:

A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 145 of file SMSSineFilter.hxx.

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

Referenced by Do().

bool CLAM::SMSSineFilter::Do	(	const SpectralPeakArray &	in,
		SpectralPeakArray &	out
	)

Definition at line 36 of file SMSSineFilter.cxx.

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

Implements CLAM::FrameTransformation.

Definition at line 137 of file SMSSineFilter.hxx.

References Do().

const ProcessingConfig& CLAM::SMSSineFilter::GetConfig

(

)

const [inline, virtual]

Configuration getter.

Gets the configuration parameters used to create the object.

Returns:

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::FrameTransformation.

Definition at line 131 of file SMSSineFilter.hxx.

References CLAM::FrameTransformation::mConfig.

void CLAM::SMSSineFilter::InitBPF

(

)

[inline]

Definition at line 153 of file SMSSineFilter.hxx.

References CLAM::FrameTransformation::mConfig, CLAM::BPFTmpl< TX, TY >::Resize(), CLAM::BPFTmpl< TX, TY >::SetSize(), CLAM::BPFTmpl< TX, TY >::SetValue(), and CLAM::DynamicType::UpdateData().

Referenced by ConcreteConfigure().

---

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

• SMSSineFilter.hxx
• SMSSineFilter.cxx