Class CuboidCartesianMatchEngine
- java.lang.Object
-
- uk.ac.starlink.table.join.AbstractCartesianMatchEngine
-
- uk.ac.starlink.table.join.CuboidCartesianMatchEngine
-
- All Implemented Interfaces:
MatchEngine
public class CuboidCartesianMatchEngine extends AbstractCartesianMatchEngine
Matchers which matches within a cuboidal shape in a Cartesian space. This differs from most of the other N-dimensional match engines which use an ellipsoid of some sort. It may be useful for identifying associations with pixels etc. Tuples are just N-element position coordinate vectors.- Since:
- 10 Feb 2014
- Author:
- Mark Taylor
-
-
Field Summary
-
Fields inherited from interface uk.ac.starlink.table.join.MatchEngine
NO_BINS
-
-
Constructor Summary
Constructors Constructor Description CuboidCartesianMatchEngine(double[] errs)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
canBoundMatch()
Indicates that theMatchEngine.getMatchBounds(uk.ac.starlink.table.join.NdRange[], int)
method can be invoked to provide some sort of useful result.java.lang.Object[]
getBins(java.lang.Object[] tuple)
Returns a set of keys for bins into which possible matches for a given tuple might fall.double
getError(int idim)
Returns the matching error in a given dimension.NdRange
getMatchBounds(NdRange[] inRanges, int index)
Given a range of tuple values, returns a range outside which no match to anything within that range can result.DescribedValue[]
getMatchParameters()
Returns a set of DescribedValue objects whose values can be modified to modify the matching criteria.ValueInfo
getMatchScoreInfo()
Returns a description of the value returned by theMatchEngine.matchScore(java.lang.Object[], java.lang.Object[])
method.double
getScoreScale()
Returns a scale value for the match score.ValueInfo[]
getTupleInfos()
Returns a set of ValueInfo objects indicating what is required for the elements of each tuple.double
matchScore(java.lang.Object[] tuple1, java.lang.Object[] tuple2)
Indicates whether two tuples count as matching each other, and if so how closely.void
setError(int idim, double err)
Sets the matching error in a given dimension.protected void
setScale(int idim, double err)
Sets the scale value for a given dimension.java.lang.String
toString()
-
Methods inherited from class uk.ac.starlink.table.join.AbstractCartesianMatchEngine
getBinFactor, getIsotropicScale, getNdim, getRadiusBins, getScale, getScaleBins, getTuningParameters, setBinFactor, setIsotropicScale
-
-
-
-
Constructor Detail
-
CuboidCartesianMatchEngine
public CuboidCartesianMatchEngine(double[] errs)
Constructor. The initial values of the ellipse principal axis lengths are specified here; the dimensionality of the space is defined by the length of this array.- Parameters:
errs
- initial axis lengths of the error ellipse
-
-
Method Detail
-
setError
public void setError(int idim, double err)
Sets the matching error in a given dimension.- Parameters:
idim
- dimension indexerr
- axis length of error ellipse in dimensionidim
-
getError
public double getError(int idim)
Returns the matching error in a given dimension.- Parameters:
idim
- dimension index- Returns:
- axis length of error ellipse in dimension
idim
-
setScale
protected void setScale(int idim, double err)
Description copied from class:AbstractCartesianMatchEngine
Sets the scale value for a given dimension. In conjunction with the bin factor, this determines the bin size.- Overrides:
setScale
in classAbstractCartesianMatchEngine
- Parameters:
idim
- dimension indexerr
- guide error distance in dimensionidim
-
getTupleInfos
public ValueInfo[] getTupleInfos()
Description copied from interface:MatchEngine
Returns a set of ValueInfo objects indicating what is required for the elements of each tuple. The length of this array is the number of elements in the tuple. Each element should at least have a defined name and content class. The info's nullable attribute has a special meaning: if true it means that it makes sense for this element of the tuple to be always blank (for instance assigned to no column).- Returns:
- array of objects describing the requirements on each element of the tuples used for matching
-
getMatchParameters
public DescribedValue[] getMatchParameters()
Description copied from interface:MatchEngine
Returns a set of DescribedValue objects whose values can be modified to modify the matching criteria. Typically at least one of these will be some sort of tolerance separation which determines how close tuples must be to count as a match. This match engine's behaviour can be modified by callingDescribedValue.setValue(java.lang.Object)
on the returned objects.- Returns:
- array of described values which influence the match
-
getMatchScoreInfo
public ValueInfo getMatchScoreInfo()
Description copied from interface:MatchEngine
Returns a description of the value returned by theMatchEngine.matchScore(java.lang.Object[], java.lang.Object[])
method. The content class should be numeric (though need not beDouble
), and the name, description and units should be descriptive of whatever the physical significance of the value is. If the result ofmatchScore
is not interesting (for instance, if it's always either 0 or -1),null
may be returned.- Returns:
- metadata for the match score results
-
matchScore
public double matchScore(java.lang.Object[] tuple1, java.lang.Object[] tuple2)
Description copied from interface:MatchEngine
Indicates whether two tuples count as matching each other, and if so how closely. If tuple1 and tuple2 are considered as a matching pair, then a non-negative value should be returned indicating how close the match is - the higher the number the worse the match, and a return value of zero indicates a 'perfect' match. If the two tuples do not consitute a matching pair, then a negative number (conventionally -1.0) should be returned. This return value can be thought of as (and will often correspond physically with) the distance in some real or notional space between the points represented by the two submitted tuples.If there's no reason to do otherwise, the range 0..1 is recommended for successul matches. However, if the result has some sort of physical meaning (such as a distance in real space) that may be used instead.
- Parameters:
tuple1
- one tupletuple2
- the other tuple- Returns:
- 'distance' between tuple1 and tuple2; 0 is a perfect match, larger values indicate worse matches, negative values indicate no match
-
getBins
public java.lang.Object[] getBins(java.lang.Object[] tuple)
Description copied from interface:MatchEngine
Returns a set of keys for bins into which possible matches for a given tuple might fall. The returned objects can be anything, but should have their equals and hashCode methods implemented properly for comparison.- Parameters:
tuple
- tuple- Returns:
- set of bin keys which might be returned by invoking this method on other tuples which count as matches for the submitted tuple
-
canBoundMatch
public boolean canBoundMatch()
Description copied from interface:MatchEngine
Indicates that theMatchEngine.getMatchBounds(uk.ac.starlink.table.join.NdRange[], int)
method can be invoked to provide some sort of useful result.- Returns:
- true iff getMatchBounds may provide useful information
-
getScoreScale
public double getScoreScale()
Description copied from interface:MatchEngine
Returns a scale value for the match score. The intention is that the result ofmatchScore
/MatchEngine.getScoreScale()
is of order unity, and is thus comparable between different match engines.As a general rule, the result should be the maximum value ever returned from the
matchScore
method, corresponding to the least good successful match. For binary MatchEngine implementations (all matches are either score=0 or failures) a value of 1 is recommended. If nothing reliable can be said about the scale, NaN may be returned.- Returns:
- scale of successful match scores, a positive finite number or NaN
-
getMatchBounds
public NdRange getMatchBounds(NdRange[] inRanges, int index)
Description copied from interface:MatchEngine
Given a range of tuple values, returns a range outside which no match to anything within that range can result. If the tuples on which this engine works represent some kind of space, the input values and output values specify a hyper-rectangular region of this space. In the common case in which the match criteria are based on proximity in this space up to a certain error, this method should return a rectangle which is like the input one but broadened in each direction by an amount corresponding to the error.Both the input and output rectangles are specified by tuples representing its opposite corners; equivalently, they are the minimum and maximum values of each tuple element. In either the input or output min/max tuples, any element may be null to indicate that no information is available on the bounds of that tuple element (coordinate).
An array of n-dimensional ranges is given, though only one of them (specified by the
index
value) forms the basis for the output range. The other ranges in the input array may in some cases be needed as context in order to do the calculation. If the match error is fixed, only the single input n-d range is needed to work out the single output range. However, if the errors are obtained by looking at the tuples themselves (match errors are per-row) then in general the broadening has to be done using the maximum error of any of the tables involved in the match, not just the one to be broadened. For a long time, I didn't realise this, so versions of this software up to STIL v3.0-14 (Oct 2015) were not correctly broadening these ranges, leading to potentially missed associations near the edge of bounded regions.This method can be used by match algorithms which know in advance the range of coordinates they will match against and wish to reduce workload by not attempting matches which are bound to fail.
For example, a 1-d Cartesian match engine with an isotropic match error 0.5 would turn input values of ((0,200),(10,210)) into output values ((-0.5,199.5),(10.5,210.5)).
This method will only be called if
MatchEngine.canBoundMatch()
returns true. Thus engines that cannot provide any useful information along these lines (for instance because none of its tuple elements isComparable
) do not need to implement it in a meaningful way.- Parameters:
inRanges
- array of input ranges for the tables on which the match will take place; each element bounds the values for each tuple element in its corresponding table in a possible match (to put it another way - each element gives the coordinates of the opposite corners of a tuple-space rectangle covered by one input table)index
- which element of theinRanges
array for which the broadened output value is required- Returns:
- output range, effectively
inRanges[index]
broadened by errors - See Also:
MatchEngine.canBoundMatch()
-
toString
public java.lang.String toString()
- Specified by:
toString
in classAbstractCartesianMatchEngine
-
-