FeatureHandle#
- class pyopenms.FeatureHandle#
Bases:
object
Cython implementation of _FeatureHandle
- Original C++ documentation is available here
– Inherits from [‘Peak2D’, ‘UniqueIdInterface’]
- __init__()#
Overload:
- __init__(self) None
Representation of a Peak2D, RichPeak2D or Feature
Overload:
- __init__(self, in_0: FeatureHandle) None
Overload:
- __init__(self, map_index: int, point: Peak2D, element_index: int) None
Methods
Overload:
clearUniqueId
(self)Clear the unique id.
ensureUniqueId
(self)Assigns a valid unique id, but only if the present one is invalid.
getCharge
(self)Returns the charge
getIntensity
(self)Returns the data point intensity (height)
getMZ
(self)Returns the m/z coordinate (index 1)
getMapIndex
(self)Returns the map index
getRT
(self)Returns the RT coordinate (index 0)
getUniqueId
(self)Returns the unique id
getWidth
(self)Returns the width (FWHM)
hasInvalidUniqueId
(self)Returns whether the unique id is invalid.
hasValidUniqueId
(self)Returns whether the unique id is valid.
isValid
(self, unique_id)Returns true if the unique_id is valid, false otherwise
setCharge
(self, charge)Sets the charge
setIntensity
(self, in_0)Returns the data point intensity (height)
setMZ
(self, in_0)Returns the m/z coordinate (index 1)
setMapIndex
(self, i)Sets the map index
setRT
(self, in_0)Returns the RT coordinate (index 0)
setUniqueId
(self, rhs)Assigns a new, valid unique id.
setWidth
(self, width)Sets the width (FWHM)
- 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
- getCharge(self) int #
Returns the charge
- getIntensity(self) float #
Returns the data point intensity (height)
- getMZ(self) float #
Returns the m/z coordinate (index 1)
- getMapIndex(self) int #
Returns the map index
- getRT(self) float #
Returns the RT coordinate (index 0)
- getUniqueId(self) int #
Returns the unique id
- getWidth(self) float #
Returns the width (FWHM)
- 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
- isValid(self, unique_id: int) bool #
Returns true if the unique_id is valid, false otherwise
- setCharge(self, charge: int) None #
Sets the charge
- 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)
- setMapIndex(self, i: int) None #
Sets the map index
- 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
- setWidth(self, width: float) None #
Sets the width (FWHM)