MzDataFile#

class pyopenms.MzDataFile(*args, **kwargs)#

Bases: XMLFile

File adapter for MzData files ProgressLogger

__init__(self) → None#
__init__(self, arg: pyopenms._pyopenms_misc.MzDataFile, /) → None

Attributes

endProgress

Ends the progress display

getLogType

Returns the type of progress log being used

getOptions

Returns the options for loading/storing

getVersion

Return the version of the schema

isSemanticallyValid

load

Overloaded function.

nextProgress

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

setLogType

Sets the progress log that should be used.

setOptions

Sets options for loading/storing

setProgress

Sets the current progress

startProgress

store

Loads a map from a MzData file :param filename: Directory of the file with the file name :param map: It has to be a MSExperiment or have the same interface :raises: Exception: FileNotFound is thrown if the file could not be opened :raises: Exception: ParseError is thrown if an error occurs during parsing

endProgress#

Ends the progress display

getLogType#

Returns the type of progress log being used

getOptions#

Returns the options for loading/storing

getVersion#

Return the version of the schema

isSemanticallyValid#
load#

Overloaded function.

  1. load(self, filename: str) -> pyopenms._pyopenms_experiment.MSExperiment

  2. load(self, filename: str, map: pyopenms._pyopenms_experiment.MSExperiment) -> None

Loads a map from a MzData file into the given MSExperiment

nextProgress#

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

setLogType#

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

setOptions#

Sets options for loading/storing

setProgress#

Sets the current progress

startProgress#
store#

Loads a map from a MzData file :param filename: Directory of the file with the file name :param map: It has to be a MSExperiment or have the same interface :raises: Exception: FileNotFound is thrown if the file could not be opened :raises: Exception: ParseError is thrown if an error occurs during parsing