2-dimentional peaks cluster More...

#include <PeaksCluster2D.h>

Inheritance diagram for kome::objects::PeaksCluster2D:

Collaboration diagram for kome::objects::PeaksCluster2D:

Public Member Functions
	PeaksCluster2D ()
	constructor

virtual	~PeaksCluster2D ()
	destructor

void	setRt (const double rt)
	sets RT More...

double	getRt ()
	gets RT More...

void	setRtRange (const double startRt, const double endRt)
	sets RT range More...

double	getStartRt ()
	gets start RT More...

double	getEndRt ()
	gets end RT More...

void	setMz (const double mz)
	sets m/z More...

double	getMz ()
	gets m/z More...

void	setMzRange (const double startMz, const double endMz)
	sets m/z range More...

double	getStartMz ()
	gets start m/z More...

double	getEndMz ()
	gets end m/z More...

void	setIntensity (const double intensity)
	sets intensity More...

double	getIntensity ()
	gets intensity More...

void	setCharge (const int charge)
	sets charge More...

int	getCharge ()
	gets charge More...

void	addPeak (Peak2DElement *peak)
	adds peak More...

void	removePeak (Peak2DElement *peak)
	removes peak More...

void	removePeak (unsigned int idx)
	removes peak More...

void	clearPeaks ()
	clears peaks

Public Member Functions inherited from kome::objects::Peaks2DArray
	Peaks2DArray ()
	constructor

virtual	~Peaks2DArray ()
	destructor

int	issueId (Peak2DElement *peak2dElement)
	to issue the peak2d id More...

Peak2DElement *	getPeakById (int id)
	gets peak element by peak2d id More...

unsigned int	getNumberOfPeaks ()
	gets the number of peaks More...

Peak2DElement *	getPeak (const unsigned int idx)
	gets peak element More...

int	searchPeak (Peak2DElement *peak)
	searches peak More...

void	sortByRt (const bool desc)
	sorts peaks by RT More...

void	sortByMz (const bool desc)
	sorts peaks by m/z More...

void	sortByIntensity (const bool desc)
	sorts peaks by intensity param desc descending order flag

Protected Member Functions
void	update ()
	updates member values

Protected Attributes
double	m_rt

bool	m_rtFlg

double	m_startRt

double	m_endRt

bool	m_rtRangeFlg

double	m_mz

bool	m_mzFlg

double	m_startMz

double	m_endMz

bool	m_mzRangeFlg

double	m_intensity

bool	m_intFlg

int	m_charge

Protected Attributes inherited from kome::objects::Peaks2DArray
std::vector< Peak2DElement * >	m_peaks

Additional Inherited Members
Static Protected Member Functions inherited from kome::objects::Peaks2DArray
static bool	lessRt (Peak2DElement p0, Peak2DElement p1, bool desc)
	compares peaks to sort by RT More...

static bool	lessMz (Peak2DElement p0, Peak2DElement p1, bool desc)
	compares peaks to sort by m/z More...

static bool	lessIntensity (Peak2DElement p0, Peak2DElement p1, bool desc)
	compares peaks to sort by intensity More...

Detailed Description

2-dimentional peaks cluster

Definition at line 28 of file PeaksCluster2D.h.

Member Function Documentation

void kome::objects::PeaksCluster2D::addPeak ( Peak2DElement * peak )

adds peak

Parameters

[in] peak peak to be added

Definition at line 136 of file PeaksCluster2D.cpp.

                                                   {
     // search peak
     int idx = searchPeak( peak );
     if( idx >= 0 || peak == NULL ) {
         return;
     }
 
     // add
     m_peaks.push_back( peak );
     peak->setCluster( this );
 
     // update
     update();
 }

Here is the call graph for this function:

int kome::objects::PeaksCluster2D::getCharge ( )

gets charge

Returns: charge

Definition at line 131 of file PeaksCluster2D.cpp.

                               {
     return m_charge;
 }

double kome::objects::PeaksCluster2D::getEndMz ( )

gets end m/z

Returns: end m/z

Definition at line 110 of file PeaksCluster2D.cpp.

                                 {
     return m_endMz;
 }

double kome::objects::PeaksCluster2D::getEndRt ( )

gets end RT

Returns: end RT

Definition at line 82 of file PeaksCluster2D.cpp.

                                 {
     return m_endRt;
 }

double kome::objects::PeaksCluster2D::getIntensity ( )

gets intensity

Returns: intensity

Definition at line 121 of file PeaksCluster2D.cpp.

                                     {
     return m_intensity;
 }

double kome::objects::PeaksCluster2D::getMz ( )

gets m/z

Returns: m/z

Definition at line 93 of file PeaksCluster2D.cpp.

                              {
     return m_mz;
 }

double kome::objects::PeaksCluster2D::getRt ( )

gets RT

Returns: RT

Definition at line 65 of file PeaksCluster2D.cpp.

                              {
     return m_rt;
 }

double kome::objects::PeaksCluster2D::getStartMz ( )

gets start m/z

Returns: start m/z

Definition at line 105 of file PeaksCluster2D.cpp.

                                   {
     return m_startMz;
 }

double kome::objects::PeaksCluster2D::getStartRt ( )

gets start RT

Returns: start RT

Definition at line 77 of file PeaksCluster2D.cpp.

                                   {
     return m_startRt;
 }

void kome::objects::PeaksCluster2D::removePeak ( Peak2DElement * peak )

removes peak

Parameters

[in] peak peak to be removed

Definition at line 152 of file PeaksCluster2D.cpp.

                                                      {
     // index
     int idx = searchPeak( peak );
 
     // remove
     if( idx >= 0 ) {
         removePeak( idx );
     }
 }

Here is the call graph for this function:

void kome::objects::PeaksCluster2D::removePeak ( unsigned int idx )

removes peak

Parameters

[in] idx peak index

Definition at line 163 of file PeaksCluster2D.cpp.

                                                         {
     // check the index
     if( idx >= m_peaks.size() ) {
         return;
     }
 
     // peak
     kome::objects::Peak2DElement* peak = m_peaks[ idx ];
 
     // remove
     m_peaks.erase( m_peaks.begin() + idx );
 
     // set cluster
     peak->setCluster( NULL );
 
     // update
     update();
 }

Here is the call graph for this function:

void kome::objects::PeaksCluster2D::setCharge ( const int charge )

sets charge

Parameters

[in] charge charge

Definition at line 126 of file PeaksCluster2D.cpp.

                                                  {
     m_charge = charge;
 }

void kome::objects::PeaksCluster2D::setIntensity ( const double intensity )

sets intensity

Parameters

[in] intensity intensity

Definition at line 115 of file PeaksCluster2D.cpp.

                                                           {
     m_intensity = intensity;
     m_intFlg = true;
 }

void kome::objects::PeaksCluster2D::setMz ( const double mz )

sets m/z

Parameters

[in] mz m/z

Definition at line 87 of file PeaksCluster2D.cpp.

                                             {
     m_mz = mz;
     m_mzFlg = true;
 }

void kome::objects::PeaksCluster2D::setMzRange	(	const double	startMz,
		const double	endMz
	)

sets m/z range

Parameters

[in]	startMz	start m/z
[in]	endMz	endMz

Definition at line 98 of file PeaksCluster2D.cpp.

                                                                           {
     m_startMz = startMz;
     m_endMz = endMz;
     m_mzRangeFlg = true;
 }

void kome::objects::PeaksCluster2D::setRt ( const double rt )

sets RT

Parameters

[in] rt RT

Definition at line 59 of file PeaksCluster2D.cpp.

                                             {
     m_rt = rt;
     m_rtFlg = true;
 }

void kome::objects::PeaksCluster2D::setRtRange	(	const double	startRt,
		const double	endRt
	)

sets RT range

Parameters

[in]	startRt	start RT
[in]	endRt	end RT

Definition at line 70 of file PeaksCluster2D.cpp.

                                                                           {
     m_startRt = startRt;
     m_endRt = endRt;
     m_rtRangeFlg = true;
 }

Member Data Documentation

int kome::objects::PeaksCluster2D::m_charge

protected

charge

Definition at line 73 of file PeaksCluster2D.h.

double kome::objects::PeaksCluster2D::m_endMz

protected

end m/z

Definition at line 63 of file PeaksCluster2D.h.

double kome::objects::PeaksCluster2D::m_endRt

protected

end RT

Definition at line 51 of file PeaksCluster2D.h.

double kome::objects::PeaksCluster2D::m_intensity

protected

intensity

Definition at line 68 of file PeaksCluster2D.h.

bool kome::objects::PeaksCluster2D::m_intFlg

protected

intensity settled flag

Definition at line 70 of file PeaksCluster2D.h.

double kome::objects::PeaksCluster2D::m_mz

protected

m/z

Definition at line 56 of file PeaksCluster2D.h.

bool kome::objects::PeaksCluster2D::m_mzFlg

protected

m/z settled flag

Definition at line 58 of file PeaksCluster2D.h.

bool kome::objects::PeaksCluster2D::m_mzRangeFlg

protected

m/z range settled flag

Definition at line 65 of file PeaksCluster2D.h.

double kome::objects::PeaksCluster2D::m_rt

protected

RT

Definition at line 44 of file PeaksCluster2D.h.

bool kome::objects::PeaksCluster2D::m_rtFlg

protected

RT settled flag

Definition at line 46 of file PeaksCluster2D.h.

bool kome::objects::PeaksCluster2D::m_rtRangeFlg

protected

RT range settled flag

Definition at line 53 of file PeaksCluster2D.h.

double kome::objects::PeaksCluster2D::m_startMz

protected

start m/z

Definition at line 61 of file PeaksCluster2D.h.

double kome::objects::PeaksCluster2D::m_startRt

protected

start RT

Definition at line 49 of file PeaksCluster2D.h.

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

DataObjects/PeaksCluster2D.h
DataObjects/PeaksCluster2D.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

Member Data Documentation