MzDataFile#

class pyopenms.MzDataFile#

Bases: object

Cython implementation of _MzDataFile

Original C++ documentation is available here

– Inherits from [‘ProgressLogger’]

__init__()#

Overload:

__init__(self) → None

File adapter for MzData files

Overload:

__init__(self, in_0: MzDataFile) → 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

isSemanticallyValid(self, filename, errors, ...)

Checks if a file is valid with respect to the mapping file and the controlled vocabulary

load(self, filename, map)

Loads a map from a MzData 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, map)

Stores a map in a MzData file
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

isSemanticallyValid(self, filename: bytes | str | String, errors: List[bytes], warnings: List[bytes]) → bool#

Checks if a file is valid with respect to the mapping file and the controlled vocabulary

Parameters:

  • filename – File name of the file to be checked

  • errors – Errors during the validation are returned in this output parameter

  • warnings – Warnings during the validation are returned in this output parameter

Raises:

Exception: FileNotFound is thrown if the file could not be opened

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

Loads a map from a MzData file

Parameters:

  • filename – Directory of the file with the file name

  • 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

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, map: MSExperiment) → None#

Stores a map in a MzData file

Parameters:

  • filename – Directory of the file with the file name

  • map – It has to be a MSExperiment or have the same interface

Raises:

Exception: UnableToCreateFile is thrown if the file could not be created