ElutionPeakDetection

class pyopenms.ElutionPeakDetection

Bases: object

Cython implementation of _ElutionPeakDetection

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

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

__init__()
  • Cython signature: void ElutionPeakDetection()

  • Cython signature: void ElutionPeakDetection(ElutionPeakDetection &)

Methods

__init__

  • Cython signature: void ElutionPeakDetection()

computeApexSNR

Cython signature: double computeApexSNR(Kernel_MassTrace &) Compute the signal to noise ratio at the apex (estimated by computeMassTraceNoise)

computeMassTraceNoise

Cython signature: double computeMassTraceNoise(Kernel_MassTrace &) Compute noise level (as RMSE of the actual signal and the smoothed signal)

computeMassTraceSNR

Cython signature: double computeMassTraceSNR(Kernel_MassTrace &) Compute the signal to noise ratio (estimated by computeMassTraceNoise)

detectPeaks

  • Cython signature: void detectPeaks(Kernel_MassTrace & in_, libcpp_vector[Kernel_MassTrace] & out)

endProgress

Cython signature: void endProgress() Ends the progress display

filterByPeakWidth

Cython signature: void filterByPeakWidth(libcpp_vector[Kernel_MassTrace] & in_, libcpp_vector[Kernel_MassTrace] & out)

findLocalExtrema

Cython signature: void findLocalExtrema(Kernel_MassTrace &, size_t &, libcpp_vector[size_t] &, libcpp_vector[size_t] &)

getDefaults

Cython signature: Param getDefaults() Returns the default parameters

getLogType

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

getName

Cython signature: String getName() Returns the name

getParameters

Cython signature: Param getParameters() Returns the parameters

getSubsections

Cython signature: libcpp_vector[String] getSubsections()

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.

setName

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

setParameters

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

setProgress

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

smoothData

Cython signature: void smoothData(Kernel_MassTrace & mt, int win_size)

startProgress

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

computeApexSNR()

Cython signature: double computeApexSNR(Kernel_MassTrace &) Compute the signal to noise ratio at the apex (estimated by computeMassTraceNoise)

computeMassTraceNoise()

Cython signature: double computeMassTraceNoise(Kernel_MassTrace &) Compute noise level (as RMSE of the actual signal and the smoothed signal)

computeMassTraceSNR()

Cython signature: double computeMassTraceSNR(Kernel_MassTrace &) Compute the signal to noise ratio (estimated by computeMassTraceNoise)

detectPeaks()
  • Cython signature: void detectPeaks(Kernel_MassTrace & in_, libcpp_vector[Kernel_MassTrace] & out)

  • Cython signature: void detectPeaks(libcpp_vector[Kernel_MassTrace] & in_, libcpp_vector[Kernel_MassTrace] & out)

endProgress()

Cython signature: void endProgress() Ends the progress display

filterByPeakWidth()

Cython signature: void filterByPeakWidth(libcpp_vector[Kernel_MassTrace] & in_, libcpp_vector[Kernel_MassTrace] & out)

findLocalExtrema()

Cython signature: void findLocalExtrema(Kernel_MassTrace &, size_t &, libcpp_vector[size_t] &, libcpp_vector[size_t] &)

getDefaults()

Cython signature: Param getDefaults() Returns the default parameters

getLogType()

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

getName()

Cython signature: String getName() Returns the name

getParameters()

Cython signature: Param getParameters() Returns the parameters

getSubsections()

Cython signature: libcpp_vector[String] getSubsections()

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!

setName()

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

setParameters()

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

setProgress()

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

smoothData()

Cython signature: void smoothData(Kernel_MassTrace & mt, int win_size)

startProgress()

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