uk.ac.starlink.table.join
Class IsotropicCartesianMatchEngine

java.lang.Object
  extended by uk.ac.starlink.table.join.AbstractCartesianMatchEngine
      extended by uk.ac.starlink.table.join.IsotropicCartesianMatchEngine
All Implemented Interfaces:
MatchEngine

public class IsotropicCartesianMatchEngine
extends AbstractCartesianMatchEngine

Matcher which matches in an isotropic N-dimensional Cartesian space. Two points are considered matching if they fall within an error sphere of a given size.

Since:
25 Aug 2004

Field Summary
 
Fields inherited from interface uk.ac.starlink.table.join.MatchEngine
NO_BINS
 
Constructor Summary
IsotropicCartesianMatchEngine(int ndim, double err, boolean normaliseScores)
          Constructs a matcher which matches points in an ndim-dimensional Cartesian space.
 
Method Summary
 double getError()
          Returns the isotropic matching error.
 DescribedValue[] getMatchParameters()
          Returns a single parameter controlling the isotropic error (radius of a match sphere).
 void setError(double err)
          Sets the isotropic matching error.
 java.lang.String toString()
           
 
Methods inherited from class uk.ac.starlink.table.join.AbstractCartesianMatchEngine
canBoundMatch, getBins, getDimensions, getError, getMatchBounds, getMatchScoreInfo, getNormaliseScores, getScaleFactor, getTuningParameters, getTupleInfos, matchScore, setError, setNormaliseScores, setScaleFactor
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IsotropicCartesianMatchEngine

public IsotropicCartesianMatchEngine(int ndim,
                                     double err,
                                     boolean normaliseScores)
Constructs a matcher which matches points in an ndim-dimensional Cartesian space. An initial isotropic error margin is specified.

Parameters:
ndim - dimensionality of the space
err - initial maximum distance between two matching points
normaliseScores - true iff you want match scores to be normalised
Method Detail

setError

public void setError(double err)
Sets the isotropic matching error.

Parameters:
err - radius of error sphere

getError

public double getError()
Returns the isotropic matching error.

Returns:
radius of error sphere

getMatchParameters

public DescribedValue[] getMatchParameters()
Returns a single parameter controlling the isotropic error (radius of a match sphere).

Specified by:
getMatchParameters in interface MatchEngine
Specified by:
getMatchParameters in class AbstractCartesianMatchEngine
Returns:
array of described values which influence the match

toString

public java.lang.String toString()
Specified by:
toString in class AbstractCartesianMatchEngine

Copyright © 2004 CLRC: Central Laboratory of the Research Councils. All rights reserved.