ChromatogramSettings

class pyopenms.ChromatogramSettings

Bases: object

Cython implementation of _ChromatogramSettings

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

Description of the chromatogram settings, provides meta-information about a single chromatogram.

__init__()

Overload:

__init__(self) → None

Overload:

__init__(self, in_0: ChromatogramSettings) → None

Methods

`__init__`	Overload:
`clearMetaInfo`(self)	Removes all meta values
`getAcquisitionInfo`(self)	Returns the acquisition info
`getChromatogramType`(self)	Get the chromatogram type
`getComment`(self)	Returns the free-text comment
`getDataProcessing`(self)	Returns the description of the applied processing
`getInstrumentSettings`(self)	Returns 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.
`getPrecursor`(self)	Returns the precursors
`getProduct`(self)	Returns the product ion
`getSourceFile`(self)	Returns the source file
`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, acquisition_info)	Sets the acquisition info
`setChromatogramType`(self, type)	Sets the chromatogram type
`setComment`(self, comment)	Sets the free-text comment
`setDataProcessing`(self, in_0)	Sets the description of the applied processing
`setInstrumentSettings`(self, instrument_settings)	Sets the instrument settings of the current spectrum
`setMetaValue`(self, in_0, in_1)	Sets the DataValue corresponding to a name
`setNativeID`(self, native_id)	Sets the native identifier for the spectrum, used by the acquisition software.
`setPrecursor`(self, precursor)	Sets the precursors
`setProduct`(self, p)	Sets the product ion
`setSourceFile`(self, source_file)	Sets the source file

ChromatogramType: alias of pyopenms._pyopenms_5.__ChromatogramType

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

getAcquisitionInfo(self) → AcquisitionInfo: Returns the acquisition info

getChromatogramType(self) → int: Get the chromatogram type

getComment(self) → Union[bytes, str, String]: Returns the free-text comment

getDataProcessing(self) → List[DataProcessing]: Returns the description of the applied processing

getInstrumentSettings(self) → InstrumentSettings: Returns 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: Union[bytes, str, String]) → Union[int, float, bytes, str, List[int], List[float], List[bytes]]: Returns the value corresponding to a string, or

getNativeID(self) → Union[bytes, str, String]: Returns the native identifier for the spectrum, used by the acquisition software.

getPrecursor(self) → Precursor: Returns the precursors

getProduct(self) → Product: Returns the product ion

getSourceFile(self) → SourceFile: Returns the source file

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

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

metaValueExists(self, in_0: Union[bytes, str, String]) → bool: Returns whether an entry with the given name exists

removeMetaValue(self, in_0: Union[bytes, str, String]) → None: Removes the DataValue corresponding to name if it exists

setAcquisitionInfo(self, acquisition_info: AcquisitionInfo) → None: Sets the acquisition info

setChromatogramType(self, type: int) → None: Sets the chromatogram type

setComment(self, comment: Union[bytes, str, String]) → None: Sets the free-text comment

setDataProcessing(self, in_0: List[DataProcessing]) → None: Sets the description of the applied processing

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

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

setNativeID(self, native_id: Union[bytes, str, String]) → None: Sets the native identifier for the spectrum, used by the acquisition software.

setPrecursor(self, precursor: Precursor) → None: Sets the precursors

setProduct(self, p: Product) → None: Sets the product ion

setSourceFile(self, source_file: SourceFile) → None: Sets the source file