FeatureHandle

class pyopenms.FeatureHandle

Bases: object

Cython implementation of _FeatureHandle

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

– Inherits from [‘Peak2D’, ‘UniqueIdInterface’]

__init__()

  • Cython signature: void FeatureHandle() Representation of a Peak2D, RichPeak2D or Feature

  • Cython signature: void FeatureHandle(FeatureHandle &)

  • Cython signature: void FeatureHandle(uint64_t map_index, Peak2D & point, uint64_t element_index)

Methods

__init__

  • Cython signature: void FeatureHandle()

clearUniqueId

Cython signature: size_t clearUniqueId() Clear the unique id.

ensureUniqueId

Cython signature: size_t ensureUniqueId() Assigns a valid unique id, but only if the present one is invalid.

getCharge

Cython signature: int getCharge() Returns the charge

getIntensity

Cython signature: float getIntensity() Returns the data point intensity (height)

getMZ

Cython signature: double getMZ() Returns the m/z coordinate (index 1)

getMapIndex

Cython signature: uint64_t getMapIndex() Returns the map index

getRT

Cython signature: double getRT() Returns the RT coordinate (index 0)

getUniqueId

Cython signature: size_t getUniqueId() Returns the unique id

getWidth

Cython signature: float getWidth() Returns the width (FWHM)

hasInvalidUniqueId

Cython signature: size_t hasInvalidUniqueId() Returns whether the unique id is invalid.

hasValidUniqueId

Cython signature: size_t hasValidUniqueId() Returns whether the unique id is valid.

isValid

Cython signature: bool isValid(uint64_t unique_id) Returns true if the unique_id is valid, false otherwise

setCharge

Cython signature: void setCharge(int charge) Sets the charge

setIntensity

Cython signature: void setIntensity(float) Returns the data point intensity (height)

setMZ

Cython signature: void setMZ(double) Returns the m/z coordinate (index 1)

setMapIndex

Cython signature: void setMapIndex(uint64_t i) Sets the map index

setRT

Cython signature: void setRT(double) Returns the RT coordinate (index 0)

setUniqueId

Cython signature: void setUniqueId(uint64_t rhs) Assigns a new, valid unique id.

setWidth

Cython signature: void setWidth(float width) Sets the width (FWHM)
clearUniqueId()

Cython signature: size_t clearUniqueId() Clear the unique id. The new unique id will be invalid. Returns 1 if the unique id was changed, 0 otherwise

ensureUniqueId()

Cython signature: size_t ensureUniqueId() Assigns a valid unique id, but only if the present one is invalid. Returns 1 if the unique id was changed, 0 otherwise

getCharge()

Cython signature: int getCharge() Returns the charge

getIntensity()

Cython signature: float getIntensity() Returns the data point intensity (height)

getMZ()

Cython signature: double getMZ() Returns the m/z coordinate (index 1)

getMapIndex()

Cython signature: uint64_t getMapIndex() Returns the map index

getRT()

Cython signature: double getRT() Returns the RT coordinate (index 0)

getUniqueId()

Cython signature: size_t getUniqueId() Returns the unique id

getWidth()

Cython signature: float getWidth() Returns the width (FWHM)

hasInvalidUniqueId()

Cython signature: size_t hasInvalidUniqueId() Returns whether the unique id is invalid. Returns 1 if the unique id is invalid, 0 otherwise

hasValidUniqueId()

Cython signature: size_t hasValidUniqueId() Returns whether the unique id is valid. Returns 1 if the unique id is valid, 0 otherwise

isValid()

Cython signature: bool isValid(uint64_t unique_id) Returns true if the unique_id is valid, false otherwise

setCharge()

Cython signature: void setCharge(int charge) Sets the charge

setIntensity()

Cython signature: void setIntensity(float) Returns the data point intensity (height)

setMZ()

Cython signature: void setMZ(double) Returns the m/z coordinate (index 1)

setMapIndex()

Cython signature: void setMapIndex(uint64_t i) Sets the map index

setRT()

Cython signature: void setRT(double) Returns the RT coordinate (index 0)

setUniqueId()

Cython signature: void setUniqueId(uint64_t rhs) Assigns a new, valid unique id. Always returns 1

setWidth()

Cython signature: void setWidth(float width) Sets the width (FWHM)