SpectrumSettings#

class pyopenms.SpectrumSettings#

Bases: object

Cython implementation of _SpectrumSettings

Documentation is available at http://www.openms.de/current_doxygen/html/classOpenMS_1_1SpectrumSettings.html: – Inherits from [‘MetaInfoInterface’]

__init__()#

Cython signature: void SpectrumSettings()
Cython signature: void SpectrumSettings(SpectrumSettings &)

Methods

`__init__`	Cython signature: void SpectrumSettings()
`clearMetaInfo`	Cython signature: void clearMetaInfo() Removes all meta values
`getAcquisitionInfo`	Cython signature: AcquisitionInfo getAcquisitionInfo() Returns a const reference to the acquisition info
`getComment`	Cython signature: String getComment() Returns the free-text comment
`getDataProcessing`	Cython signature: libcpp_vector[shared_ptr[DataProcessing]] getDataProcessing()
`getInstrumentSettings`	Cython signature: InstrumentSettings getInstrumentSettings() Returns a const reference to the instrument settings of the current spectrum
`getKeys`	Cython signature: void getKeys(libcpp_vector[String] & keys) Fills the given vector with a list of all keys for which a value is set
`getMetaValue`	Cython signature: DataValue getMetaValue(String) Returns the value corresponding to a string, or
`getNativeID`	Cython signature: String getNativeID() Returns the native identifier for the spectrum, used by the acquisition software
`getPeptideIdentifications`	Cython signature: libcpp_vector[PeptideIdentification] getPeptideIdentifications() Returns a const reference to the PeptideIdentification vector
`getPrecursors`	Cython signature: libcpp_vector[Precursor] getPrecursors() Returns a const reference to the precursors
`getProducts`	Cython signature: libcpp_vector[Product] getProducts() Returns a const reference to the products
`getSourceFile`	Cython signature: SourceFile getSourceFile() Returns a const reference to the source file
`getType`	Cython signature: int getType() Returns the spectrum type (centroided (PEAKS) or profile data (RAW))
`isMetaEmpty`	Cython signature: bool isMetaEmpty() Returns if the MetaInfo is empty
`metaRegistry`	Cython signature: MetaInfoRegistry metaRegistry() Returns a reference to the MetaInfoRegistry
`metaValueExists`	Cython signature: bool metaValueExists(String) Returns whether an entry with the given name exists
`removeMetaValue`	Cython signature: void removeMetaValue(String) Removes the DataValue corresponding to name if it exists
`setAcquisitionInfo`	Cython signature: void setAcquisitionInfo(AcquisitionInfo) Sets the acquisition info
`setComment`	Cython signature: void setComment(String) Sets the free-text comment
`setDataProcessing`	Cython signature: void setDataProcessing(libcpp_vector[shared_ptr[DataProcessing]])
`setInstrumentSettings`	Cython signature: void setInstrumentSettings(InstrumentSettings) Sets the instrument settings of the current spectrum
`setMetaValue`	Cython signature: void setMetaValue(String, DataValue) Sets the DataValue corresponding to a name
`setNativeID`	Cython signature: void setNativeID(String) Sets the native identifier for the spectrum, used by the acquisition software
`setPeptideIdentifications`	Cython signature: void setPeptideIdentifications(libcpp_vector[PeptideIdentification]) Sets the PeptideIdentification vector
`setPrecursors`	Cython signature: void setPrecursors(libcpp_vector[Precursor]) Sets the precursors
`setProducts`	Cython signature: void setProducts(libcpp_vector[Product]) Sets the products
`setSourceFile`	Cython signature: void setSourceFile(SourceFile) Sets the source file
`setType`	Cython signature: void setType(SpectrumType) Sets the spectrum type
`unify`	Cython signature: void unify(SpectrumSettings)

SpectrumType#: alias of pyopenms.pyopenms_6.__SpectrumType

clearMetaInfo()#: Cython signature: void clearMetaInfo() Removes all meta values

getAcquisitionInfo()#: Cython signature: AcquisitionInfo getAcquisitionInfo() Returns a const reference to the acquisition info

getComment()#: Cython signature: String getComment() Returns the free-text comment

getDataProcessing()#: Cython signature: libcpp_vector[shared_ptr[DataProcessing]] getDataProcessing()

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

getKeys()#: Cython signature: void getKeys(libcpp_vector[String] & keys) Fills the given vector with a list of all keys for which a value is set

getMetaValue()#: Cython signature: DataValue getMetaValue(String) Returns the value corresponding to a string, or

getNativeID()#: Cython signature: String getNativeID() Returns the native identifier for the spectrum, used by the acquisition software

getPeptideIdentifications()#: Cython signature: libcpp_vector[PeptideIdentification] getPeptideIdentifications() Returns a const reference to the PeptideIdentification vector

getPrecursors()#: Cython signature: libcpp_vector[Precursor] getPrecursors() Returns a const reference to the precursors

getProducts()#: Cython signature: libcpp_vector[Product] getProducts() Returns a const reference to the products

getSourceFile()#: Cython signature: SourceFile getSourceFile() Returns a const reference to the source file

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

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

metaRegistry()#: Cython signature: MetaInfoRegistry metaRegistry() Returns a reference to the MetaInfoRegistry

metaValueExists()#: Cython signature: bool metaValueExists(String) Returns whether an entry with the given name exists

removeMetaValue()#: Cython signature: void removeMetaValue(String) Removes the DataValue corresponding to name if it exists

setAcquisitionInfo()#: Cython signature: void setAcquisitionInfo(AcquisitionInfo) Sets the acquisition info

setComment()#: Cython signature: void setComment(String) Sets the free-text comment

setDataProcessing()#: Cython signature: void setDataProcessing(libcpp_vector[shared_ptr[DataProcessing]])

setInstrumentSettings()#: Cython signature: void setInstrumentSettings(InstrumentSettings) Sets the instrument settings of the current spectrum

setMetaValue()#: Cython signature: void setMetaValue(String, DataValue) Sets the DataValue corresponding to a name

setNativeID()#: Cython signature: void setNativeID(String) Sets the native identifier for the spectrum, used by the acquisition software

setPeptideIdentifications()#: Cython signature: void setPeptideIdentifications(libcpp_vector[PeptideIdentification]) Sets the PeptideIdentification vector

setPrecursors()#: Cython signature: void setPrecursors(libcpp_vector[Precursor]) Sets the precursors

setProducts()#: Cython signature: void setProducts(libcpp_vector[Product]) Sets the products

setSourceFile()#: Cython signature: void setSourceFile(SourceFile) Sets the source file

setType()#: Cython signature: void setType(SpectrumType) Sets the spectrum type

unify()#: Cython signature: void unify(SpectrumSettings)