CLAM::SpectrumProduct Class Reference

This class performs the product of two Spectrum processing data objects. More...

#include <SpectrumProduct.hxx>

List of all members.

Public Member Functions
	SpectrumProduct (const Config &c=Config())
virtual	~SpectrumProduct ()
bool	Do ()
	Supervised mode execution method (using ports).
bool	Do (Spectrum &in1, Spectrum &in2, Spectrum &out)
bool	SetPrototypes (const Spectrum &in1, const Spectrum &in2, const Spectrum &out)
	Change the internal type state.
bool	SetPrototypes ()
bool	UnsetPrototypes ()
bool	MayDisableExecution () const
Public Attributes
InPort< Spectrum >	mInput1
InPort< Spectrum >	mInput2
OutPort< Spectrum >	mOutput

---

Detailed Description

This class performs the product of two Spectrum processing data objects.

Its primary use will be to allow frecuency domain filtering, by taking the frecuency response as one of its inputs. (It implements the funcionality provided in the old CCLAMApplyFDFilter class).

It Allows any possible attribute configuration in its inputs and in its output, but it performs faster when prototype configuration of the data is specified using SetPrototypes(...), in certain situations:

• When all the inputs and the outputs have a common attribute (not the BPF), and the same scale.
• When one of the inputs has just a BPF attribute, and both the other input and the output have a common (non-BPF) attribute with the same scale in both objects.
• In other cases, at least a vector conversion will be executed in one of the involved processing data objects. In some bad situations two conversions might be needed.

Todo:

Possible optimisations (which require more states):

• Implement direct product routines with inputs/outpust in different formats, and add the corresponding prototype states.
• Expand the state space to avoid checking if the attribute to be used in the computation is instantiated in each of the objects. Right now the same state is used when the three objects have a common attribute, and when a common attribute is to be used, but some of the objects lack it (and need format conversion).

The BPFxBPF product is being thought. If both BPFs have the same range and point possition, the way to go is obvious, but in other situations it is not so simple. Whe should probably merge both BPFs, into a new BPF.

Definition at line 69 of file SpectrumProduct.hxx.

---

Constructor & Destructor Documentation

CLAM::SpectrumProduct::SpectrumProduct

(

const Config &

c = Config()

)

Definition at line 37 of file SpectrumProduct.cxx.

CLAM::SpectrumProduct::~SpectrumProduct

(

)

[virtual]

Definition at line 47 of file SpectrumProduct.cxx.

---

Member Function Documentation

bool CLAM::SpectrumProduct::Do	(	Spectrum &	in1,
		Spectrum &	in2,
		Spectrum &	out
	)

Definition at line 51 of file SpectrumProduct.cxx.

bool CLAM::SpectrumProduct::Do

(

)

[virtual]

Supervised mode execution method (using ports).

Returns:

A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 99 of file SpectrumProduct.cxx.

bool CLAM::SpectrumProduct::MayDisableExecution

(

)

const [inline]

Definition at line 136 of file SpectrumProduct.hxx.

bool CLAM::SpectrumProduct::SetPrototypes

(

)

Definition at line 306 of file SpectrumProduct.cxx.

bool CLAM::SpectrumProduct::SetPrototypes	(	const Spectrum &	in1,
		const Spectrum &	in2,
		const Spectrum &	out
	)

Change the internal type state.

Apart from prototype configuration, the Size, Scale and SpectralRange attributes of each Spectrum are also checked.

Definition at line 120 of file SpectrumProduct.cxx.

bool CLAM::SpectrumProduct::UnsetPrototypes

(

)

Definition at line 312 of file SpectrumProduct.cxx.

---

Member Data Documentation

InPort<Spectrum> CLAM::SpectrumProduct::mInput1

Definition at line 110 of file SpectrumProduct.hxx.

InPort<Spectrum> CLAM::SpectrumProduct::mInput2

Definition at line 111 of file SpectrumProduct.hxx.

OutPort<Spectrum> CLAM::SpectrumProduct::mOutput

Definition at line 112 of file SpectrumProduct.hxx.

---

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

• SpectrumProduct.hxx
• SpectrumProduct.cxx