MzDataFile#

class pyopenms.MzDataFile#

Bases: object

Cython implementation of _MzDataFile

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

– Inherits from [‘ProgressLogger’]

__init__()#

  • Cython signature: void MzDataFile() File adapter for MzData files

  • Cython signature: void MzDataFile(MzDataFile &)

Methods

__init__

  • Cython signature: void MzDataFile()

endProgress

Cython signature: void endProgress() Ends the progress display

getLogType

Cython signature: LogType getLogType() Returns the type of progress log being used

getOptions

Cython signature: PeakFileOptions getOptions() Returns the options for loading/storing

isSemanticallyValid

Cython signature: bool isSemanticallyValid(const String & filename, StringList & errors, StringList & warnings)

load

Cython signature: void load(const String & filename, MSExperiment & map)

nextProgress

Cython signature: void nextProgress() Increment progress by 1 (according to range begin-end)

setLogType

Cython signature: void setLogType(LogType) Sets the progress log that should be used.

setOptions

Cython signature: void setOptions(PeakFileOptions) Sets options for loading/storing

setProgress

Cython signature: void setProgress(ptrdiff_t value) Sets the current progress

startProgress

Cython signature: void startProgress(ptrdiff_t begin, ptrdiff_t end, String label)

store

Cython signature: void store(const String & filename, MSExperiment & map)
endProgress()#

Cython signature: void endProgress() Ends the progress display

getLogType()#

Cython signature: LogType getLogType() Returns the type of progress log being used

getOptions()#

Cython signature: PeakFileOptions getOptions() Returns the options for loading/storing

isSemanticallyValid()#

Cython signature: bool isSemanticallyValid(const String & filename, StringList & errors, StringList & warnings)

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()#

Cython signature: void load(const String & filename, MSExperiment & map)

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()#

Cython signature: void nextProgress() Increment progress by 1 (according to range begin-end)

setLogType()#

Cython signature: void setLogType(LogType) Sets the progress log that should be used. The default type is NONE!

setOptions()#

Cython signature: void setOptions(PeakFileOptions) Sets options for loading/storing

setProgress()#

Cython signature: void setProgress(ptrdiff_t value) Sets the current progress

startProgress()#

Cython signature: void startProgress(ptrdiff_t begin, ptrdiff_t end, String label)

store()#

Cython signature: void store(const String & filename, MSExperiment & map)

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