MSPGenericFile

class pyopenms.MSPGenericFile

Bases: object

Cython implementation of _MSPGenericFile

Original C++ documentation is available here

– Inherits from [‘DefaultParamHandler’]

__init__()

Overload:

__init__(self) → None

Overload:

__init__(self, in_0: MSPGenericFile) → None

Overload:

__init__(self, filename: bytes | str | String, library: MSExperiment) → None

Methods

__init__	Overload:
getDefaultParameters(self, params)	Returns the class' default parameters
getDefaults(self)	Returns the default parameters
getName(self)	Returns the name
getParameters(self)	Returns the parameters
getSubsections(self)
load(self, filename, library)	Load the file's data and metadata, and save it into an MSExperiment
setName(self, in_0)	Sets the name
setParameters(self, param)	Sets the parameters
store(self, filename, library)	Save data and metadata into a file

getDefaultParameters(self, params: Param) → None

Returns the class’ default parameters

getDefaults(self) → Param

Returns the default parameters

getName(self) → bytes | str | String

Returns the name

getParameters(self) → Param

Returns the parameters

getSubsections(self) → List[bytes]

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

Load the file’s data and metadata, and save it into an MSExperiment

Parameters:

• filename – Path to the MSP input file

• library – The variable into which the extracted information will be saved

Raises:

Exception: FileNotFound If the file could not be found

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

Sets the name

setParameters(self, param: Param) → None

Sets the parameters

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

Save data and metadata into a file

Parameters:

• filename – Path to the MSP input file

• library – The variable from which extracted information will be saved

Raises:

Exception: FileNotWritable If the file is not writable