public class CuboidCartesianMatchEngine extends AbstractCartesianMatchEngine
Constructor and Description |
---|
CuboidCartesianMatchEngine(double[] errs)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
java.util.function.Supplier<Coverage> |
createCoverageFactory()
Returns a supplier for coverage objects.
|
java.util.function.Supplier<MatchKit> |
createMatchKitFactory()
Returns a factory for MatchKit instances corresponding
to the current settings of this object.
|
double |
getError(int idim)
Returns the matching error in a given dimension.
|
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 the
MatchKit.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.
|
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.
|
String |
toString() |
getBinFactor, getIsotropicScale, getNdim, getScale, getTuningParameters, setBinFactor, setIsotropicScale
public CuboidCartesianMatchEngine(double[] errs)
errs
- initial axis lengths of the error ellipsepublic void setError(int idim, double err)
idim
- dimension indexerr
- axis length of error ellipse in dimension idim
public double getError(int idim)
idim
- dimension indexidim
protected void setScale(int idim, double err)
AbstractCartesianMatchEngine
setScale
in class AbstractCartesianMatchEngine
idim
- dimension indexerr
- guide error distance in dimension idim
public ValueInfo[] getTupleInfos()
MatchEngine
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).public DescribedValue[] getMatchParameters()
MatchEngine
DescribedValue.setValue(java.lang.Object)
on the
returned objects.public ValueInfo getMatchScoreInfo()
MatchEngine
MatchKit.matchScore(java.lang.Object[], java.lang.Object[])
method. The content class should be numeric
(though need not be Double
), and the name,
description and units should be descriptive of whatever the
physical significance of the value is.
If the result of matchScore
is not interesting
(for instance, if it's always either 0 or -1),
null
may be returned.public java.util.function.Supplier<MatchKit> createMatchKitFactory()
MatchEngine
The returned value is immutable, and is not affected by subsequent changes of the settings of this object.
public java.util.function.Supplier<Coverage> createCoverageFactory()
MatchEngine
Coverage.createTestFactory()
method returns false
is guaranteed not to match any tuple in A according to this object's
match criteria.
The returned value is immutable, and is not affected by subsequent changes of the settings of this object.
If no suitable implementation is available, null may be returned.
public double getScoreScale()
MatchEngine
matchScore
/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.
public String toString()
toString
in class AbstractCartesianMatchEngine
Copyright © 2024 Central Laboratory of the Research Councils. All Rights Reserved.