CLAM::SpectrumAdder Class Reference

This class performs the sum of N Spectrum processing data objects. More...

#include <SpectrumAdder.hxx>

List of all members.

Public Member Functions
	SpectrumAdder ()
	SpectrumAdder (const SpecAdderConfig &c)
	~SpectrumAdder ()
const ProcessingConfig &	GetConfig () const
	Configuration getter.
bool	Do (void)
	Supervised mode execution method (using ports).
bool	Do (Spectrum **inputs, Spectrum &out)
bool	SetPrototypes (Spectrum **inputs, const Spectrum &out)
	Change the internal type state.
bool	SetPrototypes ()
bool	UnsetPrototypes ()
bool	MayDisableExecution () const

---

Detailed Description

This class performs the sum of N Spectrum processing data objects.

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 attirbute (not the BPF), and the same scale.
• 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:

• Operation when any of the inputs has only a BPF attribute is not implemented.
• Operation when not all the scales are the same is not implemented.

Possible optimisations (which require more states):

• Implement direct sum 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).

Definition at line 76 of file SpectrumAdder.hxx.

---

Constructor & Destructor Documentation

CLAM::SpectrumAdder::SpectrumAdder

(

)

Definition at line 34 of file SpectrumAdder.cxx.

CLAM::SpectrumAdder::SpectrumAdder

(

const SpecAdderConfig &

c

)

Definition at line 45 of file SpectrumAdder.cxx.

CLAM::SpectrumAdder::~SpectrumAdder

(

)

Definition at line 130 of file SpectrumAdder.cxx.

---

Member Function Documentation

bool CLAM::SpectrumAdder::Do	(	Spectrum **	inputs,
		Spectrum &	out
	)

Definition at line 159 of file SpectrumAdder.cxx.

bool CLAM::SpectrumAdder::Do

(

void

)

[virtual]

Supervised mode execution method (using ports).

Returns:

A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 189 of file SpectrumAdder.cxx.

const ProcessingConfig& CLAM::SpectrumAdder::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::Processing.

Definition at line 140 of file SpectrumAdder.hxx.

bool CLAM::SpectrumAdder::MayDisableExecution

(

)

const [inline]

Definition at line 160 of file SpectrumAdder.hxx.

bool CLAM::SpectrumAdder::SetPrototypes

(

)

Definition at line 287 of file SpectrumAdder.cxx.

bool CLAM::SpectrumAdder::SetPrototypes	(	Spectrum **	inputs,
		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 196 of file SpectrumAdder.cxx.

bool CLAM::SpectrumAdder::UnsetPrototypes

(

)

Definition at line 292 of file SpectrumAdder.cxx.

References CLAM_ASSERT.

---

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

• SpectrumAdder.hxx
• SpectrumAdder.cxx