MSPGenericFile

class pyopenms.MSPGenericFile

Bases: object

Cython implementation of _MSPGenericFile

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

– Inherits from [‘DefaultParamHandler’]

__init__()
  • Cython signature: void MSPGenericFile()

  • Cython signature: void MSPGenericFile(MSPGenericFile &)

  • Cython signature: void MSPGenericFile(const String & filename, MSExperiment & library)

Methods

__init__

  • Cython signature: void MSPGenericFile()

getDefaultParameters

Cython signature: void getDefaultParameters(Param & params) Returns the class' default parameters

getDefaults

Cython signature: Param getDefaults() Returns the default parameters

getName

Cython signature: String getName() Returns the name

getParameters

Cython signature: Param getParameters() Returns the parameters

getSubsections

Cython signature: libcpp_vector[String] getSubsections()

load

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

setName

Cython signature: void setName(const String &) Sets the name

setParameters

Cython signature: void setParameters(Param & param) Sets the parameters

store

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

getDefaultParameters()

Cython signature: void getDefaultParameters(Param & params) Returns the class’ default parameters

getDefaults()

Cython signature: Param getDefaults() Returns the default parameters

getName()

Cython signature: String getName() Returns the name

getParameters()

Cython signature: Param getParameters() Returns the parameters

getSubsections()

Cython signature: libcpp_vector[String] getSubsections()

load()

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

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

Cython signature: void setName(const String &) Sets the name

setParameters()

Cython signature: void setParameters(Param & param) Sets the parameters

store()

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

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