From fa080de7afc95aa1c19a6e6fc0e0708ced2eadc4 Mon Sep 17 00:00:00 2001 From: Joseph Hunkeler Date: Wed, 8 Jul 2015 20:46:52 -0400 Subject: Initial commit --- vendor/voclient/doc/OLD/vosloanspec.html | 236 +++++++++++++++++++++++++++++++ 1 file changed, 236 insertions(+) create mode 100644 vendor/voclient/doc/OLD/vosloanspec.html (limited to 'vendor/voclient/doc/OLD/vosloanspec.html') diff --git a/vendor/voclient/doc/OLD/vosloanspec.html b/vendor/voclient/doc/OLD/vosloanspec.html new file mode 100644 index 00000000..bd89781f --- /dev/null +++ b/vendor/voclient/doc/OLD/vosloanspec.html @@ -0,0 +1,236 @@ +Content-type: text/html + +Manpage of VOSLOANSPEC + +

VOSLOANSPEC

+Section: User Commands (1)
Updated: Feb 2013
Index +Return to Main Contents

+ + +

NAME

+ +vosloanspec - Query for SDSS spectra +

+ +

SYNOPSIS

+ +vosloanspec [<opts>] <obj> | {<ra> <dec>} | {<ra> <dec> <radius>} +

+ +

OPTIONS

+ +The vosloanspec application accepts the following options: +

-h, --help + +: +Print a help summary to the terminal and exit. No processing is done +following this flag. +
+
-P RA,DEC, --pos=RA,DEC + +: +Set the query position (dec degrees). +
-R REL, --release=REL + +: +Data release to query, allowed values are 'dr8' or 'dr9', the default is +to use whatever version is defined by the service as 'current'. +
-s RADIUS, --size=RADIUS + +: +Set query radius (dec degrees). The service imposes a max query radius of 10 +degrees. +
-t TYPE, --type=TYPE + +: +Object type constraint. If not specified then all available spectra will +be returned, allowed values for the constraint are 'galaxy', 'qso' and 'star'. +
-z ZRANGE, --redshift=ZRANGE + +: +Select by redshift range string(s). A range is specified as two values +separated by a hyphen character (e.g. "0.1-0.3"), multiple ranges may be +specified in a comma-delimited list (e.g. "0.1-0.3,1.0-1.5"). +
+
-c, --count + +: +Return only count of results available. +
-m, --meta + +: +Print result position metadata. +
-D, --delete + +: +Delete spectra after printing metadata. In order to obtain the metadata, the +data are actually downloaded and then read, this option will delete these +files once the task exits. +
-l N, --limit=N + +: +Limit to top N results. +
-u, --urls + +: +Get urls to spectra only. +
+
-S, --samp + +: +Broadcase urls as a SAMP spectrum message. +
-T, --table + +: +Broadcase urls as SAMP load VOTable message. +
-N N, --num=N + +: +Number of download threads to run in parallel (default: 12). +
+
-f FILE, --file=FILE + +: +Input file of positions. +
-b FILE, --base=FILE + +: +Base filename of downloaded files. +
-O FILE, --output=FILE + +: +Output file for results. +
-o OBJ, --object=OBJ + +: +Object name to resolve to query position. +
+

+ +

DESCRIPTION

+ +The vosloanspec task provides access to Data Release 9 of +the SDSS III Spectral Data. This dataset contains over 1.5 million galaxies, +230,000 quasars, and 670,000 stars covering 14,500 square degrees of the sky. +

+ +Queries by position may be done using either a resolvable object name or an +explicit (RA,Dec) position given in ICRS decimal degrees. The -P flag +can be used to specify the position as a single argument. The default query +size is 0.25 degrees and may be changed using the -s flag. If the +DR8 release of the dataset is desired the -R dr8 option may be used, +by default the task will use whichever data release is deemed 'current' y +the service (DR9 as of this writing). Spectra may be limited to a selection +of just 'galaxy', 'qso' or 'star' objects using the -t option. The +-z option may be used to constrain the search by range of redshift +values. +

+ +Unless otherwise modified, the task will automatically download FITS spectra +for all objects within the query region. The -m flag will print the +positions of each object found (e.g. for marking an overlay), the -u +flag will print the access URLs for the spectra. In the case of position +metadata the FITS files must actually be downloaded to the local machine +since the service doesn't provide this in a query return, the -D +flag will delete these images after the information is obtained. +

+ +To broadcast the spectra to SAMP-enabled applications using the +spectrum.load.ssa-generic message type, the -S option may be used. +The spectrum may be broadcast as a table.load.FITS message by specifying +the -T flag. +

+ +

REFERENCES

+ +This task is based on the API available from +

+      http://api.sdss3.org/
+

+ +See the documentation at this site for additional information about +parameters. The vosloanspec task attempts to provide a useful data +client using a non-VO interface and will eventually be replaced by a +task with similar functionality using standard SSA services. +

+ +

RETURN STATUS

+ +On exit the votcnv task will return a zero indicating success, or a +one indicating an error. +

+ +

EXAMPLES

+ +

1) Download all galaxy spectra w/in 0.1 deg of the Hubble Ultra Deep Field:

+  % vosloanspec -s 0.1 -t galaxy HUDF
+  % vosloanspec --size=0.1 --type=galaxy HUDF
+

+ +

2) Get only the positions of the SDSS spectra around a point:

+  % vosloanspec -m -D m51
+  % vosloanspec --meta --delete m51
+

+ +

3) Broadcast 5 spectra around 3c273 to SAMP-enabled apps:

+  % vosloanspec -l 5 --samp 3c273     # as a spectrum msg
+  % vosloanspec -l 5 --samp --table 3c273     # as a table msg
+

+ +

4) Get all QSO spectra with a redshift > 0.3 (Note an upper range must be specified for the redshift range for a valid query):

+  % vosloanspec --redshift=0.3-1.0
+

+ +

BUGS

+ +No known bugs with this release. + +

Revision History

+ +Feb 2013 - First public release + +

Author

+ +Michael Fitzpatrick (fitz@noao.edu), Feb 2013 + +

+This document was created by +man2html, +using the manual pages.
+Time: 05:13:25 GMT, April 14, 2013 + + -- cgit