AccurateMassSearchEngine#

class pyopenms.AccurateMassSearchEngine#

Bases: DefaultParamHandler

An algorithm to search for exact mass matches from a spectrum against a database (e.g. HMDB)

__init__() → None#
__init__(arg: pyopenms.AccurateMassSearchEngine, /) → None

Methods

__init__()

endProgress([bytes_processed])

Ends the progress display

getDefaults()

Returns the default parameters

getLogType()

Returns the type of progress log being used

getName()

Returns the name

getParameters()

Returns the parameters

getSubsections()

init()

nextProgress()

Increment progress by 1 (according to range begin-end)

queryByConsensusFeature(cfeat, cf_index, ...)

queryByFeature(feature, feature_index, ion_mode)

queryByMZ(observed_mz, observed_charge, ...)

run(fmap, mztab_out)

setLogType(type)

Sets the progress log that should be used.

setName(name)

Sets the name

setParameters(param)

Sets the parameters

setProgress(value)

Sets the current progress

startProgress(begin, end, label)

endProgress(bytes_processed: int = 0) → None#

Ends the progress display

getDefaults() → pyopenms.Param#

Returns the default parameters

getLogType() → pyopenms.ProgressLogger.LogType#

Returns the type of progress log being used

getName() → str#

Returns the name

getParameters() → pyopenms.Param#

Returns the parameters

getSubsections() → list[str]#
init() → None#
nextProgress() → None#

Increment progress by 1 (according to range begin-end)

queryByConsensusFeature(cfeat: pyopenms.ConsensusFeature, cf_index: int, number_of_maps: int, ion_mode: str) → list[pyopenms.AccurateMassSearchResult]#
queryByFeature(feature: pyopenms.Feature, feature_index: int, ion_mode: str) → list[pyopenms.AccurateMassSearchResult]#
queryByMZ(observed_mz: float, observed_charge: int, ion_mode: str, observed_adduct: pyopenms.EmpiricalFormula) → list[pyopenms.AccurateMassSearchResult]#
run(fmap: pyopenms.FeatureMap, mztab_out: pyopenms.MzTab) → None#
run(fmap: pyopenms.FeatureMap, mztab_out: pyopenms.MzTabM) → None
run(cmap: pyopenms.ConsensusMap, mztab_out: pyopenms.MzTab) → None
setLogType(type: pyopenms.ProgressLogger.LogType) → None#

Sets the progress log that should be used. The default type is NONE!

setName(name: str) → None#

Sets the name

setParameters(param: pyopenms.Param) → None#

Sets the parameters

setProgress(value: int) → None#

Sets the current progress

startProgress(begin: int, end: int, label: str) → None#