AccurateMassSearchEngine#

class pyopenms.AccurateMassSearchEngine#

Bases: object

Cython implementation of _AccurateMassSearchEngine

Original C++ documentation is available here: – Inherits from [‘DefaultParamHandler’, ‘ProgressLogger’]

__init__()#

Overload:

__init__(self) → None

Overload:

__init__(self, in_0: AccurateMassSearchEngine) → None

Methods

`__init__`	Overload:
`endProgress`(self)	Ends the progress display
`getDefaults`(self)	Returns the default parameters
`getLogType`(self)	Returns the type of progress log being used
`getName`(self)	Returns the name
`getParameters`(self)	Returns the parameters
`getSubsections`(self)
`init`(self)
`nextProgress`(self)	Increment progress by 1 (according to range begin-end)
`queryByConsensusFeature`(self, cfeat, ...)
`queryByFeature`(self, feature, feature_index, ...)
`queryByMZ`(self, observed_mz, ...)
`run`	Overload:
`setLogType`(self, in_0)	Sets the progress log that should be used.
`setName`(self, in_0)	Sets the name
`setParameters`(self, param)	Sets the parameters
`setProgress`(self, value)	Sets the current progress
`startProgress`(self, begin, end, label)

endProgress(self) → None#: Ends the progress display

getDefaults(self) → Param#: Returns the default parameters

getLogType(self) → int#: Returns the type of progress log being used

getName(self) → bytes | str | String#: Returns the name

getParameters(self) → Param#: Returns the parameters

getSubsections(self) → List[bytes]#

init(self) → None#

nextProgress(self) → None#: Increment progress by 1 (according to range begin-end)

queryByConsensusFeature(self, cfeat: ConsensusFeature, cf_index: int, number_of_maps: int, ion_mode: bytes | str | String, results: List[AccurateMassSearchResult]) → None#

queryByFeature(self, feature: Feature, feature_index: int, ion_mode: bytes | str | String, in_3: List[AccurateMassSearchResult]) → None#

queryByMZ(self, observed_mz: float, observed_charge: int, ion_mode: bytes | str | String, in_3: List[AccurateMassSearchResult], observed_adduct: EmpiricalFormula) → None#

run()#

Overload:

run(self, in_0: FeatureMap, in_1: MzTab) → None

Overload:

run(self, in_0: FeatureMap, in_1: MzTabM) → None

Overload:

run(self, in_0: ConsensusMap, in_1: MzTab) → None

setLogType(self, in_0: int) → None#: Sets the progress log that should be used. The default type is NONE!

setName(self, in_0: bytes | str | String) → None#: Sets the name

setParameters(self, param: Param) → None#: Sets the parameters

setProgress(self, value: int) → None#: Sets the current progress

startProgress(self, begin: int, end: int, label: bytes | str | String) → None#