KernelKMeans (RapidMiner Class Documentation)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.rapidminer.operator.clustering.clusterer
Class KernelKMeans

java.lang.Object
  com.rapidminer.tools.AbstractObservable<Operator>
      com.rapidminer.operator.Operator
          com.rapidminer.operator.clustering.clusterer.AbstractClusterer
              com.rapidminer.operator.clustering.clusterer.RMAbstractClusterer
                  com.rapidminer.operator.clustering.clusterer.KernelKMeans

All Implemented Interfaces:: ConfigurationListener, PreviewListener, ResourceConsumer, ParameterHandler, LoggingHandler, Observable<Operator>

public class KernelKMeans
extends RMAbstractClusterer
extends RMAbstractClusterer

This operator is an implementation of kernel k means. Kernel K Means uses kernels to estimate distance between objects and clusters. Because of the nature of kernels it is necessary to sum over all elements of a cluster to calculate one distance. So this algorithm is quadratic in number of examples and returns NO CentroidClusterModel, as its older brother KMeans does. This operator will create a cluster attribute if not present yet.

Author:: Sebastian Land

Field Summary
`static java.lang.String`	`PARAMETER_K` The parameter name for "the maximal number of clusters"
`static java.lang.String`	`PARAMETER_MAX_OPTIMIZATION_STEPS` The parameter name for "the maximal number of iterations performed for one run of the k method"
`static java.lang.String`	`PARAMETER_USE_WEIGHTS` The parameter name for "the decision if exampleweights should be used "

Fields inherited from class com.rapidminer.operator.clustering.clusterer.RMAbstractClusterer
`PARAMETER_ADD_AS_LABEL, PARAMETER_ADD_CLUSTER_ATTRIBUTE, PARAMETER_REMOVE_UNLABELED`

Constructor Summary
`KernelKMeans(OperatorDescription description)`

Method Summary
`ClusterModel`	`generateClusterModel(ExampleSet exampleSet)` Generates a cluster model from an example set.
`java.util.List<ParameterType>`	`getParameterTypes()` Returns a list of `ParameterTypes` describing the parameters of this operator.

Methods inherited from class com.rapidminer.operator.clustering.clusterer.RMAbstractClusterer
`addsClusterAttribute, addsIdAttribute`

Methods inherited from class com.rapidminer.operator.clustering.clusterer.AbstractClusterer
`doWork, getAdditionalAttributes, getClusterModelClass, getExampleSetInputPort, shouldAutoConnect`

Methods inherited from class com.rapidminer.operator.Operator
acceptsInput, addError, addError, addValue, addWarning, apply, apply, assumePreconditionsSatisfied, checkAll, checkAllExcludingMetaData, checkDeprecations, checkForStop, checkIO, checkProperties, clear, clearErrorList, cloneOperator, collectErrors, createExperimentTree, createExperimentTree, createFromXML, createFromXML, createFromXML, createMarkedExperimentTree, createMarkedProcessTree, createProcessTree, createProcessTree, disconnectPorts, execute, fireUpdate, freeMemory, getAddOnlyAdditionalOutput, getApplyCount, getCompatibilityLevel, getDeliveredOutputClasses, getDeprecationInfo, getDesiredInputClasses, getDOMRepresentation, getEncoding, getErrorList, getExecutionUnit, getExperiment, getIncompatibleVersionChanges, getInput, getInput, getInput, getInputClasses, getInputDescription, getInputPorts, getIODescription, getLog, getLogger, getName, getNumberOfBreakpoints, getOperatorClassName, getOperatorDescription, getOutputClasses, getOutputPorts, getParameter, getParameterAsBoolean, getParameterAsChar, getParameterAsColor, getParameterAsDouble, getParameterAsFile, getParameterAsFile, getParameterAsInputStream, getParameterAsInt, getParameterAsMatrix, getParameterAsRepositoryLocation, getParameterAsString, getParameterHandler, getParameterList, getParameters, getParameterTupel, getParameterType, getParent, getPortOwner, getProcess, getResourceConsumptionEstimator, getRoot, getStartTime, getTransformer, getUserDescription, getValue, getValues, getXML, getXML, getXML, hasBreakpoint, hasBreakpoint, hasInput, inApplyLoop, isDebugMode, isDirty, isEnabled, isExpanded, isParallel, isParameterSet, isRunning, log, log, logError, logNote, logWarning, lookupOperator, makeDirty, makeDirtyOnUpdate, notifyRenaming, performAdditionalChecks, preAutoWire, processFinished, processStarts, producesOutput, propagateDirtyness, register, registerOperator, remove, removeAndKeepConnections, rename, resume, setBreakpoint, setCompatibilityLevel, setEnabled, setEnclosingProcess, setExpanded, setInput, setListParameter, setPairParameter, setParameter, setParameters, setUserDescription, shouldAutoConnect, shouldStopStandaloneExecution, toString, transformMetaData, unregisterOperator, updateExecutionOrder, walk, writeXML, writeXML

Methods inherited from class com.rapidminer.operator.Operator

acceptsInput, addError, addError, addValue, addWarning, apply, apply, assumePreconditionsSatisfied, checkAll, checkAllExcludingMetaData, checkDeprecations, checkForStop, checkIO, checkProperties, clear, clearErrorList, cloneOperator, collectErrors, createExperimentTree, createExperimentTree, createFromXML, createFromXML, createFromXML, createMarkedExperimentTree, createMarkedProcessTree, createProcessTree, createProcessTree, disconnectPorts, execute, fireUpdate, freeMemory, getAddOnlyAdditionalOutput, getApplyCount, getCompatibilityLevel, getDeliveredOutputClasses, getDeprecationInfo, getDesiredInputClasses, getDOMRepresentation, getEncoding, getErrorList, getExecutionUnit, getExperiment, getIncompatibleVersionChanges, getInput, getInput, getInput, getInputClasses, getInputDescription, getInputPorts, getIODescription, getLog, getLogger, getName, getNumberOfBreakpoints, getOperatorClassName, getOperatorDescription, getOutputClasses, getOutputPorts, getParameter, getParameterAsBoolean, getParameterAsChar, getParameterAsColor, getParameterAsDouble, getParameterAsFile, getParameterAsFile, getParameterAsInputStream, getParameterAsInt, getParameterAsMatrix, getParameterAsRepositoryLocation, getParameterAsString, getParameterHandler, getParameterList, getParameters, getParameterTupel, getParameterType, getParent, getPortOwner, getProcess, getResourceConsumptionEstimator, getRoot, getStartTime, getTransformer, getUserDescription, getValue, getValues, getXML, getXML, getXML, hasBreakpoint, hasBreakpoint, hasInput, inApplyLoop, isDebugMode, isDirty, isEnabled, isExpanded, isParallel, isParameterSet, isRunning, log, log, logError, logNote, logWarning, lookupOperator, makeDirty, makeDirtyOnUpdate, notifyRenaming, performAdditionalChecks, preAutoWire, processFinished, processStarts, producesOutput, propagateDirtyness, register, registerOperator, remove, removeAndKeepConnections, rename, resume, setBreakpoint, setCompatibilityLevel, setEnabled, setEnclosingProcess, setExpanded, setInput, setListParameter, setPairParameter, setParameter, setParameters, setUserDescription, shouldAutoConnect, shouldStopStandaloneExecution, toString, transformMetaData, unregisterOperator, updateExecutionOrder, walk, writeXML, writeXML

Methods inherited from class com.rapidminer.tools.AbstractObservable
`addObserver, addObserverAsFirst, fireUpdate, removeObserver`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

PARAMETER_K

public static final java.lang.String PARAMETER_K

The parameter name for "the maximal number of clusters"

See Also:: Constant Field Values

PARAMETER_USE_WEIGHTS

public static final java.lang.String PARAMETER_USE_WEIGHTS

The parameter name for "the decision if exampleweights should be used "

See Also:: Constant Field Values

PARAMETER_MAX_OPTIMIZATION_STEPS

public static final java.lang.String PARAMETER_MAX_OPTIMIZATION_STEPS

The parameter name for "the maximal number of iterations performed for one run of the k method"

See Also:: Constant Field Values

Constructor Detail

KernelKMeans

public KernelKMeans(OperatorDescription description)

Method Detail

generateClusterModel

public ClusterModel generateClusterModel(ExampleSet exampleSet)
                                  throws OperatorException

Description copied from class: AbstractClusterer

Generates a cluster model from an example set. Called by Operator.apply().

Specified by:: generateClusterModel in class AbstractClusterer

Throws:: OperatorException

getParameterTypes

public java.util.List<ParameterType> getParameterTypes()

Description copied from class: Operator

Returns a list of ParameterTypes describing the parameters of this operator. The default implementation returns an empty list if no input objects can be retained and special parameters for those input objects which can be prevented from being consumed. ATTENTION! This will create new parameterTypes. For calling already existing parameter types use getParameters().getParameterTypes();