ChromatogramSettings

class pyopenms.ChromatogramSettings

Bases: object

Cython implementation of _ChromatogramSettings

Documentation is available at http://www.openms.de/current_doxygen/html/classOpenMS_1_1ChromatogramSettings.html

– Inherits from [‘MetaInfoInterface’]

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

__init__()
  • Cython signature: void ChromatogramSettings()

  • Cython signature: void ChromatogramSettings(ChromatogramSettings &)

Methods

__init__

  • Cython signature: void ChromatogramSettings()

clearMetaInfo

Cython signature: void clearMetaInfo() Removes all meta values

getAcquisitionInfo

Cython signature: AcquisitionInfo getAcquisitionInfo() Returns the acquisition info

getChromatogramType

Cython signature: ChromatogramType getChromatogramType() Get the chromatogram type

getComment

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

getDataProcessing

Cython signature: libcpp_vector[shared_ptr[DataProcessing]] getDataProcessing() Returns the description of the applied processing

getInstrumentSettings

Cython signature: InstrumentSettings getInstrumentSettings() Returns 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.

getPrecursor

Cython signature: Precursor getPrecursor() Returns the precursors

getProduct

Cython signature: Product getProduct() Returns the product ion

getSourceFile

Cython signature: SourceFile getSourceFile() Returns the source file

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 acquisition_info) Sets the acquisition info

setChromatogramType

Cython signature: void setChromatogramType(ChromatogramType type) Sets the chromatogram type

setComment

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

setDataProcessing

Cython signature: void setDataProcessing(libcpp_vector[shared_ptr[DataProcessing]]) Sets the description of the applied processing

setInstrumentSettings

Cython signature: void setInstrumentSettings(InstrumentSettings instrument_settings) 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 native_id) Sets the native identifier for the spectrum, used by the acquisition software.

setPrecursor

Cython signature: void setPrecursor(Precursor precursor) Sets the precursors

setProduct

Cython signature: void setProduct(Product p) Sets the product ion

setSourceFile

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

ChromatogramType

alias of pyopenms.pyopenms_7.__ChromatogramType

clearMetaInfo()

Cython signature: void clearMetaInfo() Removes all meta values

getAcquisitionInfo()

Cython signature: AcquisitionInfo getAcquisitionInfo() Returns the acquisition info

getChromatogramType()

Cython signature: ChromatogramType getChromatogramType() Get the chromatogram type

getComment()

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

getDataProcessing()

Cython signature: libcpp_vector[shared_ptr[DataProcessing]] getDataProcessing() Returns the description of the applied processing

getInstrumentSettings()

Cython signature: InstrumentSettings getInstrumentSettings() Returns 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.

getPrecursor()

Cython signature: Precursor getPrecursor() Returns the precursors

getProduct()

Cython signature: Product getProduct() Returns the product ion

getSourceFile()

Cython signature: SourceFile getSourceFile() Returns the source file

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 acquisition_info) Sets the acquisition info

setChromatogramType()

Cython signature: void setChromatogramType(ChromatogramType type) Sets the chromatogram type

setComment()

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

setDataProcessing()

Cython signature: void setDataProcessing(libcpp_vector[shared_ptr[DataProcessing]]) Sets the description of the applied processing

setInstrumentSettings()

Cython signature: void setInstrumentSettings(InstrumentSettings instrument_settings) 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 native_id) Sets the native identifier for the spectrum, used by the acquisition software.

setPrecursor()

Cython signature: void setPrecursor(Precursor precursor) Sets the precursors

setProduct()

Cython signature: void setProduct(Product p) Sets the product ion

setSourceFile()

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