diff options
Diffstat (limited to 'vendor/voclient/doc/OLD/vosloanspec.html')
| -rw-r--r-- | vendor/voclient/doc/OLD/vosloanspec.html | 236 |
1 files changed, 236 insertions, 0 deletions
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 + +<HTML><HEAD><TITLE>Manpage of VOSLOANSPEC</TITLE> +</HEAD><BODY> +<H1>VOSLOANSPEC</H1> +Section: User Commands (1)<BR>Updated: Feb 2013<BR><A HREF="#index">Index</A> +<A HREF="http://localhost/cgi-bin/man/man2html">Return to Main Contents</A><HR> + +<A NAME="lbAB"> </A> +<H2>NAME</H2> + +vosloanspec - Query for SDSS spectra +<P> +<A NAME="lbAC"> </A> +<H2>SYNOPSIS</H2> + +<B>vosloanspec</B> [<opts>] <obj> | {<ra> <dec>} | {<ra> <dec> <radius>} +<P> +<A NAME="lbAD"> </A> +<H2>OPTIONS</H2> + +The <I>vosloanspec</I> application accepts the following options: +<DL COMPACT> +<DT><B>-h, --help</B> + +<DD> +Print a help summary to the terminal and exit. No processing is done +following this flag. +<P> +<DT><B>-P </B><I>RA</I>,<I>DEC</I>, --pos=<I>RA</I>,<I>DEC</I> + +<DD> +Set the query position (dec degrees). +<DT><B>-R </B><I>REL</I>, --release=<I>REL</I> + +<DD> +Data release to query, allowed values are 'dr8' or 'dr9', the default is +to use whatever version is defined by the service as 'current'. +<DT><B>-s </B><I>RADIUS</I>, --size=<I>RADIUS</I> + +<DD> +Set query radius (dec degrees). The service imposes a max query radius of 10 +degrees. +<DT><B>-t </B><I>TYPE</I>, --type=<I>TYPE</I> + +<DD> +Object type constraint. If not specified then all available spectra will +be returned, allowed values for the constraint are 'galaxy', 'qso' and 'star'. +<DT><B>-z </B><I>ZRANGE</I>, --redshift=<I>ZRANGE</I> + +<DD> +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"). +<P> +<DT><B>-c, --count</B> + +<DD> +Return only count of results available. +<DT><B>-m, --meta</B> + +<DD> +Print result position metadata. +<DT><B>-D, --delete</B> + +<DD> +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. +<DT><B>-l </B><I>N</I>, --limit=<I>N</I> + +<DD> +Limit to top <I>N</I> results. +<DT><B>-u, --urls</B> + +<DD> +Get urls to spectra only. +<P> +<DT><B>-S, --samp</B> + +<DD> +Broadcase urls as a SAMP spectrum message. +<DT><B>-T, --table</B> + +<DD> +Broadcase urls as SAMP load VOTable message. +<DT><B>-N </B><I>N</I>, --num=<I>N</I> + +<DD> +Number of download threads to run in parallel (default: 12). +<P> +<DT><B>-f </B><I>FILE</I>, --file=<I>FILE</I> + +<DD> +Input file of positions. +<DT><B>-b </B><I>FILE</I>, --base=<I>FILE</I> + +<DD> +Base filename of downloaded files. +<DT><B>-O </B><I>FILE</I>, --output=<I>FILE</I> + +<DD> +Output file for results. +<DT><B>-o </B><I>OBJ</I>, --object=<I>OBJ</I> + +<DD> +Object name to resolve to query position. +<P> +</DL> +<A NAME="lbAE"> </A> +<H2>DESCRIPTION</H2> + +The <I>vosloanspec</I> 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. +<P> + +Queries by position may be done using either a resolvable object name or an +explicit (RA,Dec) position given in ICRS decimal degrees. The <I>-P</I> 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 <I>-s</I> flag. If the +DR8 release of the dataset is desired the <I>-R dr8</I> 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 <I>-t</I> option. The +<I>-z</I> option may be used to constrain the search by range of redshift +values. +<P> + +Unless otherwise modified, the task will automatically download FITS spectra +for all objects within the query region. The <I>-m</I> flag will print the +positions of each object found (e.g. for marking an overlay), the <I>-u</I> +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 <I>-D</I> +flag will delete these images after the information is obtained. +<P> + +To broadcast the spectra to SAMP-enabled applications using the +<I>spectrum.load.ssa-generic</I> message type, the <I>-S</I> option may be used. +The spectrum may be broadcast as a <I>table.load.FITS</I> message by specifying +the <I>-T</I> flag. +<P> +<A NAME="lbAF"> </A> +<H2>REFERENCES</H2> + +This task is based on the API available from +<P> +<PRE> + <A HREF="http://api.sdss3.org/">http://api.sdss3.org/</A> +</PRE> + +See the documentation at this site for additional information about +parameters. The <I>vosloanspec</I> 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. +<P> +<A NAME="lbAG"> </A> +<H2>RETURN STATUS</H2> + +On exit the <B>votcnv</B> task will return a zero indicating success, or a +one indicating an error. +<P> +<A NAME="lbAH"> </A> +<H2>EXAMPLES</H2> + +<DL COMPACT> +<DT>1) Download all galaxy spectra w/in 0.1 deg of the Hubble Ultra Deep Field:<DD> +<P> +<PRE> + % vosloanspec -s 0.1 -t galaxy HUDF + % vosloanspec --size=0.1 --type=galaxy HUDF +</PRE> + +<DT>2) Get only the positions of the SDSS spectra around a point:<DD> +<P> +<PRE> + % vosloanspec -m -D m51 + % vosloanspec --meta --delete m51 +</PRE> + +<DT>3) Broadcast 5 spectra around 3c273 to SAMP-enabled apps:<DD> +<P> +<PRE> + % vosloanspec -l 5 --samp 3c273 # as a spectrum msg + % vosloanspec -l 5 --samp --table 3c273 # as a table msg +</PRE> + +<DT>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):<DD> +<P> +<PRE> + % vosloanspec --redshift=0.3-1.0 +</PRE> + +<P> +</DL> +<A NAME="lbAI"> </A> +<H2>BUGS</H2> + +No known bugs with this release. +<A NAME="lbAJ"> </A> +<H2>Revision History</H2> + +Feb 2013 - First public release +<A NAME="lbAK"> </A> +<H2>Author</H2> + +Michael Fitzpatrick (<A HREF="mailto:fitz@noao.edu">fitz@noao.edu</A>), Feb 2013 +<A NAME="lbAL"> </A> +<H2>SEE ALSO</H2> + +vodata, vospectra, voregistry, votopic +<P> + +<HR> +<A NAME="index"> </A><H2>Index</H2> +<DL> +<DT><A HREF="#lbAB">NAME</A><DD> +<DT><A HREF="#lbAC">SYNOPSIS</A><DD> +<DT><A HREF="#lbAD">OPTIONS</A><DD> +<DT><A HREF="#lbAE">DESCRIPTION</A><DD> +<DT><A HREF="#lbAF">REFERENCES</A><DD> +<DT><A HREF="#lbAG">RETURN STATUS</A><DD> +<DT><A HREF="#lbAH">EXAMPLES</A><DD> +<DT><A HREF="#lbAI">BUGS</A><DD> +<DT><A HREF="#lbAJ">Revision History</A><DD> +<DT><A HREF="#lbAK">Author</A><DD> +<DT><A HREF="#lbAL">SEE ALSO</A><DD> +</DL> +<HR> +This document was created by +<A HREF="http://localhost/cgi-bin/man/man2html">man2html</A>, +using the manual pages.<BR> +Time: 05:13:25 GMT, April 14, 2013 +</BODY> +</HTML> |