diff options
Diffstat (limited to 'vendor/voclient/doc/voiminfo.html')
| -rw-r--r-- | vendor/voclient/doc/voiminfo.html | 164 |
1 files changed, 164 insertions, 0 deletions
diff --git a/vendor/voclient/doc/voiminfo.html b/vendor/voclient/doc/voiminfo.html new file mode 100644 index 00000000..68edaf4d --- /dev/null +++ b/vendor/voclient/doc/voiminfo.html @@ -0,0 +1,164 @@ +Content-type: text/html + +<HTML><HEAD><TITLE>Manpage of VOTIMINFO</TITLE> +</HEAD><BODY> +<H1>VOTIMINFO</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> + +votiminfo - Print/Get information about a FITS file's structure +<P> +<A NAME="lbAC"> </A> +<H2>SYNOPSIS</H2> + +<B>votiminfo</B> [<I>-opts</I>] <file> [ <file> .... ] +<P> +<A NAME="lbAD"> </A> +<H2>OPTIONS</H2> + +The <I>votiminfo</I> task 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>-a, --all</B> + +<DD> +Print information for the entire field in an MEF file, e.g. from a mosaic +camera. If not specified, information for each image extension is printed. +<DT><B>-b, --box</B> + +<DD> +Print the LL and UR corners of the image along with the rotation. +<DT><B>-c, --corners</B> + +<DD> +Print all four WCS image corners in the image. The ordering of the +corners is LL, UL, UR, LR. +<DT><B>-i, --info</B> + +<DD> +Print all know image information. +<DT><B>-n, --naxes</B> + +<DD> +Print the pixel dimensions of an image. +<DT><B>-o </B><I>NAME</I>, --output <I>NAME</I> + +<DD> +Write the result to the file <I>NAME</I>. +<DT><B>-s, --sex</B> + +<DD> +Print values in sexagesimal format. +<P> +</DL> +<A NAME="lbAE"> </A> +<H2>DESCRIPTION</H2> + +The <I>votiminfo</I> task is used to get information about the structure of +FITS files, e.g. to get the center and radius values that might be used in +a VO data query, the corner positions needed to draw a footprint overlay, +or simply the dimensionality of a FITS file (or the extensions in an MEF +file). If no information options are specified the default is to print +the center position and a radius (in decimal degrees if a WCS is present, +or in pixels otherwise). In all cases, in no WCS is present in the image +header, zero will be printed. +<P> + +If the <I>-b</I> option is used the LL and UR corner positions are printed +along with a rotation of the box that represents. The <I>-c</I> flag may be +used to explicitly print all four corner positions starting at the LL and +moving clockwise. The <I>-n</I> flag can be used to print the dimensionality +of an image, similarly the <I>-i</I> flag may be used to print all information +about an image determined by the task. +<P> + +By default, and MEF file will cause information about each extension to be +printed. If the <I>-a</I> flag is used the requested information for all +extensions in an MEF (e.g from a mosaic camera) will be printed. This allows +the user the option of getting information about individual rasters within +an MEF or the footprint of the entire FOV. CFITSIO is used to read the file +and so the syntax to specify an extension number or image section (see the +CFITSIO documentation) is allowed by the task. +<P> +<A NAME="lbAF"> </A> +<H2>RETURN STATUS</H2> + +On exit the <B>votiminfo</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) Print the size of each image extension in an MEF file:<DD> +<P> +<PRE> + % votiminfo -n mef.fits +</PRE> + +<DT>2) Print the LL and UR positions of an image as sexigesimal:<DD> +<P> +<PRE> + % voiminfo -b -s image.fits +</PRE> + +<DT>3) Print the corner positions of an image as decimal degrees:<DD> +<P> +<PRE> + % voiminfo -c image.fits +</PRE> + +<DT>4) Print the box values for an entire mosaic MEF file:n"<DD> +<P> +<PRE> + % voiminfo -b mef.fits +</PRE> + +</DL> +<A NAME="lbAH"> </A> +<H2>BUGS</H2> + +No known bugs with this release. +<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> + +votinfo +<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:24 GMT, April 14, 2013 +</BODY> +</HTML> |