CLAM::SpectrumSubstracter2 Class Reference

This calss performs the substraction of two Spectrum processing data objects. More...

#include <SpectrumSubstracter2.hxx>

List of all members.

Public Member Functions
	SpectrumSubstracter2 ()
	SpectrumSubstracter2 (const SpecSubstracter2Config &c)
	~SpectrumSubstracter2 ()
const ProcessingConfig &	GetConfig () const
	Configuration getter.
bool	Do (void)
	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

---

Detailed Description

This calss performs the substraction of two 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.
• 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:

See also:

SpectrumSubstracter2

Definition at line 60 of file SpectrumSubstracter2.hxx.

---

Constructor & Destructor Documentation

CLAM::SpectrumSubstracter2::SpectrumSubstracter2

(

)

Definition at line 37 of file SpectrumSubstracter2.cxx.

CLAM::SpectrumSubstracter2::SpectrumSubstracter2

(

const SpecSubstracter2Config &

c

)

Definition at line 47 of file SpectrumSubstracter2.cxx.

CLAM::SpectrumSubstracter2::~SpectrumSubstracter2

(

)

[inline]

Definition at line 119 of file SpectrumSubstracter2.hxx.

---

Member Function Documentation

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

Definition at line 75 of file SpectrumSubstracter2.cxx.

bool CLAM::SpectrumSubstracter2::Do

(

void

)

[virtual]

Supervised mode execution method (using ports).

Returns:

A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 123 of file SpectrumSubstracter2.cxx.

Referenced by CLAM::SMSAnalysisCore::Do().

const ProcessingConfig& CLAM::SpectrumSubstracter2::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 121 of file SpectrumSubstracter2.hxx.

bool CLAM::SpectrumSubstracter2::MayDisableExecution

(

)

const [inline]

Definition at line 141 of file SpectrumSubstracter2.hxx.

bool CLAM::SpectrumSubstracter2::SetPrototypes

(

)

Definition at line 319 of file SpectrumSubstracter2.cxx.

bool CLAM::SpectrumSubstracter2::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 138 of file SpectrumSubstracter2.cxx.

bool CLAM::SpectrumSubstracter2::UnsetPrototypes

(

)

Definition at line 326 of file SpectrumSubstracter2.cxx.

References CLAM_ASSERT.

---

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

• SpectrumSubstracter2.hxx
• SpectrumSubstracter2.cxx