MzXMLFile

class pyopenms.MzXMLFile

Bases: object

Cython implementation of _MzXMLFile

Original C++ documentation is available here

– Inherits from [‘ProgressLogger’]

__init__()

Overload:

__init__(self) → None

Overload:

__init__(self, in_0: MzXMLFile) → None

Methods

__init__	Overload:
endProgress(self)	Ends the progress display
getLogType(self)	Returns the type of progress log being used
getOptions(self)	Returns the options for loading/storing
load(self, filename, exp)	Loads a MSExperiment from a MzXML file
nextProgress(self)	Increment progress by 1 (according to range begin-end)
setLogType(self, in_0)	Sets the progress log that should be used.
setOptions(self, in_0)	Sets options for loading/storing
setProgress(self, value)	Sets the current progress
startProgress(self, begin, end, label)
store(self, filename, exp)	Stores a MSExperiment in a MzXML file
transform

endProgress(self) → None

Ends the progress display

getLogType(self) → int

Returns the type of progress log being used

getOptions(self) → PeakFileOptions

Returns the options for loading/storing

load(self, filename: bytes | str | String, exp: MSExperiment) → None

Loads a MSExperiment from a MzXML file

Parameters:

exp – MSExperiment

nextProgress(self) → None

Increment progress by 1 (according to range begin-end)

setLogType(self, in_0: int) → None

Sets the progress log that should be used. The default type is NONE!

setOptions(self, in_0: PeakFileOptions) → None

Sets options for loading/storing

setProgress(self, value: int) → None

Sets the current progress

startProgress(self, begin: int, end: int, label: bytes | str | String) → None

store(self, filename: bytes | str | String, exp: MSExperiment) → None

Stores a MSExperiment in a MzXML file

Parameters:

exp – MSExperiment

transform()