AccurateMassSearchEngine#

class pyopenms.AccurateMassSearchEngine#

Bases: object

Cython implementation of _AccurateMassSearchEngine

Documentation is available at http://www.openms.de/current_doxygen/html/classOpenMS_1_1AccurateMassSearchEngine.html: – Inherits from [‘DefaultParamHandler’, ‘ProgressLogger’]

__init__()#

Cython signature: void AccurateMassSearchEngine()
Cython signature: void AccurateMassSearchEngine(AccurateMassSearchEngine &)

Methods

`__init__`	Cython signature: void AccurateMassSearchEngine()
`endProgress`	Cython signature: void endProgress() Ends the progress display
`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()
`init`	Cython signature: void init()
`nextProgress`	Cython signature: void nextProgress() Increment progress by 1 (according to range begin-end)
`queryByConsensusFeature`	Cython signature: void queryByConsensusFeature(ConsensusFeature cfeat, size_t cf_index, size_t number_of_maps, String ion_mode, libcpp_vector[AccurateMassSearchResult] & results)
`queryByFeature`	Cython signature: void queryByFeature(Feature feature, size_t feature_index, String ion_mode, libcpp_vector[AccurateMassSearchResult] &)
`queryByMZ`	Cython signature: void queryByMZ(double observed_mz, int observed_charge, String ion_mode, libcpp_vector[AccurateMassSearchResult] &, EmpiricalFormula & observed_adduct)
`run`	Cython signature: void run(FeatureMap &, MzTab &)
`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
`startProgress`	Cython signature: void startProgress(ptrdiff_t begin, ptrdiff_t end, String label)

endProgress()#: Cython signature: void endProgress() Ends the progress display

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

init()#: Cython signature: void init()

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

queryByConsensusFeature()#: Cython signature: void queryByConsensusFeature(ConsensusFeature cfeat, size_t cf_index, size_t number_of_maps, String ion_mode, libcpp_vector[AccurateMassSearchResult] & results)

queryByFeature()#: Cython signature: void queryByFeature(Feature feature, size_t feature_index, String ion_mode, libcpp_vector[AccurateMassSearchResult] &)

queryByMZ()#: Cython signature: void queryByMZ(double observed_mz, int observed_charge, String ion_mode, libcpp_vector[AccurateMassSearchResult] &, EmpiricalFormula & observed_adduct)

run()#

Cython signature: void run(FeatureMap &, MzTab &)
Cython signature: void run(FeatureMap &, MzTabM &)
Cython signature: void run(ConsensusMap &, MzTab &)

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

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