CLAM::SinTracking Class Reference

Processing which does sinusoidal peak tracking (or continuation). More...

#include <SinTracking.hxx>

List of all members.

Public Member Functions
	SinTracking ()
	SinTracking (const SinTrackingConfig &c)
	~SinTracking ()
const ProcessingConfig &	GetConfig () const
	Configuration getter.
bool	Do (const SpectralPeakArray &iPeakArray, SpectralPeakArray &oPeakArray)
bool	Do (void)
	Supervised mode execution method (using ports).
int	GetnTracks () const

---

Detailed Description

Processing which does sinusoidal peak tracking (or continuation).

In order for SinTracking to produce meaningful results, it must be called repeatively using SpectralPeakArrays generated from the different 'frames' of the same input material (ie, if you want to track two different sources, you must use two seperate SinTrackings).

Definition at line 62 of file SinTracking.hxx.

---

Constructor & Destructor Documentation

CLAM::SinTracking::SinTracking

(

)

Definition at line 26 of file SinTracking.cxx.

CLAM::SinTracking::SinTracking

(

const SinTrackingConfig &

c

)

Definition at line 34 of file SinTracking.cxx.

CLAM::SinTracking::~SinTracking

(

)

Definition at line 43 of file SinTracking.cxx.

---

Member Function Documentation

bool CLAM::SinTracking::Do

(

void

)

[virtual]

Supervised mode execution method (using ports).

Returns:

A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 89 of file SinTracking.cxx.

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

bool CLAM::SinTracking::Do	(	const SpectralPeakArray &	iPeakArray,
		SpectralPeakArray &	oPeakArray
	)

Definition at line 97 of file SinTracking.cxx.

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

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

int CLAM::SinTracking::GetnTracks

(

)

const [inline]

Definition at line 90 of file SinTracking.hxx.

---

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

• SinTracking.hxx
• SinTracking.cxx