SearchParameters#

class pyopenms.SearchParameters#

Bases: MetaInfoInterface

OpenMS class SearchParameters

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

Methods

__init__()

clearMetaInfo()

Removes all meta values

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}

isMetaEmpty()

Returns if the MetaInfo is empty

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

setMetaValue(name, value)

Sets the DataValue corresponding to a name

setMetaValues(values)

Sets multiple meta values from a dictionary of {name: value}

Attributes

property charges: str#
clearMetaInfo() → None#

Removes all meta values

property db: str#
property db_version: str#
property digestion_enzyme: pyopenms.DigestionEnzymeProtein#

(self) -> OpenMS::DigestionEnzymeProtein

property fixed_modifications: list[str]#
property fragment_mass_tolerance: float#
property fragment_mass_tolerance_ppm: bool#
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}

isMetaEmpty() → bool#

Returns if the MetaInfo is empty

property mass_type: pyopenms.ProteinIdentification.PeakMassType#
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

property missed_cleavages: int#
property precursor_mass_tolerance: float#
property precursor_mass_tolerance_ppm: bool#
removeMetaValue(name: str) → None#
removeMetaValue(index: int) → None

Removes the DataValue corresponding to name if it exists

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}

property taxonomy: str#
property variable_modifications: list[str]#