PeakIndex#

class pyopenms.PeakIndex#

Bases: object

Cython implementation of _PeakIndex

Documentation is available at http://www.openms.de/current_doxygen/html/classOpenMS_1_1PeakIndex.html

This struct can be used to store both peak or feature indices

__init__()#

  • Cython signature: void PeakIndex()

  • Cython signature: void PeakIndex(PeakIndex &)

  • Cython signature: void PeakIndex(size_t peak)

  • Cython signature: void PeakIndex(size_t spectrum, size_t peak)

Methods

__init__

  • Cython signature: void PeakIndex()

clear

Cython signature: void clear() Invalidates the current index

getFeature

Cython signature: Feature getFeature(FeatureMap & map_)

getPeak

Cython signature: Peak1D getPeak(MSExperiment & map_)

getSpectrum

Cython signature: MSSpectrum getSpectrum(MSExperiment & map_)

isValid

Cython signature: bool isValid() Returns if the current peak ref is valid

Attributes

peak

spectrum

clear()#

Cython signature: void clear() Invalidates the current index

getFeature()#

Cython signature: Feature getFeature(FeatureMap & map_)

The main advantage of using this method instead accessing the data directly is that range check performed in debug mode —– :raises:

Exception: Precondition is thrown if this index is invalid for the map (only in debug mode)

getPeak()#

Cython signature: Peak1D getPeak(MSExperiment & map_)

The main advantage of using this method instead accessing the data directly is that range check performed in debug mode —– :raises:

Exception: Precondition is thrown if this index is invalid for the map (only in debug mode)

getSpectrum()#

Cython signature: MSSpectrum getSpectrum(MSExperiment & map_)

The main advantage of using this method instead accessing the data directly is that range check performed in debug mode —– :raises:

Exception: Precondition is thrown if this index is invalid for the map (only in debug mode)

isValid()#

Cython signature: bool isValid() Returns if the current peak ref is valid

peak#
spectrum#