com.rapidminer.tools.math.similarity
Class DistanceMeasures

java.lang.Object
  com.rapidminer.tools.math.similarity.DistanceMeasures

public class DistanceMeasures
extends java.lang.Object

This is a convinient class for using the distanceMeasures. It offers methods for integrating the measure classes into operators.

Author:

Sebastian Land

Field Summary

static int	DIVERGENCES_TYPE
static int	MIXED_MEASURES_TYPE
static int	NOMINAL_MEASURES_TYPE
static int	NUMERICAL_MEASURES_TYPE
static java.lang.String	PARAMETER_DIVERGENCE
static java.lang.String	PARAMETER_MEASURE_TYPES
static java.lang.String	PARAMETER_MIXED_MEASURE
static java.lang.String	PARAMETER_NOMINAL_MEASURE
static java.lang.String	PARAMETER_NUMERICAL_MEASURE

Constructor Summary

DistanceMeasures()

Method Summary

static DistanceMeasure	createDivergence(ParameterHandler parameterHandler, ExampleSet exampleSet, IOContainer ioContainer)
static DistanceMeasure	createMeasure(ParameterHandler parameterHandler, ExampleSet exampleSet, IOContainer ioContainer)
static DistanceMeasure	createMixedMeasure(ParameterHandler parameterHandler, ExampleSet exampleSet, IOContainer ioContainer)
static DistanceMeasure	createNominalMeasure(ParameterHandler parameterHandler, ExampleSet exampleSet, IOContainer ioContainer)
static DistanceMeasure	createNumericalMeasure(ParameterHandler parameterHandler, ExampleSet exampleSet, IOContainer ioContainer)
static java.util.List<ParameterType>	getParameterTypes(ParameterHandler parameterHandler) This method adds a parameter to chose a distance measure as parameter
static java.util.List<ParameterType>	getParameterTypesForNumericals(ParameterHandler handler) This method provides the parameters to chose only from numerical measures
static void	registerMeasure(int measureType, java.lang.String measureName, java.lang.Class<? extends DistanceMeasure> measureClass) This method allows registering distance or similarity measures defined in plugins.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PARAMETER_MEASURE_TYPES

public static final java.lang.String PARAMETER_MEASURE_TYPES

See Also:

Constant Field Values

PARAMETER_NOMINAL_MEASURE

public static final java.lang.String PARAMETER_NOMINAL_MEASURE

See Also:

Constant Field Values

PARAMETER_NUMERICAL_MEASURE

public static final java.lang.String PARAMETER_NUMERICAL_MEASURE

See Also:

Constant Field Values

PARAMETER_MIXED_MEASURE

public static final java.lang.String PARAMETER_MIXED_MEASURE

See Also:

Constant Field Values

PARAMETER_DIVERGENCE

public static final java.lang.String PARAMETER_DIVERGENCE

See Also:

Constant Field Values

MIXED_MEASURES_TYPE

public static final int MIXED_MEASURES_TYPE

See Also:

Constant Field Values

NOMINAL_MEASURES_TYPE

public static final int NOMINAL_MEASURES_TYPE

See Also:

Constant Field Values

NUMERICAL_MEASURES_TYPE

public static final int NUMERICAL_MEASURES_TYPE

See Also:

Constant Field Values

DIVERGENCES_TYPE

public static final int DIVERGENCES_TYPE

See Also:

Constant Field Values

Constructor Detail

DistanceMeasures

public DistanceMeasures()

Method Detail

registerMeasure

public static void registerMeasure(int measureType,
                                   java.lang.String measureName,
                                   java.lang.Class<? extends DistanceMeasure> measureClass)

This method allows registering distance or similarity measures defined in plugins. There are four different types of measures: Mixed Measures coping with examples containing nominal and numerical values. Numerical and Nominal Measures work only on their respective type of attribute. Divergences are a less restricted mathematical concept than distances but might be used for some algorithms not needing this restrictions. This type has to be specified using the first parameter.

Parameters:

measureType - The type is available as static property of class

measureName - The name of the measure to register

measureClass - The class of the measure, which needs to extend DistanceMeasure

createMeasure

public static DistanceMeasure createMeasure(ParameterHandler parameterHandler,
                                            ExampleSet exampleSet,
                                            IOContainer ioContainer)
                                     throws UndefinedParameterError,
                                            OperatorException

Throws:

UndefinedParameterError

OperatorException

createNumericalMeasure

public static DistanceMeasure createNumericalMeasure(ParameterHandler parameterHandler,
                                                     ExampleSet exampleSet,
                                                     IOContainer ioContainer)
                                              throws UndefinedParameterError,
                                                     OperatorException

Throws:

UndefinedParameterError

OperatorException

createNominalMeasure

public static DistanceMeasure createNominalMeasure(ParameterHandler parameterHandler,
                                                   ExampleSet exampleSet,
                                                   IOContainer ioContainer)
                                            throws UndefinedParameterError,
                                                   OperatorException

Throws:

UndefinedParameterError

OperatorException

createMixedMeasure

public static DistanceMeasure createMixedMeasure(ParameterHandler parameterHandler,
                                                 ExampleSet exampleSet,
                                                 IOContainer ioContainer)
                                          throws UndefinedParameterError,
                                                 OperatorException

Throws:

UndefinedParameterError

OperatorException

createDivergence

public static DistanceMeasure createDivergence(ParameterHandler parameterHandler,
                                               ExampleSet exampleSet,
                                               IOContainer ioContainer)
                                        throws UndefinedParameterError,
                                               OperatorException

Throws:

UndefinedParameterError

OperatorException

getParameterTypes

public static java.util.List<ParameterType> getParameterTypes(ParameterHandler parameterHandler)

This method adds a parameter to chose a distance measure as parameter

getParameterTypesForNumericals

public static java.util.List<ParameterType> getParameterTypesForNumericals(ParameterHandler handler)

This method provides the parameters to chose only from numerical measures