Package uk.ac.starlink.ttools.join

Class HumanMatchEngine

  • All Implemented Interfaces:
    uk.ac.starlink.table.join.MatchEngine
    public class HumanMatchEngine
extends java.lang.Object
implements uk.ac.starlink.table.join.MatchEngine
    MatchEngine adaptor which transforms the base engine so that it uses more human-friendly units. Currently, this means that it uses eschews radians in favour of degrees or arcseconds for angular quantities; it decides which on the basis of UCDs. In other respects, this engine will behave exactly the same as its base engine. If the base engine has no human-unfriendly units, this one should behave exactly the same.
    Since:
    2 Sep 2005
    Author:
    Mark Taylor

    • Field Summary

      • Fields inherited from interface uk.ac.starlink.table.join.MatchEngine

        NO_BINS

    • Constructor Summary

      Constructors 
      Constructor Description
      HumanMatchEngine​(uk.ac.starlink.table.join.MatchEngine baseEngine)
      Constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean canBoundMatch()  
      java.lang.Object[] getBins​(java.lang.Object[] tuple)  
      uk.ac.starlink.table.join.NdRange getMatchBounds​(uk.ac.starlink.table.join.NdRange[] inRanges, int index)  
      uk.ac.starlink.table.DescribedValue[] getMatchParameters()  
      uk.ac.starlink.table.ValueInfo getMatchScoreInfo()  
      double getScoreScale()  
      uk.ac.starlink.table.DescribedValue[] getTuningParameters()  
      uk.ac.starlink.table.ValueInfo[] getTupleInfos()  
      boolean isLargeAngle​(uk.ac.starlink.table.ValueInfo info)
      Indicates whether a given value is recognised as representing a large angle (such as a coordinate of some kind).
      boolean isSmallAngle​(uk.ac.starlink.table.ValueInfo info)
      Indicates whether a given value is recognised as representing a small angle (such as an error of some kind).
      double matchScore​(java.lang.Object[] tuple1, java.lang.Object[] tuple2)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • HumanMatchEngine

        public HumanMatchEngine​(uk.ac.starlink.table.join.MatchEngine baseEngine)
        Constructor.
        Parameters:
        baseEngine - the match engine supplying the base behaviour for this one

    • Method Detail

      • getMatchParameters

        public uk.ac.starlink.table.DescribedValue[] getMatchParameters()
        Specified by:
        getMatchParameters in interface uk.ac.starlink.table.join.MatchEngine

      • getTuningParameters

        public uk.ac.starlink.table.DescribedValue[] getTuningParameters()
        Specified by:
        getTuningParameters in interface uk.ac.starlink.table.join.MatchEngine

      • getTupleInfos

        public uk.ac.starlink.table.ValueInfo[] getTupleInfos()
        Specified by:
        getTupleInfos in interface uk.ac.starlink.table.join.MatchEngine

      • getBins

        public java.lang.Object[] getBins​(java.lang.Object[] tuple)
        Specified by:
        getBins in interface uk.ac.starlink.table.join.MatchEngine

      • matchScore

        public double matchScore​(java.lang.Object[] tuple1,
                         java.lang.Object[] tuple2)
        Specified by:
        matchScore in interface uk.ac.starlink.table.join.MatchEngine

      • getScoreScale

        public double getScoreScale()
        Specified by:
        getScoreScale in interface uk.ac.starlink.table.join.MatchEngine

      • getMatchScoreInfo

        public uk.ac.starlink.table.ValueInfo getMatchScoreInfo()
        Specified by:
        getMatchScoreInfo in interface uk.ac.starlink.table.join.MatchEngine

      • canBoundMatch

        public boolean canBoundMatch()
        Specified by:
        canBoundMatch in interface uk.ac.starlink.table.join.MatchEngine

      • getMatchBounds

        public uk.ac.starlink.table.join.NdRange getMatchBounds​(uk.ac.starlink.table.join.NdRange[] inRanges,
                                                        int index)
        Specified by:
        getMatchBounds in interface uk.ac.starlink.table.join.MatchEngine

      • isLargeAngle

        public boolean isLargeAngle​(uk.ac.starlink.table.ValueInfo info)
        Indicates whether a given value is recognised as representing a large angle (such as a coordinate of some kind).
        Parameters:
        info - value metadata
        Returns:
        true if info is known to represent a large angle

      • isSmallAngle

        public boolean isSmallAngle​(uk.ac.starlink.table.ValueInfo info)
        Indicates whether a given value is recognised as representing a small angle (such as an error of some kind).
        Parameters:
        info - value metadata
        Returns:
        true if info is known to represent a small angle