diff options
Diffstat (limited to 'vendor/voclient/doc/voatlas.html')
| -rw-r--r-- | vendor/voclient/doc/voatlas.html | 222 |
1 files changed, 222 insertions, 0 deletions
diff --git a/vendor/voclient/doc/voatlas.html b/vendor/voclient/doc/voatlas.html new file mode 100644 index 00000000..a0458197 --- /dev/null +++ b/vendor/voclient/doc/voatlas.html @@ -0,0 +1,222 @@ +Content-type: text/html + +<HTML><HEAD><TITLE>Manpage of VOATLAS</TITLE> +</HEAD><BODY> +<H1>VOATLAS</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> + +voatlas - Query the SkyView Image service for an all-sky image +<P> +<A NAME="lbAC"> </A> +<H2>SYNOPSIS</H2> + +<B>voatlas</B> [<opts>] [<field> | <pos>] +<P> +<A NAME="lbAD"> </A> +<H2>OPTIONS</H2> + +The <I>voatlas</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>-b </B><I>BPASS</I>,--band <I>BPASS</I> + +<DD> +Bandpass of image to retrieve. Allowed values are 'optical', 'infrared' (or + +bandpass name is used. +<DT><B>-p,--survey </B><I>SURVEY</I> + +<DD> +Survey program name. The list of available surveys is described at +<I><A HREF="http://skyview.gsfc.nasa.gov/cgi-bin/survey.pl">http://skyview.gsfc.nasa.gov/cgi-bin/survey.pl</A></I>. +<DT><B>-g,--graphic</B> + +<DD> +Get a graphic image (i.e. a JPEG), the default is to get a FITS image. +<DT><B>-n,--naxis </B><I>NPIX</I> + +<DD> +Set returned image size. The default image size returned is 512x512. +<P> +<DT><B>-s,--size </B><I>SIZE</I> + +<DD> +Field size to generate. The SIZE value may be appended with an 's', + +(default) respectively. The default size is 0.25 degrees. +<DT><B>-F,--field </B><I>FIELD</I> + +<DD> +Name of the field (e.g. an object name like 'M33') to query. The object +name must be resolvable with a task like VOSESAME, the position returned +will be the center of the query. +<DT><B>-R </B><I>RA</I>,--ra <I>RA</I> + +<DD> +The RA position of the query. +<DT><B>-D </B><I>DEC</I>,--dec <I>DEC</I> + +<DD> +The Dec position of the query. +<DT><B>-P </B><I>RA,DEC</I>,--pos <I>RA,DEC</I> + +<DD> +Specify the query position as a comma-delimited string of RA and DEC. +<DT><B>-S,--samp</B> + +<DD> +Broadcast resulting image as a SAMP message. The image will be broadcast +using the 'image.load.fits' mtype. +<DT><B>-v,--verbose</B> + +<DD> +Print verbose output during execution. +<DT><B>-o </B><I>NAME</I>, --output <I>output</I> + +<DD> +Specify the filename of the downloaded image. If not specified a name +created from the field name or position will be used. +<P> +</DL> +<A NAME="lbAE"> </A> +<H2>DESCRIPTION</H2> + +The <I>voatlas</I> task queries the NASA SkyView all-sky survey data for +an image of the requested sky position in the requested bandpass. The +position may be given as the name of an object who's coordinate can be +resolved, or as an explicit position in RA and Dec (ICRS decimal degrees). +The default field of view will be 0.25 degrees but may be changed using +the <I>-s</I> option (with an optional 's', 'm' or 'd' on the value to +specify arcseconds, arcminutes or degrees respectively). The default +image will be in FITS format unless the <I>-g</I> option is set to request +a graphic such as a JPEG, the default size will be 512x512 pixels unless the +<I>-n</I> option is used to set a different size (the image will always +be square so only one value is required). The resulting image may be +broadcast using the SAMP 'image.load.FITS' mtype by setting the <I>-S</I> +option. +<P> + +The <I>-b</I> flag is used to select the desired bandpass, if not set then +and optical image from the DSS2B survey is used by default. Allowed values +for the bandpass string and their corresponding survey names are: +<P> + +<I>Bandpass<TT> </TT> ShortName<TT> </TT>Title</I><BR> + +optical<TT> </TT> DSS<TT> </TT><TT> </TT>Digital Sky Survey<BR> + +infrared<TT> </TT> 2MASSK<TT> </TT>Two-micron All Sky Survey (K-band)<BR> + +x-ray<TT> </TT> PSPC2INT<TT> </TT>ROSAT PSPC (2-deg cutoff)<BR> + +euv<TT> </TT><TT> </TT> EUV83<TT> </TT><TT> </TT>EUV Explorer83A<BR> + +gamma-ray<TT> </TT> EGRET1000<TT> </TT>Energetic Gamma-Ray Event Telescope: Hard<BR> + +radio<TT> </TT> 4850MHZ<TT> </TT>4850 MHz Survey - GB6/PMN<BR> +<P> + +If the <I>-p</I> option is used to specify a particular survey program, the +bandpass parameter is ignored. The <I>-p</I> flag reserves the name 'list' +as a means to have the task return a list of available data for the field. +This list contains the survey name and the mime-type of the available image. +Script tasks can use this information to determine the best available +image for the field. +<P> + +If no input file is specified the VOTable will be read from the stdin, +results will be written to stdout unless the <I>-o</I> (or <I>--output</I>) +names an output file. The task will only process a single VOTable and may +not be used to convert multiple files in a single call. +<P> +<A NAME="lbAF"> </A> +<H2>RETURN STATUS</H2> + +On exit the <B>voatlas</B> task will return a zero indicating success, or a +one indicating an error. +<P> +<A NAME="lbAG"> </A> +<H2>EXAMPLES</H2> + +<DL COMPACT> +<DT>1) Display an image of M83 on Aladin using SAMP<DD> +<P> +<PRE> + % voatlas -S m83 or % voatlas --samp m83 +</PRE> + +<DT>2) Get a 256x256 JPEG image of the Sombrero galaxy<DD> +<P> +<PRE> + % voatlas -o gal.jpg -n 256 --graphic sombrero +</PRE> + +<DT>3) Get a 20 arcmin Wise 2.2micron survey image of m101<DD> +<P> +<PRE> + % voatlas -s 20m --survey=wise22 m101 +</PRE> + +<DT>4) Get a radio image of 3c273, image will be '3c273.fits'<DD> +<P> +<BR> % voatlas --band=radio 3c273 + +<DT>5) List (verbose) the survey images available for ngc1234<DD> +<P> +<PRE> + % voatlas --survey=list -v ngc1234 +</PRE> + +</DL> +<A NAME="lbAH"> </A> +<H2>BUGS</H2> + +1) There is currently no convenient way to get a list of surveys without +specifying a position, this is due to the way Skyview is implemented. +<P> +2) There is currently no convenient way to select other than the first +available image. +<A NAME="lbAI"> </A> +<H2>Revision History</H2> + +Feb 2013 - First public release +<A NAME="lbAJ"> </A> +<H2>Author</H2> + +Michael Fitzpatrick (<A HREF="mailto:fitz@noao.edu">fitz@noao.edu</A>), Feb 2013 +<A NAME="lbAK"> </A> +<H2>SEE ALSO</H2> + +vodata, vocatalog, voimage, vospectra +<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">RETURN STATUS</A><DD> +<DT><A HREF="#lbAG">EXAMPLES</A><DD> +<DT><A HREF="#lbAH">BUGS</A><DD> +<DT><A HREF="#lbAI">Revision History</A><DD> +<DT><A HREF="#lbAJ">Author</A><DD> +<DT><A HREF="#lbAK">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:22 GMT, April 14, 2013 +</BODY> +</HTML> |