edu.jhu.htm.core
Interface HTMindex

All Known Implementing Classes:
HTMindexImp

public interface HTMindex

The HTMindex is the main interface for the HTM implementation. It provides the functionality called for in "Redesiging the HTM interface". The HTMindexImp provides an implementation of this. HTMfunc provides some of this funtionality albeit with different signatures. HTMindexImp uses HTMfunc where appropriate haence answers from the two should not differ.

  Current Version
  ===============
  ID:	$Id: HTMindex.java,v 1.2 2003/02/19 15:46:11 womullan Exp $
  Revision: 	$Revision: 1.2 $
  Date/time:	$Date: 2003/02/19 15:46:11 $
 


Method Summary
 double area(java.lang.String htmName)
          give the area of the triangle secrad for HTM name given
 Domain compliment(Domain d)
          Return a new domain which contains everything not in the given domain
 boolean contains(Domain d, Vector3d p)
          does the domain coaintain thie given point
 double distance(long htmId1, long htmId2)
          angular distance between the two ids
 double distance(java.lang.String htmName1, java.lang.String htmName2)
          angular distance between the two names
 java.lang.String idToName(long htmId)
          Convert id number to Symbolic name
 Vector3d idToPoint(long htmId)
          return center vector of the tringle which htmId relates to
 Vector3d idToPoint(java.lang.String htmName)
          return center vector of the tringle which htmName relates to
 HTMrange intersect(Domain d)
          Return all HTMs which fall inside the given domain
 Domain intersection(Domain d1, Domain d2)
          Return a new domain contiainig common parts of the two domains
 java.lang.String lookup(double ra, double dec)
          return a HTM name like N2121 for a given position
 java.lang.String lookup(Vector3d point)
          return a HTM name like N2121 for a given vector
 long lookupId(double ra, double dec)
          return a HTM id number for a given position
 long lookupId(Vector3d point)
          return a HTM id number for a given vector
 long nameToId(java.lang.String name)
          Convert Symbolic name to an id number
 Domain simplify(Domain d)
          return a HTM id number for a given position
 Domain smooth(Domain d)
          Perform lossy simplification of the domain
 Domain union(Domain d1, Domain d2)
          Return a new domain contiainig all parts of the two domains
 

Method Detail

lookup

public java.lang.String lookup(Vector3d point)
                        throws HTMException
return a HTM name like N2121 for a given vector

HTMException

lookup

public java.lang.String lookup(double ra,
                               double dec)
                        throws HTMException
return a HTM name like N2121 for a given position

HTMException

lookupId

public long lookupId(Vector3d point)
              throws HTMException
return a HTM id number for a given vector

HTMException

lookupId

public long lookupId(double ra,
                     double dec)
              throws HTMException
return a HTM id number for a given position

HTMException

idToPoint

public Vector3d idToPoint(long htmId)
                   throws HTMException
return center vector of the tringle which htmId relates to

HTMException

idToPoint

public Vector3d idToPoint(java.lang.String htmName)
                   throws HTMException
return center vector of the tringle which htmName relates to

HTMException

nameToId

public long nameToId(java.lang.String name)
              throws HTMException
Convert Symbolic name to an id number

HTMException

idToName

public java.lang.String idToName(long htmId)
                          throws HTMException
Convert id number to Symbolic name

HTMException

simplify

public Domain simplify(Domain d)
return a HTM id number for a given position


area

public double area(java.lang.String htmName)
give the area of the triangle secrad for HTM name given


contains

public boolean contains(Domain d,
                        Vector3d p)
does the domain coaintain thie given point


distance

public double distance(long htmId1,
                       long htmId2)
                throws HTMException
angular distance between the two ids

HTMException

distance

public double distance(java.lang.String htmName1,
                       java.lang.String htmName2)
                throws HTMException
angular distance between the two names

HTMException

intersect

public HTMrange intersect(Domain d)
Return all HTMs which fall inside the given domain


intersection

public Domain intersection(Domain d1,
                           Domain d2)
Return a new domain contiainig common parts of the two domains


union

public Domain union(Domain d1,
                    Domain d2)
Return a new domain contiainig all parts of the two domains


compliment

public Domain compliment(Domain d)
Return a new domain which contains everything not in the given domain


smooth

public Domain smooth(Domain d)
Perform lossy simplification of the domain