BaseFeature

class pyopenms.BaseFeature

Bases: object

Cython implementation of _BaseFeature

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

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

__init__()

  • Cython signature: void BaseFeature()

  • Cython signature: void BaseFeature(BaseFeature &)

Methods

__init__

  • Cython signature: void BaseFeature()

clearMetaInfo

Cython signature: void clearMetaInfo() Removes all meta values

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.

getAnnotationState

Cython signature: AnnotationState getAnnotationState() State of peptide identifications attached to this feature.

getCharge

Cython signature: int getCharge() Returns the charge state

getIntensity

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

getKeys

Cython signature: void getKeys(libcpp_vector[String] & keys) Fills the given vector with a list of all keys for which a value is set

getMZ

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

getMetaValue

Cython signature: DataValue getMetaValue(String) Returns the value corresponding to a string, or

getPeptideIdentifications

Cython signature: libcpp_vector[PeptideIdentification] getPeptideIdentifications() Returns the PeptideIdentification vector

getQuality

Cython signature: float getQuality() Returns the overall quality

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 features width (full width at half max, 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.

isMetaEmpty

Cython signature: bool isMetaEmpty() Returns if the MetaInfo is empty

isValid

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

metaRegistry

Cython signature: MetaInfoRegistry metaRegistry() Returns a reference to the MetaInfoRegistry

metaValueExists

Cython signature: bool metaValueExists(String) Returns whether an entry with the given name exists

removeMetaValue

Cython signature: void removeMetaValue(String) Removes the DataValue corresponding to name if it exists

setCharge

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

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)

setMetaValue

Cython signature: void setMetaValue(String, DataValue) Sets the DataValue corresponding to a name

setPeptideIdentifications

Cython signature: void setPeptideIdentifications(libcpp_vector[PeptideIdentification] & peptides) Sets the PeptideIdentification vector

setQuality

Cython signature: void setQuality(float q) Sets the overall quality

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 q) Sets the width of the feature (FWHM)
clearMetaInfo()

Cython signature: void clearMetaInfo() Removes all meta values

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

getAnnotationState()

Cython signature: AnnotationState getAnnotationState() State of peptide identifications attached to this feature. If one ID has multiple hits, the output depends on the top-hit only

getCharge()

Cython signature: int getCharge() Returns the charge state

getIntensity()

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

getKeys()

Cython signature: void getKeys(libcpp_vector[String] & keys) Fills the given vector with a list of all keys for which a value is set

getMZ()

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

getMetaValue()

Cython signature: DataValue getMetaValue(String) Returns the value corresponding to a string, or

getPeptideIdentifications()

Cython signature: libcpp_vector[PeptideIdentification] getPeptideIdentifications() Returns the PeptideIdentification vector

getQuality()

Cython signature: float getQuality() Returns the overall quality

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 features width (full width at half max, 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

isMetaEmpty()

Cython signature: bool isMetaEmpty() Returns if the MetaInfo is empty

isValid()

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

metaRegistry()

Cython signature: MetaInfoRegistry metaRegistry() Returns a reference to the MetaInfoRegistry

metaValueExists()

Cython signature: bool metaValueExists(String) Returns whether an entry with the given name exists

removeMetaValue()

Cython signature: void removeMetaValue(String) Removes the DataValue corresponding to name if it exists

setCharge()

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

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)

setMetaValue()

Cython signature: void setMetaValue(String, DataValue) Sets the DataValue corresponding to a name

setPeptideIdentifications()

Cython signature: void setPeptideIdentifications(libcpp_vector[PeptideIdentification] & peptides) Sets the PeptideIdentification vector

setQuality()

Cython signature: void setQuality(float q) Sets the overall quality

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 q) Sets the width of the feature (FWHM)