FeatureGroupingAlgorithmKD

class pyopenms.FeatureGroupingAlgorithmKD

Bases: object

Cython implementation of _FeatureGroupingAlgorithmKD

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

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

__init__()

Cython signature: void FeatureGroupingAlgorithmKD() A feature grouping algorithm for unlabeled data

Methods

__init__

Cython signature: void FeatureGroupingAlgorithmKD() A feature grouping algorithm for unlabeled data

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

getProductName

Cython signature: String getProductName() Returns the product name (for the Factory)

getSubsections

Cython signature: libcpp_vector[String] getSubsections()

group

  • Cython signature: void group(libcpp_vector[FeatureMap] & maps, ConsensusMap & out)

nextProgress

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

registerChildren

Cython signature: void registerChildren() Register all derived classes in this method

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)

transferSubelements

Cython signature: void transferSubelements(libcpp_vector[ConsensusMap] maps, ConsensusMap & out) Transfers subelements (grouped features) from input consensus maps to the result consensus map

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

getProductName()

Cython signature: String getProductName() Returns the product name (for the Factory)

getSubsections()

Cython signature: libcpp_vector[String] getSubsections()

group()
  • Cython signature: void group(libcpp_vector[FeatureMap] & maps, ConsensusMap & out)

  • Cython signature: void group(libcpp_vector[ConsensusMap] & maps, ConsensusMap & out)

nextProgress()

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

registerChildren()

Cython signature: void registerChildren() Register all derived classes in this method

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)

transferSubelements()

Cython signature: void transferSubelements(libcpp_vector[ConsensusMap] maps, ConsensusMap & out) Transfers subelements (grouped features) from input consensus maps to the result consensus map