FeatureHandle#

class pyopenms.FeatureHandle#

Bases: object

Representation of a Peak2D, RichPeak2D or Feature

__init__() → None#
__init__(arg0: int, arg1: pyopenms.Peak2D, arg2: int, /) → None
__init__(arg0: int, arg1: pyopenms.BaseFeature, /) → None
__init__(arg: pyopenms.FeatureHandle, /) → None

Methods

__init__()

clearUniqueId()

Clear the unique id.

ensureUniqueId()

Assigns a valid unique id, but only if the present one is invalid.

getCharge()

Returns the charge

getIntensity()

Overloaded function.

getMZ()

Overloaded function.

getMapIndex()

Returns the map index

getRT()

Overloaded function.

getUniqueId()

Returns the unique id

getWidth()

Returns the width (FWHM)

hasInvalidUniqueId()

Returns whether the unique id is invalid.

hasValidUniqueId()

Returns whether the unique id is valid.

isValid(unique_id)

Returns true if the unique_id is valid, false otherwise

setCharge(charge)

Sets the charge

setIntensity(intensity)

Overloaded function.

setMZ(coordinate)

Overloaded function.

setMapIndex(i)

Sets the map index

setRT(coordinate)

Overloaded function.

setUniqueId()

Overloaded function.

setWidth(width)

Sets the width (FWHM)

clearUniqueId() → int#

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

ensureUniqueId() → int#

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

getCharge() → int#

Returns the charge

getIntensity() → float#
getIntensity() → float

Overloaded function.

  1. getIntensity() -> float

Returns the data point intensity (height)

  1. getIntensity() -> float

Returns the intensity

getMZ() → float#
getMZ() → float

Overloaded function.

  1. getMZ() -> float

Returns the m/z coordinate (index 1)

  1. getMZ() -> float

Returns the m/z

getMapIndex() → int#

Returns the map index

getRT() → float#
getRT() → float

Overloaded function.

  1. getRT() -> float

Returns the RT coordinate (index 0)

  1. getRT() -> float

Returns the retention time

getUniqueId() → int#

Returns the unique id

getWidth() → float#

Returns the width (FWHM)

hasInvalidUniqueId() → int#

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

hasValidUniqueId() → int#

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

static isValid(unique_id: int) → bool#

Returns true if the unique_id is valid, false otherwise

setCharge(charge: int) → None#

Sets the charge

setIntensity(intensity: float) → None#
setIntensity(intensity: float) → None

Overloaded function.

  1. setIntensity(intensity: float) -> None

Sets the data point intensity (height)

  1. setIntensity(intensity: float) -> None

Sets the intensity

setMZ(coordinate: float) → None#
setMZ(mz: float) → None

Overloaded function.

  1. setMZ(coordinate: float) -> None

Sets the m/z coordinate (index 1)

  1. setMZ(mz: float) -> None

Sets the m/z

setMapIndex(i: int) → None#

Sets the map index

setRT(coordinate: float) → None#
setRT(rt: float) → None

Overloaded function.

  1. setRT(coordinate: float) -> None

Sets the RT coordinate (index 0)

  1. setRT(rt: float) -> None

Sets the retention time

setUniqueId() → int#
setUniqueId(rhs: int) → None
setUniqueId(rhs: str) → None

Overloaded function.

  1. setUniqueId() -> int

Assigns a new, valid unique id. Always returns 1

  1. setUniqueId(rhs: int) -> None

Assigns the given unique id

  1. setUniqueId(rhs: str) -> None

Assigns a unique id from a string (extracts UInt64 after last underscore)

setWidth(width: float) → None#

Sets the width (FWHM)