RetentionTime#

class pyopenms.RetentionTime#

Bases: CVTermListInterface

Represents a retention time entry for targeted experiment compounds and peptides

__init__() → None#
__init__(arg: pyopenms.RetentionTime, /) → None

Methods

`__init__`()
`addCVTerm`(term)	Adds a CV term
`clearMetaInfo`()	Removes all meta values
`consumeCVTerms`(cv_term_map)	Merges the given map into the member map, no duplicate checking
`empty`()
`getCVTerms`()
`getKeys`(keys)	Fills the given list with all meta value keys
`getMetaValue`(name)	Returns the value corresponding to a string, or DataValue::EMPTY if not found
`getMetaValues`()	Returns all meta values as a dictionary of {name: value}
`getRT`()
`hasCVTerm`(accession)	Checks whether the term has a value
`isMetaEmpty`()	Returns if the MetaInfo is empty
`isRTset`()
`metaRegistry`()	Returns a reference to the MetaInfoRegistry
`metaValueExists`(name)	Returns whether an entry with the given name exists
`removeMetaValue`(name)	Removes the DataValue corresponding to name if it exists
`replaceCVTerm`(cv_term)
`replaceCVTerms`(cv_terms)
`setCVTerms`(terms)	Sets the CV terms from a vector
`setMetaValue`(name, value)	Sets the DataValue corresponding to a name
`setMetaValues`(values)	Sets multiple meta values from a dictionary of {name: value}
`setRT`(rt)

Attributes

`HPINS`
`IRT`
`LOCAL`
`MINUTE`
`NORMALIZED`
`PREDICTED`
`SECOND`
`SIZE_OF_RTTYPE`
`SIZE_OF_RTUNIT`
`UNKNOWN`
`retention_time_type`	(self) -> OpenMS::TargetedExperimentHelper::RetentionTime::RTType
`retention_time_unit`	(self) -> OpenMS::TargetedExperimentHelper::RetentionTime::RTUnit
`software_ref`

HPINS = 3#

IRT = 4#

LOCAL = 0#

MINUTE = 1#

NORMALIZED = 1#

PREDICTED = 2#

class RTType(*values)#

Bases: Enum

HPINS = 3#

IRT = 4#

LOCAL = 0#

NORMALIZED = 1#

PREDICTED = 2#

SIZE_OF_RTTYPE = 6#

UNKNOWN = 5#

getMapping()#: Returns a dict mapping int values to enum member name strings.

class RTUnit(*values)#

Bases: Enum

MINUTE = 1#

SECOND = 0#

SIZE_OF_RTUNIT = 3#

UNKNOWN = 2#

getMapping()#: Returns a dict mapping int values to enum member name strings.

SECOND = 0#

SIZE_OF_RTTYPE = 6#

SIZE_OF_RTUNIT = 3#

UNKNOWN = 5#

addCVTerm(term: pyopenms.CVTerm) → None#: Adds a CV term

clearMetaInfo() → None#: Removes all meta values

consumeCVTerms(cv_term_map: dict[str, collections.abc.Sequence[pyopenms.CVTerm]]) → None#: Merges the given map into the member map, no duplicate checking

empty() → bool#

getCVTerms() → dict[str, list[pyopenms.CVTerm]]#

getKeys(keys: list) → None#: Fills the given list with all meta value keys

getMetaValue(name: str) → None | int | float | str | bytes | list[str] | list[int] | list[float]#
getMetaValue(name: str, default_value: None | int | float | str | bytes | list[str] | list[int] | list[float]) → None | int | float | str | bytes | list[str] | list[int] | list[float]
getMetaValue(index: int) → None | int | float | str | bytes | list[str] | list[int] | list[float]
getMetaValue(index: int, default_value: None | int | float | str | bytes | list[str] | list[int] | list[float]) → None | int | float | str | bytes | list[str] | list[int] | list[float]: Returns the value corresponding to a string, or DataValue::EMPTY if not found

getMetaValues() → dict#: Returns all meta values as a dictionary of {name: value}

getRT() → float#

hasCVTerm(accession: str) → bool#: Checks whether the term has a value

isMetaEmpty() → bool#: Returns if the MetaInfo is empty

isRTset() → bool#

static metaRegistry() → pyopenms.MetaInfoRegistry#: Returns a reference to the MetaInfoRegistry

metaValueExists(name: str) → bool#
metaValueExists(index: int) → bool: Returns whether an entry with the given name exists

removeMetaValue(name: str) → None#
removeMetaValue(index: int) → None: Removes the DataValue corresponding to name if it exists

replaceCVTerm(cv_term: pyopenms.CVTerm) → None#

replaceCVTerms(cv_terms: dict[str, collections.abc.Sequence[pyopenms.CVTerm]]) → None#
replaceCVTerms(cv_term_map: dict[str, collections.abc.Sequence[pyopenms.CVTerm]]) → None

property retention_time_type: pyopenms.RetentionTime.RTType#: (self) -> OpenMS::TargetedExperimentHelper::RetentionTime::RTType

property retention_time_unit: pyopenms.RetentionTime.RTUnit#: (self) -> OpenMS::TargetedExperimentHelper::RetentionTime::RTUnit

setCVTerms(terms: collections.abc.Sequence[pyopenms.CVTerm]) → None#: Sets the CV terms from a vector

setMetaValue(name: str, value: None | int | float | str | bytes | list[str] | list[int] | list[float]) → None#
setMetaValue(index: int, value: None | int | float | str | bytes | list[str] | list[int] | list[float]) → None: Sets the DataValue corresponding to a name

setMetaValues(values: dict) → None#: Sets multiple meta values from a dictionary of {name: value}

setRT(rt: float) → None#

property software_ref: str#