FeatureGroupingAlgorithmKD#

class pyopenms.FeatureGroupingAlgorithmKD#

Bases: object

Cython implementation of _FeatureGroupingAlgorithmKD

Original C++ documentation is available here

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

__init__(self) None#

A feature grouping algorithm for unlabeled data

Methods

__init__(self)

A feature grouping algorithm for unlabeled data

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

getProductName(self)

Returns the product name (for the Factory)

getSubsections(self)

group

Overload:

nextProgress(self)

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

registerChildren(self)

Register all derived classes in this method

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)

transferSubelements(self, maps, out)

Transfers subelements (grouped features) from input consensus maps to the result consensus map

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

getProductName(self) bytes | str | String#

Returns the product name (for the Factory)

getSubsections(self) List[bytes]#
group()#

Overload:

group(self, maps: List[FeatureMap], out: ConsensusMap) None

Overload:

group(self, maps: List[ConsensusMap], out: ConsensusMap) None
nextProgress(self) None#

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

registerChildren(self) None#

Register all derived classes in this method

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#
transferSubelements(self, maps: List[ConsensusMap], out: ConsensusMap) None#

Transfers subelements (grouped features) from input consensus maps to the result consensus map