RichPeak2D

class pyopenms.RichPeak2D

Bases: object

Cython implementation of _RichPeak2D

Original C++ documentation is available here

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

__init__()

Overload:

__init__(self) → None

A 2-dimensional raw data point or peak with meta information

Overload:

__init__(self, in_0: RichPeak2D) → None

Methods

__init__	Overload:
clearMetaInfo(self)	Removes all meta values
clearUniqueId(self)	Clear the unique id.
ensureUniqueId(self)	Assigns a valid unique id, but only if the present one is invalid.
getIntensity(self)	Returns the data point intensity (height)
getKeys(self, keys)	Fills the given vector with a list of all keys for which a value is set
getMZ(self)	Returns the m/z coordinate (index 1)
getMetaValue(self, in_0)	Returns the value corresponding to a string, or
getRT(self)	Returns the RT coordinate (index 0)
getUniqueId(self)	Returns the unique id
hasInvalidUniqueId(self)	Returns whether the unique id is invalid.
hasValidUniqueId(self)	Returns whether the unique id is valid.
isMetaEmpty(self)	Returns if the MetaInfo is empty
isValid(self, unique_id)	Returns true if the unique_id is valid, false otherwise
metaRegistry(self)	Returns a reference to the MetaInfoRegistry
metaValueExists(self, in_0)	Returns whether an entry with the given name exists
removeMetaValue(self, in_0)	Removes the DataValue corresponding to name if it exists
setIntensity(self, in_0)	Returns the data point intensity (height)
setMZ(self, in_0)	Returns the m/z coordinate (index 1)
setMetaValue(self, in_0, in_1)	Sets the DataValue corresponding to a name
setRT(self, in_0)	Returns the RT coordinate (index 0)
setUniqueId(self, rhs)	Assigns a new, valid unique id.

clearMetaInfo(self) → None

Removes all meta values

clearUniqueId(self) → int

Clear the unique id. The new unique id will be invalid. Returns 1 if the unique id was changed, 0 otherwise

ensureUniqueId(self) → int

Assigns a valid unique id, but only if the present one is invalid. Returns 1 if the unique id was changed, 0 otherwise

getIntensity(self) → float

Returns the data point intensity (height)

getKeys(self, keys: List[bytes]) → None

Fills the given vector with a list of all keys for which a value is set

getMZ(self) → float

Returns the m/z coordinate (index 1)

getMetaValue(self, in_0: Union[bytes, str, String]) → Union[int, float, bytes, str, List[int], List[float], List[bytes]]

Returns the value corresponding to a string, or

getRT(self) → float

Returns the RT coordinate (index 0)

getUniqueId(self) → int

Returns the unique id

hasInvalidUniqueId(self) → int

Returns whether the unique id is invalid. Returns 1 if the unique id is invalid, 0 otherwise

hasValidUniqueId(self) → int

Returns whether the unique id is valid. Returns 1 if the unique id is valid, 0 otherwise

isMetaEmpty(self) → bool

Returns if the MetaInfo is empty

isValid(self, unique_id: int) → bool

Returns true if the unique_id is valid, false otherwise

metaRegistry(self) → MetaInfoRegistry

Returns a reference to the MetaInfoRegistry

metaValueExists(self, in_0: Union[bytes, str, String]) → bool

Returns whether an entry with the given name exists

removeMetaValue(self, in_0: Union[bytes, str, String]) → None

Removes the DataValue corresponding to name if it exists

setIntensity(self, in_0: float) → None

Returns the data point intensity (height)

setMZ(self, in_0: float) → None

Returns the m/z coordinate (index 1)

setMetaValue(self, in_0: Union[bytes, str, String], in_1: Union[int, float, bytes, str, List[int], List[float], List[bytes]]) → None

Sets the DataValue corresponding to a name

setRT(self, in_0: float) → None

Returns the RT coordinate (index 0)

setUniqueId(self, rhs: int) → None

Assigns a new, valid unique id. Always returns 1