AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT > Class Template Reference

Forward iterator for an area of peaks in an experiment. More...

#include <OpenMS/KERNEL/AreaIterator.h>

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

Classes
class	Param

Public Types
typedef double	CoordinateType
typedef ValueT	PeakType
typedef SpectrumIteratorT	SpectrumIteratorType
typedef PeakIteratorT	PeakIteratorType
using	SpectrumT = typename std::iterator_traits< SpectrumIteratorType >::value_type

Typedefs for STL compliance, these replace std::iterator
typedef std::forward_iterator_tag	iterator_category
	The iterator's category type.
typedef ValueT	value_type
	The iterator's value type.
typedef ReferenceT	reference
	The reference type as returned by operator*()
typedef PointerT	pointer
	The pointer type as returned by operator->()
typedef unsigned int	difference_type
	The difference type.
Param	p_
	holds spectra iterators and area limits
	AreaIterator (const Param &p)
	Constructor for the begin iterator.
	AreaIterator ()
	Default constructor (for the end iterator)
	~AreaIterator ()=default
	Destructor.
	AreaIterator (const AreaIterator &rhs)=default
	Copy constructor.
AreaIterator &	operator= (const AreaIterator &rhs)
	Assignment operator.
bool	operator== (const AreaIterator &rhs) const
	Test for equality.
bool	operator!= (const AreaIterator &rhs) const
	Test for inequality.
AreaIterator &	operator++ ()
	Step forward by one (prefix operator)
AreaIterator	operator++ (int)
	Step forward by one (postfix operator)
reference	operator* () const
	Dereferencing of this pointer yields the underlying peak.
pointer	operator-> () const
	Dereferencing of this pointer yields the underlying peak.
CoordinateType	getRT () const
	returns the retention time of the current scan
CoordinateType	getDriftTime () const
	returns the ion mobility time of the current scan
const SpectrumT &	getSpectrum () const
	returns the current scan into which the iterator points
PeakIndex	getPeakIndex () const
	returns the PeakIndex corresponding to the current iterator position
void	nextScan_ ()
	advances the iterator to the next valid peak in the next valid spectrum

Detailed Description

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

Forward iterator for an area of peaks in an experiment.

This iterator allows us to move through the data structure in a linear manner i.e. we don't need to jump to the next spectrum manually.

Ion mobility can also be filtered for: the low/high range for IM are used to skip over spectra in the given RT range whose drift time is not within the given range. I.e. the RT range could contain multiple IM frames.

Note

This iterator iterates over spectra with same MS level as the MS level of the begin() spectrum in Param! You can explicitly set another MS level as well.

Member Typedef Documentation

CoordinateType

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

typedef double CoordinateType

difference_type

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

typedef unsigned int difference_type

The difference type.

iterator_category

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

typedef std::forward_iterator_tag iterator_category

The iterator's category type.

PeakIteratorType

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

typedef PeakIteratorT PeakIteratorType

PeakType

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

typedef ValueT PeakType

pointer

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

typedef PointerT pointer

The pointer type as returned by operator->()

reference

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

typedef ReferenceT reference

The reference type as returned by operator*()

SpectrumIteratorType

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

typedef SpectrumIteratorT SpectrumIteratorType

SpectrumT

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

using SpectrumT = typename std::iterator_traits<SpectrumIteratorType>::value_type

value_type

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

typedef ValueT value_type

The iterator's value type.

Constructor & Destructor Documentation

AreaIterator() [1/3]

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

AreaIterator ( const Param &  p )

inlineexplicit

Constructor for the begin iterator.

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

AreaIterator() [2/3]

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

AreaIterator ( )

inline

Default constructor (for the end iterator)

~AreaIterator()

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

~AreaIterator ( )

default

Destructor.

AreaIterator() [3/3]

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

AreaIterator ( const AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT > &  rhs )

default

Copy constructor.

Member Function Documentation

getDriftTime()

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

CoordinateType getDriftTime ( ) const

inline

returns the ion mobility time of the current scan

References AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param::current_scan_, and AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::p_.

Referenced by DimIM::map().

getPeakIndex()

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

PeakIndex getPeakIndex ( ) const

inline

returns the PeakIndex corresponding to the current iterator position

References AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param::current_peak_, AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param::current_scan_, AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param::first_, AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param::is_end_, and AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::p_.

getRT()

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

CoordinateType getRT ( ) const

inline

returns the retention time of the current scan

References AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param::current_scan_, and AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::p_.

Referenced by DimRT::map().

getSpectrum()

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

const SpectrumT & getSpectrum ( ) const

inline

returns the current scan into which the iterator points

References AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param::current_scan_, and AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::p_.

nextScan_()

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

void nextScan_ ( )

inlineprivate

advances the iterator to the next valid peak in the next valid spectrum

References AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param::current_peak_, AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param::current_scan_, AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param::end_peak_, AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param::end_scan_, AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param::high_im_, AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param::high_mz_, AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param::is_end_, AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param::low_im_, AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param::low_mz_, AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param::ms_level_, and AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::p_.

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

operator!=()

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

bool operator!= ( const AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT > &  rhs ) const

inline

Test for inequality.

operator*()

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

reference operator* ( ) const

inline

Dereferencing of this pointer yields the underlying peak.

References AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param::current_peak_, and AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::p_.

operator++() [1/2]

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

AreaIterator & operator++ ( )

inline

Step forward by one (prefix operator)

References AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param::current_peak_, AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param::current_scan_, AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param::end_peak_, AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param::is_end_, AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::nextScan_(), and AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::p_.

operator++() [2/2]

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

AreaIterator operator++ ( int  )

inline

Step forward by one (postfix operator)

operator->()

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

pointer operator-> ( ) const

inline

Dereferencing of this pointer yields the underlying peak.

References AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::Param::current_peak_, and AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::p_.

operator=()

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

AreaIterator & operator= ( const AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT > &  rhs )

inline

Assignment operator.

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

operator==()

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

bool operator== ( const AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT > &  rhs ) const

inline

Test for equality.

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

Member Data Documentation

p_

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

Param p_

private

holds spectra iterators and area limits

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_(), AreaIterator< ValueT, ReferenceT, PointerT, SpectrumIteratorT, PeakIteratorT >::operator*(), 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==().