| CGI parameters: |
| spatial |
Required |
Type of spatial query: Cone, Box, Polygon, and NONE |
| |
|
polygon
|
Convex polygon of ra dec pairs, separated by comma(,)
Required if spatial=polygon
|
| radius |
Cone search radius
Optional if spatial=Cone, otherwise ignore it
(default 10 arcsec).
|
|
radunits |
Units of a Cone search: arcsec, arcmin, deg.
Optional if spatial=Cone (default= arcsec)
|
|
size |
Width of a box in arcsec
Required if spatial=Box.
|
|
objstr |
Target name or coordinate of the center of a spatial search
center.
Target names must be resolved by SIMBAD or NED.
Required only when spatial=Cone or spatial=Box.
Examples:
M31, 00 42 44.3 -41 16 08,
00h42m44.3s -41d16m08s
Note:
Note: The target name or position must be URL encoded.
Simple way is to replac a space, " ", with plus, "+":
e.g., 00 42 44.3 -41 16 08, 00h42m44.3s -41d16m08s
is decoded as
00+42+44.3+-41+16+08, 00h42m44.3s+-41d16m08s
Click for more information on URL encoding.
|
| |
|
|
catalog |
Required |
Catalog name in the IRSA database management system.
Get catalog names
|
| |
| outfmt |
Optional |
Defines query's output format.
6___ returns a program interface in XML
3___ returns a VO Table (XML)
2___ returns SVC (Software handshaking structure) message
1___ returns an ASCII table
0___ returns Gator Status Page in HTML (default)
|
| |
|
desc |
Optional |
Short description of a specific catalog,
which will appear in the result page.
Optional
|
| |
|
order |
Optional |
Results ordered by this column. |
| |
|
constraint |
Optional |
User defined query constraint(s)
Note: The constraint should follow SQL syntax.
Click for more details.
|
| |
| onlist |
Optional |
1___ catalog is visible through Gator
web interface (default)
0___ catalog has been ingested into IRSA but not yet
visible through web interface.
This parameter will
generally only be set to 0 when users are supporting
testing and
evaluation of new catalogs at IRSA's request.
|
| |
|
server |
Symbolic DataBase Management Server (DBMS) name.
Required only if parameter onlilst= 0.
Get server names
|
|
database |
Name of Database.
Required only if parameter onlist = 0.
Get database names
|
|
ddfile |
The data dictionary file is used to get column
information for
a specific catalog.
Required only if parameter onlist=0
|
|
selcols |
Target column list with value separated by a comma(,).
Optional
The input list always overwrites default selections
defined by a data dictionary.
Required if onlist is 0.
|
|
outrows |
Number of rows retrieved from database.
Optional
The retrieved row number outrows is always less than
or equal to available to be retrieved rows under the
same constraints.
|
|
URL Examples:
The following examples demonstrate program interfaces
that return an ASCII table (outfmt=1)
from the 2MASS All-Sky Point Source Catalog with different formats of an input
object nameor position.
(1) Default Cone Search with a short object name (M31)
(Click to run and view the result)
http://irsa.ipac.caltech.edu/cgi-bin/Gator/nph-query?outfmt=1&objstr=m31&spatial=Cone&catalog=fp_psc
(2) Cone Search with a full object name (MESSIER 031)
(Click to run and view the result)
http://irsa.ipac.caltech.edu/cgi-bin/Gator/nph-query?outfmt=1&objstr=MESSIER+031&spatial=Cone&radius=1&radunits=arcsec&catalog=fp_psc
(3) Cone Search with a coordinate in decimal degree (10.68469 41.26904)
(Click to run and view the result)
http://irsa.ipac.caltech.edu/cgi-bin/Gator/nph-query?outfmt=1&objstr=10.68469+41.26904&spatial=Cone&radius=1&radunits=arcsec&catalog=fp_psc
(4) Cone Search with (00h 42m 44.32s 41d 16m 08.5s)
(Click to run and view the result)
http://irsa.ipac.caltech.edu/cgi-bin/Gator/nph-query?outfmt=1&objstr=00h+42m+44.32s+41d+16m+08.5s&spatial=Cone&radius=1&radunits=arcsec&catalog=fp_psc
(5)Box Search (Click to run and view the result)
http://irsa.ipac.caltech.edu/cgi-bin/Gator/nph-query?outfmt=1&objstr=m31&spatial=Box&size=1&catalog=fp_psc
(6)Polygon Search ordered by J magnitude (Click to run and view the result)
http://irsa.ipac.caltech.edu/cgi-bin/Gator/nph-query?outfmt=1&order=j_m&objstr=m31&spatial=Polygon&polygon=10.1+10.1,10.0+10.1,10+10&catalog=fp_psc
(7)Polygon Search with 3 output rows ordered by J magnitude (Click to run and view the result)
http://irsa.ipac.caltech.edu/cgi-bin/Gator/nph-query?outfmt=1&outrows=3&order=j_m&objstr=m31&spatial=Polygon&polygon=10.1+10.1,10.0+10.1,10+10&catalog=fp_psc
The following example returns a VO Table result for the same query as in example (2).
(8) Cone Search with a full object name (MESSIER 031)
(Click to run and view the result)
http://irsa.ipac.caltech.edu/cgi-bin/Gator/nph-query?outfmt=3&objstr=MESSIER+031&spatial=Cone&radius=1&radunits=arcsec&catalog=fp_psc
The following examples return HTML pages:
(9) Cone Search with a full object name (MESSIER 031)
(Click to run and view the result)
http://irsa.ipac.caltech.edu/cgi-bin/Gator/nph-query?outfmt=0&objstr=MESSIER+031&spatial=Cone&radius=1&radunits=arcsec&catalog=fp_psc
(10) Search with default output format
(Click to run and view the result)
http://irsa.ipac.caltech.edu/cgi-bin/Gator/nph-query?objstr=MESSIER+031&spatial=Cone&radius=1&radunits=arcsec&catalog=fp_psc
The following example uses user specified column names.
(11) Cone Search with column name ra, dec, j_m, h_m, and k_m.
(Click to run and view the result)
http://irsa.ipac.caltech.edu/cgi-bin/Gator/nph-query?outfmt=1&objstr=m31&spatial=Cone&catalog=fp_psc&selcols=ra,dec,j_m,h_m,k_m
The following example returns a SVC handshaking message structure.
(12) Box Search with column name ra, dec, j_m, h_m, and k_m.
(Click to run and view the result)
http://irsa.ipac.caltech.edu/cgi-bin/Gator/nph-query?outfmt=2&objstr=m31&spatial=Box&catalog=fp_psc&selcols=ra,dec,j_m,h_m,k_m&size=10
The following example shows how to encode constraints.
(13)Cone Search with column name ra, dec, j_m, h_m, and k_m
and constraints: j_m between -10 and 10
(Click to run and view the result)
http://irsa.ipac.caltech.edu/cgi-bin/Gator/nph-query?objstr=m31&spatial=Cone&catalog=fp_psc&selcols=ra,dec,j_m,h_m,k_m&constraints=j_m+between+-10+and+10
Note:
The constraint must follow SQL syntax.
Learn more.
The following example demonstrates the structure of a
query to a catalog that has
been ingested into IRSA but is not
visible through the Gator web service.
(14) Cone Search with user requested columns instead of default columns defined in a DD file.
(Click to run and view the result)
http://irsa.ipac.caltech.edu/cgi-bin/Gator/nph-query?objstr=HIP+11&spatial=Cone&radius=1&radunits=arcmin&catalog=st_d01_pos&ddfile=operation@rmt_boulder:stars_dd&server=PRO_DYNAMIC&database=stars_ops&onlist=0&desc=this+is+my+test+case&selcolss=ra,dec&outfmt=1"
Note: The value of parameter selcols
is a list of column names seperated by a comma.
To find column names about a catalog, please use
CatDD server.
The following examples show the error messages returned for five invalid inputs:
(15) Cone Search with an invalid object
(Click to run and view the result)
http://irsa.ipac.caltech.edu/cgi-bin/Gator/nph-query?outfmt=3&objstr=myobject&spatial=Cone&catalog=fp_psc&selcols=ra,dec,j_m,h_m,k_m
(16) An invalid polygon search
(Click to run and view the result)
http://irsa.ipac.caltech.edu/cgi-bin/Gator/nph-query?outfmt=0&spatial=Polygon&catalog=fp_psc&selcols=ra,dec,j_m,h_m,k_m&polygon=12+13,14;
(17) Cone Search with a out range search radius
(Click to run and view the result)
http://irsa.ipac.caltech.edu/cgi-bin/Gator/nph-query?outfmt=1&objstr=m31&spatial=Cone&radius=10&radunits=deg&catalog=fp_psc&selcols=ra,dec,j_m,h_m,k_m
(18) Cone Search with an invalid catalog name
(Click to run and view the result)
http://irsa.ipac.caltech.edu/cgi-bin/Gator/nph-query?outfmt=2&objstr=m31&spatial=Cone&catalog=fp_psc_test&selcols=ra,dec,j_m,h_m,k_m
(19) An invalid parameter name outfmmmt, instead of outfmt.
(Click to run and view the result)
http://irsa.ipac.caltech.edu/cgi-bin/Gator/nph-query?outfmmmt=2&objstr=m31&spatial=Cone&catalog=fp_psc&selcols=ra,dec,j_m,h_m,k_m
Form Examples:
Fill in the parameters according to the descriptions above, then click Submit Query button.
The value of the parameters can be determined with
CatList service.
|
