kome::objects::Peaks2DArray Class Reference

2-dimentional peaks array More...

#include <Peaks2DArray.h>

Inheritance diagram for kome::objects::Peaks2DArray:

Public Member Functions
	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

Static Protected Member Functions
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...

Protected Attributes
std::vector< Peak2DElement * >	m_peaks

Detailed Description

2-dimentional peaks array

Definition at line 28 of file Peaks2DArray.h.

Member Function Documentation

unsigned int kome::objects::Peaks2DArray::getNumberOfPeaks

(

)

gets the number of peaks

Returns

the number of peaks

Definition at line 40 of file Peaks2DArray.cpp.

                                            {
    return m_peaks.size();
}

Peak2DElement * kome::objects::Peaks2DArray::getPeak

(

const unsigned int

idx

)

gets peak element

Parameters

[in]

idx

peak index

Returns

peak elment (If NULL, the index is illegal.)

Definition at line 45 of file Peaks2DArray.cpp.

                                                             {
    if( idx >= m_peaks.size() ) {
        return NULL;
    }
    return m_peaks[ idx ];
}

Peak2DElement * kome::objects::Peaks2DArray::getPeakById

(

int

id

)

gets peak element by peak2d id

Parameters

[in]

id

peak2d id

Returns

peak2d element objects

Definition at line 125 of file Peaks2DArray.cpp.

                                                {
    for( unsigned int i=0; i < m_peaks.size(); i++ ){
        if( m_peaks[i]->getId() == id ){
            return m_peaks[i];
        }
    }
    return NULL;
}

int kome::objects::Peaks2DArray::issueId

(

Peak2DElement *

peak2dElement

)

to issue the peak2d id

Parameters

[in]

peak2dElement

peak element objects

Returns

peak2d id

Definition at line 117 of file Peaks2DArray.cpp.

                                                       {
    if( peak2dElement != NULL && peak2dElement->getId() > 0 ){
        return peak2dElement->getId()+1;
    }
    return 0;
}

Here is the call graph for this function:

static bool kome::objects::Peaks2DArray::lessIntensity ( Peak2DElement *  p0, Peak2DElement *  p1, bool  desc  )

staticprotected

compares peaks to sort by intensity

Parameters

[in]	p0	peak object to be compared
[in]	p1	peak object to compare
[in]	desc	descenfing order flag

Returns

If true, p0 sorts before p1.

Definition at line 108 of file Peaks2DArray.cpp.

                                                                                  {
    if( desc ) {
        return ( p0->getIntensity() > p1->getIntensity() );
    }
    return ( p0->getIntensity() < p1->getIntensity() );
}

Here is the call graph for this function:

static bool kome::objects::Peaks2DArray::lessMz ( Peak2DElement *  p0, Peak2DElement *  p1, bool  desc  )

staticprotected

compares peaks to sort by m/z

Parameters

[in]	p0	peak object to be compared
[in]	p1	peak object to compare
[in]	desc	descenfing order flag

Returns

If true, p0 sorts before p1.

Definition at line 100 of file Peaks2DArray.cpp.

                                                                           {
    if( desc ) {
        return ( p0->getMz() > p1->getMz() );
    }
    return ( p0->getMz() < p1->getMz() );
}

Here is the call graph for this function:

static bool kome::objects::Peaks2DArray::lessRt ( Peak2DElement *  p0, Peak2DElement *  p1, bool  desc  )

staticprotected

compares peaks to sort by RT

Parameters

[in]	p0	peak object to be compared
[in]	p1	peak object to compare
[in]	desc	descending order flag

Returns

If true, p0 sorts before p1.

Definition at line 92 of file Peaks2DArray.cpp.

                                                                           {
    if( desc ) {
        return ( p0->getRt() > p1->getRt() );
    }
    return ( p0->getRt() < p1->getRt() );
}

Here is the call graph for this function:

int kome::objects::Peaks2DArray::searchPeak

(

Peak2DElement *

peak

)

searches peak

Parameters

[in]

peak

peak object to be searched

Returns

peak index (If specified peak is not found, this method returns negative number.)

Definition at line 53 of file Peaks2DArray.cpp.

                                                  {
    int idx = -1;
    for( unsigned int i = 0; i < m_peaks.size() && idx < 0; i++ ) {
        if( peak == m_peaks[ i ] ) {
            idx = (int)i;
        }
    }

    return idx;
}

void kome::objects::Peaks2DArray::sortByMz

(

const bool

desc

)

sorts peaks by m/z

Parameters

[in]

desc

descending order flag

Definition at line 74 of file Peaks2DArray.cpp.

                                             {
    std::sort(
        m_peaks.begin(),
        m_peaks.end(),
        boost::bind( lessMz, _1, _2, desc )
    );
}

Here is the call graph for this function:

void kome::objects::Peaks2DArray::sortByRt

(

const bool

desc

)

sorts peaks by RT

Parameters

[in]

desc

descending order flag

Definition at line 65 of file Peaks2DArray.cpp.

                                             {
    std::sort(
        m_peaks.begin(),
        m_peaks.end(),
        boost::bind( lessRt, _1, _2, desc )
    );
}

Here is the call graph for this function:

Member Data Documentation

std::vector< Peak2DElement* > kome::objects::Peaks2DArray::m_peaks

protected

peaks array

Definition at line 44 of file Peaks2DArray.h.

---

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

• DataObjects/Peaks2DArray.h
• DataObjects/Peaks2DArray.cpp