From 40e5a5811c6ffce9b0974e93cdd927cbcf60c157 Mon Sep 17 00:00:00 2001 From: Joe Hunkeler Date: Tue, 11 Aug 2015 16:51:37 -0400 Subject: Repatch (from linux) of OSX IRAF --- vendor/voclient/doc/voiminfo.html | 164 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 164 insertions(+) create mode 100644 vendor/voclient/doc/voiminfo.html (limited to 'vendor/voclient/doc/voiminfo.html') 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 + +Manpage of VOTIMINFO + +

VOTIMINFO

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

+ + +

NAME

+ +votiminfo - Print/Get information about a FITS file's structure +

+ +

SYNOPSIS

+ +votiminfo [-opts] <file> [ <file> .... ] +

+ +

OPTIONS

+ +The votiminfo task accepts the following options: +

-h, --help + +: +Print a help summary to the terminal and exit. No processing is done +following this flag. +
+
-a, --all + +: +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. +
-b, --box + +: +Print the LL and UR corners of the image along with the rotation. +
-c, --corners + +: +Print all four WCS image corners in the image. The ordering of the +corners is LL, UL, UR, LR. +
-i, --info + +: +Print all know image information. +
-n, --naxes + +: +Print the pixel dimensions of an image. +
-o NAME, --output NAME + +: +Write the result to the file NAME. +
-s, --sex + +: +Print values in sexagesimal format. +
+

+ +

DESCRIPTION

+ +The votiminfo 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. +

+ +If the -b option is used the LL and UR corner positions are printed +along with a rotation of the box that represents. The -c flag may be +used to explicitly print all four corner positions starting at the LL and +moving clockwise. The -n flag can be used to print the dimensionality +of an image, similarly the -i flag may be used to print all information +about an image determined by the task. +

+ +By default, and MEF file will cause information about each extension to be +printed. If the -a 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. +

+ +

RETURN STATUS

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

+ +

EXAMPLES

+ +

1) Print the size of each image extension in an MEF file:

+  % votiminfo -n mef.fits
+

+ +

2) Print the LL and UR positions of an image as sexigesimal:

+  % voiminfo -b -s image.fits
+

+ +

3) Print the corner positions of an image as decimal degrees:

+  % voiminfo -c image.fits
+

+ +

4) Print the box values for an entire mosaic MEF file:n"

+  % voiminfo -b mef.fits
+

+ +

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:24 GMT, April 14, 2013 + + -- cgit