AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param Class Reference

#include <OpenMS/KERNEL/AreaIterator.h>

Collaboration diagram for AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param:

Public Member Functions
	Param (SpectrumIteratorType first, SpectrumIteratorType begin, SpectrumIteratorType end, uint8_t ms_level)
	C'tor with mandatory parameters.
Param &	operator= (const Param &rhs)=default
	Assignment operator.

Static Public Member Functions
static Param	end ()
	return the end-iterator

Private Attributes
friend	AreaIterator

Named parameter idiom for chaining
SpectrumIteratorType	first_
	Iterator to the first scan of the map (needed to calculate the index)
SpectrumIteratorType	current_scan_
	Iterator to the current spectrum.
SpectrumIteratorType	end_scan_
	Past-the-end iterator of spectra.
PeakIteratorType	current_peak_
	Iterator to the current peak.
PeakIteratorType	end_peak_
	Past-the-end iterator of peaks in the current spectrum.
CoordinateType	low_mz_ = std::numeric_limits<CoordinateType>::lowest()
	low m/z boundary
CoordinateType	high_mz_ = std::numeric_limits<CoordinateType>::max()
	high m/z boundary
CoordinateType	low_im_ = std::numeric_limits<CoordinateType>::lowest()
	low mobility boundary
CoordinateType	high_im_ = std::numeric_limits<CoordinateType>::max()
	high mobility boundary
int8_t	ms_level_ {}
	Only scans of this MS level are iterated over.
bool	is_end_ = false
	Flag that indicates that this iterator is the end iterator.
Param &	lowMZ (CoordinateType low_mz)
	low m/z boundary
Param &	highMZ (CoordinateType high_mz)
	high m/z boundary
Param &	lowIM (CoordinateType low_im)
	low ion mobility boundary
Param &	highIM (CoordinateType high_im)
	high ion mobility boundary
Param &	msLevel (int8_t ms_level)
	Only scans of this MS level are iterated over.
	Param ()=default
	only used internally for end()

Detailed Description

template<class ValueT, class ReferenceT, class PointerT, class SpectrumIteratorT, class PeakIteratorT>
class OpenMS::Internal::AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param

Parameters for the AreaIterator Required values must be set in the C'tor. Optional values can be set via member functions (which allow chaining).

Constructor & Destructor Documentation

Param() [1/2]

template<class ValueT , class ReferenceT , class PointerT , class SpectrumIteratorT , class PeakIteratorT >

Param ( SpectrumIteratorType  first, SpectrumIteratorType  begin, SpectrumIteratorType  end, uint8_t  ms_level  )

inline

C'tor with mandatory parameters.

Parameters

first	The very first spectrum of the experiment
begin	The first spectrum with a valid RT/IM time
end	The last spectrum with a valid RT/IM time
ms_level	Only peaks from spectra with this ms_level are used

Param() [2/2]

template<class ValueT , class ReferenceT , class PointerT , class SpectrumIteratorT , class PeakIteratorT >

Param ( )

privatedefault

only used internally for end()

Member Function Documentation

end()

template<class ValueT , class ReferenceT , class PointerT , class SpectrumIteratorT , class PeakIteratorT >

static Param end ( )

inlinestatic

return the end-iterator

References AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param::is_end_.

highIM()

template<class ValueT , class ReferenceT , class PointerT , class SpectrumIteratorT , class PeakIteratorT >

Param & highIM ( CoordinateType  high_im )

inline

high ion mobility boundary

References AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param::high_im_.

highMZ()

template<class ValueT , class ReferenceT , class PointerT , class SpectrumIteratorT , class PeakIteratorT >

Param & highMZ ( CoordinateType  high_mz )

inline

high m/z boundary

References AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param::high_mz_.

lowIM()

template<class ValueT , class ReferenceT , class PointerT , class SpectrumIteratorT , class PeakIteratorT >

Param & lowIM ( CoordinateType  low_im )

inline

low ion mobility boundary

References AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param::low_im_.

lowMZ()

template<class ValueT , class ReferenceT , class PointerT , class SpectrumIteratorT , class PeakIteratorT >

Param & lowMZ ( CoordinateType  low_mz )

inline

low m/z boundary

References AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param::low_mz_.

msLevel()

template<class ValueT , class ReferenceT , class PointerT , class SpectrumIteratorT , class PeakIteratorT >

Param & msLevel ( int8_t  ms_level )

inline

Only scans of this MS level are iterated over.

References AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param::ms_level_.

operator=()

template<class ValueT , class ReferenceT , class PointerT , class SpectrumIteratorT , class PeakIteratorT >

Param & operator= ( const Param &  rhs )

default

Assignment operator.

Member Data Documentation

AreaIterator

template<class ValueT , class ReferenceT , class PointerT , class SpectrumIteratorT , class PeakIteratorT >

friend AreaIterator

private

current_peak_

template<class ValueT , class ReferenceT , class PointerT , class SpectrumIteratorT , class PeakIteratorT >

PeakIteratorType current_peak_

protected

Iterator to the current peak.

Referenced by AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::getPeakIndex(), AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::nextScan_(), AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::operator*(), AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::operator++(), AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::operator->(), and AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::operator==().

current_scan_

template<class ValueT , class ReferenceT , class PointerT , class SpectrumIteratorT , class PeakIteratorT >

SpectrumIteratorType current_scan_

protected

Iterator to the current spectrum.

Referenced by AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::getDriftTime(), AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::getPeakIndex(), AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::getRT(), AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::getSpectrum(), AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::nextScan_(), and AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::operator++().

end_peak_

template<class ValueT , class ReferenceT , class PointerT , class SpectrumIteratorT , class PeakIteratorT >

PeakIteratorType end_peak_

protected

Past-the-end iterator of peaks in the current spectrum.

Referenced by AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::nextScan_(), and AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::operator++().

end_scan_

template<class ValueT , class ReferenceT , class PointerT , class SpectrumIteratorT , class PeakIteratorT >

SpectrumIteratorType end_scan_

protected

Past-the-end iterator of spectra.

Referenced by AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::nextScan_().

first_

template<class ValueT , class ReferenceT , class PointerT , class SpectrumIteratorT , class PeakIteratorT >

SpectrumIteratorType first_

protected

Iterator to the first scan of the map (needed to calculate the index)

Referenced by AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::getPeakIndex().

high_im_

template<class ValueT , class ReferenceT , class PointerT , class SpectrumIteratorT , class PeakIteratorT >

CoordinateType high_im_ = std::numeric_limits<CoordinateType>::max()

protected

high mobility boundary

Referenced by AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param::highIM(), and AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::nextScan_().

high_mz_

template<class ValueT , class ReferenceT , class PointerT , class SpectrumIteratorT , class PeakIteratorT >

CoordinateType high_mz_ = std::numeric_limits<CoordinateType>::max()

protected

high m/z boundary

Referenced by AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param::highMZ(), and AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::nextScan_().

is_end_

template<class ValueT , class ReferenceT , class PointerT , class SpectrumIteratorT , class PeakIteratorT >

bool is_end_ = false

protected

Flag that indicates that this iterator is the end iterator.

Referenced by AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param::end(), AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::getPeakIndex(), AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::nextScan_(), AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::operator++(), AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::operator=(), and AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::operator==().

low_im_

template<class ValueT , class ReferenceT , class PointerT , class SpectrumIteratorT , class PeakIteratorT >

CoordinateType low_im_ = std::numeric_limits<CoordinateType>::lowest()

protected

low mobility boundary

Referenced by AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param::lowIM(), and AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::nextScan_().

low_mz_

template<class ValueT , class ReferenceT , class PointerT , class SpectrumIteratorT , class PeakIteratorT >

CoordinateType low_mz_ = std::numeric_limits<CoordinateType>::lowest()

protected

low m/z boundary

Referenced by AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param::lowMZ(), and AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::nextScan_().

ms_level_

template<class ValueT , class ReferenceT , class PointerT , class SpectrumIteratorT , class PeakIteratorT >

int8_t ms_level_ {}

protected

Only scans of this MS level are iterated over.

Referenced by AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param::msLevel(), and AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::nextScan_().