de.lmu.ifi.dbs.elki.distance.distancefunction.subspace
Class DimensionSelectingDistanceFunction<N extends Number,V extends FeatureVector<V,N>>

java.lang.Object
  de.lmu.ifi.dbs.elki.logging.AbstractLoggable
      de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizable
          de.lmu.ifi.dbs.elki.distance.AbstractMeasurementFunction<O,D>
              de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractDistanceFunction<O,DoubleDistance>
                  de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractDoubleDistanceFunction<V>
                      de.lmu.ifi.dbs.elki.distance.distancefunction.subspace.DimensionSelectingDistanceFunction<N,V>

Type Parameters:

N - number type

V - the type of FeatureVector to compute the distances in between

All Implemented Interfaces:

DistanceFunction<V,DoubleDistance>, MeasurementFunction<V,DoubleDistance>, SpatialDistanceFunction<V,DoubleDistance>, Parameterizable

public class DimensionSelectingDistanceFunction<N extends Number,V extends FeatureVector<V,N>>
extends AbstractDoubleDistanceFunction<V>
implements SpatialDistanceFunction<V,DoubleDistance>

Provides a distance function that computes the distance between feature vectors as the absolute difference of their values in a specified dimension.

Author:

Elke Achtert

Field Summary

private int	dim The dimension to be considered for distance computation.
static OptionID	DIM_ID OptionID for DIM_PARAM
private IntParameter	DIM_PARAM Parameter for dimensionality.

Fields inherited from class de.lmu.ifi.dbs.elki.distance.AbstractMeasurementFunction

INFINITY_PATTERN

Fields inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizable

optionHandler

Fields inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable

debug, logger

Constructor Summary

DimensionSelectingDistanceFunction()
Constructor

Method Summary

DoubleDistance	centerDistance(HyperBoundingBox mbr1, HyperBoundingBox mbr2) Computes the distance between the centroids of the two given MBRs according to this distance function.
DoubleDistance	distance(HyperBoundingBox mbr1, HyperBoundingBox mbr2) Computes the distance between the two given MBRs according to this distance function.
DoubleDistance	distance(V v1, V v2) Computes the distance between two given DatabaseObjects according to this distance function.
int	getSelectedDimension() Returns the selected dimension.
DoubleDistance	minDist(HyperBoundingBox mbr, Integer id) Computes the minimum distance between the given MBR and the FeatureVector object with the given id according to this distance function.
DoubleDistance	minDist(HyperBoundingBox mbr, V v) Computes the minimum distance between the given MBR and the FeatureVector object according to this distance function.
List<String>	setParameters(List<String> args) Grabs all specified options from the option handler.
String	shortDescription() Returns a description of the class and the required parameters.

Methods inherited from class de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractDoubleDistanceFunction

infiniteDistance, nullDistance, undefinedDistance, valueOf

Methods inherited from class de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractDistanceFunction

distance, distance, isInfiniteDistance, isNullDistance, isUndefinedDistance

Methods inherited from class de.lmu.ifi.dbs.elki.distance.AbstractMeasurementFunction

getDatabase, matches, requiredInputPattern, setDatabase, setRequiredInputPattern

Methods inherited from class de.lmu.ifi.dbs.elki.utilities.optionhandling.AbstractParameterizable

addOption, addParameterizable, addParameterizable, checkGlobalParameterConstraints, collectOptions, getAttributeSettings, getParameters, rememberParametersExcept, removeOption, removeParameterizable

Methods inherited from class de.lmu.ifi.dbs.elki.logging.AbstractLoggable

debugFine, debugFiner, debugFinest, exception, progress, verbose, warning

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.lmu.ifi.dbs.elki.distance.distancefunction.DistanceFunction

distance, distance

Methods inherited from interface de.lmu.ifi.dbs.elki.distance.MeasurementFunction

infiniteDistance, isInfiniteDistance, isNullDistance, isUndefinedDistance, nullDistance, requiredInputPattern, setDatabase, undefinedDistance, valueOf

Methods inherited from interface de.lmu.ifi.dbs.elki.utilities.optionhandling.Parameterizable

checkGlobalParameterConstraints, collectOptions, getParameters

Field Detail

DIM_ID

public static final OptionID DIM_ID

OptionID for DIM_PARAM

DIM_PARAM

private final IntParameter DIM_PARAM

Parameter for dimensionality.

dim

private int dim

The dimension to be considered for distance computation.

Constructor Detail

DimensionSelectingDistanceFunction

public DimensionSelectingDistanceFunction()

Constructor

Method Detail

distance

public DoubleDistance distance(V v1,
                               V v2)

Computes the distance between two given DatabaseObjects according to this distance function.

Specified by:

distance in interface DistanceFunction<V extends FeatureVector<V,N>,DoubleDistance>

Parameters:

v1 - first DatabaseObject

v2 - second DatabaseObject

Returns:

the distance between two given DatabaseObjects according to this distance function

shortDescription

public String shortDescription()

Returns a description of the class and the required parameters.

This description should be suitable for a usage description.

Specified by:

shortDescription in interface Parameterizable

Overrides:

shortDescription in class AbstractMeasurementFunction<V extends FeatureVector<V,N>,DoubleDistance>

Returns:

String a description of the class and the required parameters

minDist

public DoubleDistance minDist(HyperBoundingBox mbr,
                              V v)

Description copied from interface: SpatialDistanceFunction

Computes the minimum distance between the given MBR and the FeatureVector object according to this distance function.

Specified by:

minDist in interface SpatialDistanceFunction<V extends FeatureVector<V,N>,DoubleDistance>

Parameters:

mbr - the MBR object

v - the FeatureVector object

Returns:

the minimum distance between the given MBR and the FeatureVector object according to this distance function

minDist

public DoubleDistance minDist(HyperBoundingBox mbr,
                              Integer id)

Description copied from interface: SpatialDistanceFunction

Computes the minimum distance between the given MBR and the FeatureVector object with the given id according to this distance function.

Specified by:

minDist in interface SpatialDistanceFunction<V extends FeatureVector<V,N>,DoubleDistance>

Parameters:

mbr - the MBR object

id - the id of the FeatureVector object

Returns:

the minimum distance between the given MBR and the FeatureVector object according to this distance function

distance

public DoubleDistance distance(HyperBoundingBox mbr1,
                               HyperBoundingBox mbr2)

Description copied from interface: SpatialDistanceFunction

Computes the distance between the two given MBRs according to this distance function.

Specified by:

distance in interface SpatialDistanceFunction<V extends FeatureVector<V,N>,DoubleDistance>

Parameters:

mbr1 - the first MBR object

mbr2 - the second MBR object

Returns:

the distance between the two given MBRs according to this distance function

centerDistance

public DoubleDistance centerDistance(HyperBoundingBox mbr1,
                                     HyperBoundingBox mbr2)

Description copied from interface: SpatialDistanceFunction

Computes the distance between the centroids of the two given MBRs according to this distance function.

Specified by:

centerDistance in interface SpatialDistanceFunction<V extends FeatureVector<V,N>,DoubleDistance>

Parameters:

mbr1 - the first MBR object

mbr2 - the second MBR object

Returns:

the distance between the centroids of the two given MBRs according to this distance function

setParameters

public List<String> setParameters(List<String> args)
                           throws ParameterException

Description copied from class: AbstractParameterizable

Grabs all specified options from the option handler. Any extending class should call this method first and return the returned array without further changes, but after setting further required parameters. An example for overwriting this method taking advantage from the previously (in superclasses) defined options would be:

 {
   List remainingParameters = super.setParameters(args);
   // set parameters for your class
   // for example like this:
   if(isSet(MY_PARAM_VALUE_PARAM))
   {
      myParamValue = getParameterValue(MY_PARAM_VALUE_PARAM);
   }
   .
   .
   .
   return remainingParameters;
   // or in case of attributes requesting parameters themselves
   // return parameterizableAttribbute.setParameters(remainingParameters);
 }
 

Specified by:

setParameters in interface Parameterizable

Overrides:

setParameters in class AbstractParameterizable

Parameters:

args - parameters to set the attributes accordingly to

Returns:

a list containing the unused parameters

Throws:

ParameterException - in case of wrong parameter-setting

getSelectedDimension

public int getSelectedDimension()

Returns the selected dimension.

Returns:

the selected dimension