default alignment class More...

#include <Alignment.h>

Inheritance diagram for kome::operation::DefaultAlignment:

Collaboration diagram for kome::operation::DefaultAlignment:

Public Member Functions
	DefaultAlignment ()
	constructor

virtual	~DefaultAlignment ()
	destructor

Public Member Functions inherited from kome::operation::Alignment
	Alignment ()
	constructor

virtual	~Alignment ()
	destructor

void	prepare (kome::objects::Sample standard, kome::objects::Sample treatment, kome::core::Progress *progress)
	prepares alignment More...

double	convertRt (const double rt, const double mz)
	gets aligned RT More...

double	convertMz (const double rt, const double mz)
	gets aligned m/z More...

double	invertRt (const double rt, const double mz)
	gets RT before alignment More...

double	invertMz (const double rt, const double mz)
	gets m/z before alignment More...

Protected Member Functions
virtual void	onPrepare (kome::objects::Sample standard, kome::objects::Sample treatment, kome::core::Progress *progress)
	This method is called by prepare method. (override method) More...

virtual double	onConvertRt (const double rt, const double mz)
	This method is called by convertRt method. (override method) More...

virtual double	onConvertMz (const double rt, const double mz)
	This method is called by convertMz method. (override method) More...

virtual double	onInvertRt (const double rt, const double mz)
	This method is called by invertRt method. (override method) More...

virtual double	onInvertMz (const double rt, const double mz)
	This method is called by invertMz method. (override method) More...

Protected Member Functions inherited from kome::operation::Alignment
kome::objects::Sample *	getStandardSample ()
	gets the standard sample More...

kome::objects::Sample *	getTreatmentSample ()
	gets the treatment sample More...

Additional Inherited Members
Static Public Member Functions inherited from kome::operation::Alignment
static Alignment &	getDefaultAlignment ()
	gets default alignment More...

Protected Attributes inherited from kome::operation::Alignment
kome::objects::Sample *	m_standard

kome::objects::Sample *	m_treatment

Detailed Description

default alignment class

Definition at line 167 of file Alignment.h.

Member Function Documentation

double kome::operation::DefaultAlignment::onConvertMz	(	const double	rt,
		const double	mz
	)

protectedvirtual

This method is called by convertMz method. (override method)

Parameters

[in]	rt	RT before alignment
[in]	mz	m/z before alignment

Returns: aligned m/z

Implements kome::operation::Alignment.

Definition at line 154 of file Alignment.cpp.

                                                                        {
     return mz;
 }

double kome::operation::DefaultAlignment::onConvertRt	(	const double	rt,
		const double	mz
	)

protectedvirtual

This method is called by convertRt method. (override method)

Parameters

[in]	rt	RT before alignment
[in]	mz	m/z before alignment

Returns: aligned RT

Implements kome::operation::Alignment.

Definition at line 149 of file Alignment.cpp.

                                                                        {
     return rt;
 }

double kome::operation::DefaultAlignment::onInvertMz	(	const double	rt,
		const double	mz
	)

protectedvirtual

This method is called by invertMz method. (override method)

Parameters

[in]	rt	aligned RT
[in]	mz	aligned m/z

Returns: m/z before alignemtn

Implements kome::operation::Alignment.

Definition at line 164 of file Alignment.cpp.

                                                                       {
     return mz;
 }

double kome::operation::DefaultAlignment::onInvertRt	(	const double	rt,
		const double	mz
	)

protectedvirtual

This method is called by invertRt method. (override method)

Parameters

[in]	rt	aligned RT
[in]	mz	aligned m/z

Returns: RT before alignment

Implements kome::operation::Alignment.

Definition at line 159 of file Alignment.cpp.

                                                                       {
     return rt;
 }

void kome::operation::DefaultAlignment::onPrepare	(	kome::objects::Sample *	standard,
		kome::objects::Sample *	treatment,
		kome::core::Progress *	progress
	)

protectedvirtual

This method is called by prepare method. (override method)

Parameters

[in]	standard	standard sample
[in]	treatment	treatment sample
[in,out]	progress	the object to show the progress

Implements kome::operation::Alignment.

Definition at line 144 of file Alignment.cpp.

                                                                                                                         {
     // nothing to do
 }

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

DataOperation/Alignment.h
DataOperation/Alignment.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation