CLAM::SpectralPeakArrayAdder Class Reference

This class performs the interpolation of two SpectralPeakArray processing data objects. More...

#include <SpectralPeakArrayAdder.hxx>

List of all members.

Public Member Functions

 SpectralPeakArrayAdder ()
 SpectralPeakArrayAdder (const PeaksAddConfig &c)
 ~SpectralPeakArrayAdder ()
const ProcessingConfigGetConfig () const
 Configuration getter.
bool Do (void)
 Supervised mode execution method (using ports).
bool Do (const SpectralPeakArray &in1, const SpectralPeakArray &in2, SpectralPeakArray &out)

Public Attributes

InPort< SpectralPeakArraymIn1
 Ports.
InPort< SpectralPeakArraymIn2
OutPort< SpectralPeakArraymOut


Detailed Description

This class performs the interpolation of two SpectralPeakArray processing data objects.

Definition at line 48 of file SpectralPeakArrayAdder.hxx.


Constructor & Destructor Documentation

CLAM::SpectralPeakArrayAdder::SpectralPeakArrayAdder (  ) 

Definition at line 32 of file SpectralPeakArrayAdder.cxx.

References CLAM::Processing::Configure().

CLAM::SpectralPeakArrayAdder::SpectralPeakArrayAdder ( const PeaksAddConfig c  ) 

Definition at line 40 of file SpectralPeakArrayAdder.cxx.

References CLAM::Processing::Configure().

CLAM::SpectralPeakArrayAdder::~SpectralPeakArrayAdder (  )  [inline]

Definition at line 67 of file SpectralPeakArrayAdder.hxx.


Member Function Documentation

bool CLAM::SpectralPeakArrayAdder::Do ( const SpectralPeakArray in1,
const SpectralPeakArray in2,
SpectralPeakArray out 
)

This loop may be a little more efficient by ussing the buffers directly. But it would surely become muc less readable and much longer. TODO?

Definition at line 57 of file SpectralPeakArrayAdder.cxx.

References CLAM::SpectralPeakArray::AddSpectralPeak(), CLAM_ASSERT, CLAM_DEBUG_ASSERT, CLAM::SpectralPeakArray::GetFreq(), CLAM::SpectralPeakArray::GetnPeaks(), CLAM::SpectralPeakArray::GetSpectralPeak(), CLAM::Processing::IsRunning(), CLAM::SpectralPeakArray::SetnPeaks(), and CLAM::DynamicType::UpdateData().

bool CLAM::SpectralPeakArrayAdder::Do ( void   )  [inline, virtual]

Supervised mode execution method (using ports).

Returns:
A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 71 of file SpectralPeakArrayAdder.hxx.

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

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


Member Data Documentation

Ports.

Definition at line 76 of file SpectralPeakArrayAdder.hxx.

Definition at line 77 of file SpectralPeakArrayAdder.hxx.

Definition at line 78 of file SpectralPeakArrayAdder.hxx.


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

Generated on Tue Feb 22 09:53:29 2011 for CLAM-Development by  doxygen 1.5.9