MascotGenericFile

class pyopenms.MascotGenericFile

Bases: object

Cython implementation of _MascotGenericFile

Original C++ documentation is available here

– Inherits from [‘ProgressLogger’, ‘DefaultParamHandler’]

__init__()

Overload:

__init__(self) → None

Overload:

__init__(self, in_0: MascotGenericFile) → None

Methods

__init__	Overload:
endProgress(self)	Ends the progress display
getDefaults(self)	Returns the default parameters
getHTTPPeakListEnclosure(self, filename)	Enclosing Strings of the peak list body for HTTP submission
getLogType(self)	Returns the type of progress log being used
getName(self)	Returns the name
getParameters(self)	Returns the parameters
getSubsections(self)
load(self, filename, exp)	Loads a Mascot Generic File into a PeakMap
nextProgress(self)	Increment progress by 1 (according to range begin-end)
setLogType(self, in_0)	Sets the progress log that should be used.
setName(self, in_0)	Sets the name
setParameters(self, param)	Sets the parameters
setProgress(self, value)	Sets the current progress
startProgress(self, begin, end, label)
store(self, filename, experiment)
updateMembers_(self)	Docu in base class

endProgress(self) → None

Ends the progress display

getDefaults(self) → Param

Returns the default parameters

getHTTPPeakListEnclosure(self, filename: bytes | str | String) → List[bytes | str | String, bytes | str | String]

Enclosing Strings of the peak list body for HTTP submission

Can be used to embed custom content into HTTP submission (when writing only the MGF header in HTTP format and then adding the peaks (in whatever format, e.g. mzXML) enclosed in this body The filename can later be found in the Mascot response

getLogType(self) → int

Returns the type of progress log being used

getName(self) → bytes | str | String

Returns the name

getParameters(self) → Param

Returns the parameters

getSubsections(self) → List[bytes]

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

Loads a Mascot Generic File into a PeakMap

Parameters:

• filename – File name which the map should be read from

• exp – The map which is filled with the data from the given file

Raises:

Exception: FileNotFound is thrown if the given file could not be found

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!

setName(self, in_0: bytes | str | String) → None

Sets the name

setParameters(self, param: Param) → None

Sets the parameters

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

updateMembers_(self) → None

Docu in base class