SpectrumSettings#

class pyopenms.SpectrumSettings#

Bases: object

Cython implementation of _SpectrumSettings

Original C++ documentation is available here: – Inherits from [‘MetaInfoInterface’]

__init__()#

Overload:

__init__(self) → None

Overload:

__init__(self, in_0: SpectrumSettings) → None

Methods

`__init__`
`clearMetaInfo`(self)	Removes all meta values
`getAcquisitionInfo`(self)	Returns a const reference to the acquisition info
`getAllNamesOfSpectrumType`()	Returns all spectrum type names known to OpenMS
`getComment`(self)	Returns the free-text comment
`getDataProcessing`(self)
`getInstrumentSettings`(self)	Returns a const reference to the instrument settings of the current spectrum
`getKeys`(self, keys)	Fills the given vector with a list of all keys for which a value is set
`getMetaValue`(self, in_0)	Returns the value corresponding to a string, or
`getNativeID`(self)	Returns the native identifier for the spectrum, used by the acquisition software
`getPrecursors`(self)	Returns a const reference to the precursors
`getProducts`(self)	Returns a const reference to the products
`getSourceFile`(self)	Returns a const reference to the source file
`getType`(self)	Returns the spectrum type (centroided (PEAKS) or profile data (RAW))
`isMetaEmpty`(self)	Returns if the MetaInfo is empty
`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
`setAcquisitionInfo`(self, in_0)	Sets the acquisition info
`setComment`(self, in_0)	Sets the free-text comment
`setDataProcessing`(self, in_0)
`setInstrumentSettings`(self, in_0)	Sets the instrument settings of the current spectrum
`setMetaValue`(self, in_0, in_1)	Sets the DataValue corresponding to a name
`setNativeID`(self, in_0)	Sets the native identifier for the spectrum, used by the acquisition software
`setPrecursors`(self, in_0)	Sets the precursors
`setProducts`(self, in_0)	Sets the products
`setSourceFile`(self, in_0)	Sets the source file
`setType`(self, in_0)	Sets the spectrum type
`unify`(self, in_0)

SpectrumType#: alias of __SpectrumType

clearMetaInfo(self) → None#: Removes all meta values

getAcquisitionInfo(self) → AcquisitionInfo#: Returns a const reference to the acquisition info

static getAllNamesOfSpectrumType() → List[bytes]#: Returns all spectrum type names known to OpenMS

getComment(self) → bytes | str | String#: Returns the free-text comment

getDataProcessing(self) → List[DataProcessing]#

getInstrumentSettings(self) → InstrumentSettings#: Returns a const reference to the instrument settings of the current spectrum

getKeys(self, keys: List[bytes]) → None#: Fills the given vector with a list of all keys for which a value is set

getMetaValue(self, in_0: bytes | str | String) → int | float | bytes | str | List[int] | List[float] | List[bytes]#: Returns the value corresponding to a string, or

getNativeID(self) → bytes | str | String#: Returns the native identifier for the spectrum, used by the acquisition software

getPrecursors(self) → List[Precursor]#: Returns a const reference to the precursors

getProducts(self) → List[Product]#: Returns a const reference to the products

getSourceFile(self) → SourceFile#: Returns a const reference to the source file

getType(self) → int#: Returns the spectrum type (centroided (PEAKS) or profile data (RAW))

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

metaRegistry(self) → MetaInfoRegistry#: Returns a reference to the MetaInfoRegistry

metaValueExists(self, in_0: bytes | str | String) → bool#: Returns whether an entry with the given name exists

removeMetaValue(self, in_0: bytes | str | String) → None#: Removes the DataValue corresponding to name if it exists

setAcquisitionInfo(self, in_0: AcquisitionInfo) → None#: Sets the acquisition info

setComment(self, in_0: bytes | str | String) → None#: Sets the free-text comment

setDataProcessing(self, in_0: List[DataProcessing]) → None#

setInstrumentSettings(self, in_0: InstrumentSettings) → None#: Sets the instrument settings of the current spectrum

setMetaValue(self, in_0: bytes | str | String, in_1: int | float | bytes | str | List[int] | List[float] | List[bytes]) → None#: Sets the DataValue corresponding to a name

setNativeID(self, in_0: bytes | str | String) → None#: Sets the native identifier for the spectrum, used by the acquisition software

setPrecursors(self, in_0: List[Precursor]) → None#: Sets the precursors

setProducts(self, in_0: List[Product]) → None#: Sets the products

setSourceFile(self, in_0: SourceFile) → None#: Sets the source file

setType(self, in_0: int) → None#: Sets the spectrum type

unify(self, in_0: SpectrumSettings) → None#