HTM SpatialIndex Class Reference

class htmSqlInterface

htmSqlInterface class

Public Methods

	htmSqlInterface (size_t depth = 0) Constructor
HTM_ID	lookupID (char *) Lookup a node ID from a string command
MsgStr	lookupIDDiagnostic (char *) Check the lookupID syntax
size_t	intersect1 ( char*, ValueVector & ) Intersect function 1
size_t	intersect2 ( char*, ValueVector & ) Intersect function 2
size_t	circleRegion ( char *, ValueVector & ) Request all triangles in a circular region
MsgStr	circleRegionDiagnostic (char *) Check the circleRegion syntax
size_t	convexHull ( char *str, ValueVector & ) Request all triangles in the convex hull of a given set of points
MsgStr	convexHullDiagnostic (char *) Check convexHull Syntax
size_t	domain ( char *str, ValueVector & ) String interface for domain intersection
MsgStr	domainDiagnostic (char *) Check the domain syntax
bool	err () Test whether the call gave an error
MsgStr	error () Retrieve error message

htmSqlInterface(size_t depth = 0)

Constructor

HTM_ID lookupID(char *)

Lookup a node ID from a string command. The string in the input may have one of the following forms:

• "J2000 depth ra dec"
• "CARTESIAN depth x y z"
• "NAME name"

The string will be evaluated depending on how many items it has.

MsgStr lookupIDDiagnostic(char *)

Check the lookupID syntax

size_t intersect1( char*, ValueVector & )

Intersect function 1. The string passed to this command can be any of the strings accepted by the circleRegion, convexHull or domain methods. The circleRegion string needs to have a prefix CIRCLE and the convexHull string needs to have a prefix CONVEX to be recognized.

So the accepted strings are

• "CIRCLE J2000 depth ra dec rad"
• "CIRCLE CARTESIAN depth x y z rad"
• "CONVEX J2000 depth ra dec ra dec ra dec "
• "CONVEX CARTESIAN depth x y z x y z x y z "
• the same domain string as in the domain() method

size_t intersect2( char*, ValueVector & )

Intersect function 2. This only differs from the version above that the depth parameter is omitted. The constructor has to be given the depth at which the intersection will operate.

So the accepted strings are

• "CIRCLE J2000 ra dec rad"
• "CIRCLE CARTESIAN x y z rad"
• "CONVEX J2000 ra dec ra dec ra dec "
• "CONVEX CARTESIAN x y z x y z x y z "
• the same domain string as in the domain() method except for the depth parameter.

size_t circleRegion( char *, ValueVector & )

Request all triangles in a circular region. Given are the center coordinate and radius in arcminutes. The Vector to fill and its size are given back. The size is also the return value.

• "J2000 depth ra dec rad"
• "CARTESIAN depth x y z rad"

MsgStr circleRegionDiagnostic(char *)

Check the circleRegion syntax

size_t convexHull( char *str, ValueVector & )

Request all triangles in the convex hull of a given set of points. The points are given in the string in the following form:

" J2000 depth ra dec ra dec ra dec "  

or

" CARTESIAN depth x y z x y z x y z "
" J2000 depth ra dec ra dec ra dec "  

or

" CARTESIAN depth x y z x y z x y z "

There may be as many points ra, dec or x,y,z as you want.

The vector to be filled will be cleared by the routine.

MsgStr convexHullDiagnostic(char *)

Check convexHull Syntax

size_t domain( char *str, ValueVector & )

String interface for domain intersection. The domain should be given in the following form:

DOMAIN depth
nConvexes
nConstraints in convex 1
x y z d
x y z d
.
.
x y z d
nConstraints in convex 2
x y z d
x y z d
.
.
x y z d
.
.
.
nConstrinats in convex n
x y z d
x y z d
.
.
x y z d


The numbers need to be separated by whitespace (newlines are allowed).



 MsgStr  domainDiagnostic(char *)
Check the domain syntax 



 bool  err()
Test whether the call gave an error 



 MsgStr  error()
Retrieve error message 

This class has no child classes.

alphabetic index hierarchy of classes

© Copyright 2000 Peter Z. Kunszt, Alex S. Szalay, Aniruddha R. Thakar @ The Johns Hopkins University under the GNU GENERAL PUBLIC LICENSE
Peter Z. Kunszt,

generated by doc++