File: wcsware.1

package info (click to toggle)
wcslib 7.4%2Bds-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 9,752 kB
  • sloc: ansic: 32,656; lex: 9,281; fortran: 6,634; sh: 3,369; sed: 497; pascal: 188; makefile: 15
file content (80 lines) | stat: -rw-r--r-- 2,643 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.40.4.
.TH WCSWARE "1" "January 2021" "wcsware 7.4" "User Commands"
.SH NAME
wcsware \- Extract FITS WCS keywords for an image
.SH SYNOPSIS
.B wcsware
[\fIOPTION\fR]... [\fIFITSFILE\fR]
.SH DESCRIPTION
wcsware extracts the WCS keywords for an image from the specified FITS
file, constructs wcsprm structs for each coordinate representation found
and performs a variety of operations using them.  It features a "lint"
capability as one of its more useful operations.
.PP
By default, all known extensions to the FITS WCS standard are allowed,
including deprecated usage.  However, in "lint" mode, strict conformance
to the standard is enforced.
.PP
The FITS file may be specified according to the syntax understood by
cfitsio, for example "file.fits.gz+1" refers to the first extension of
a gzip'd FITS file.  Use "\-" or omit the file name for input from stdin.
.SH OPTIONS
.TP
\fB\-a\fR<alt>
Specify an alternate coordinate representation (ignored if
there is only one).  Can also be specified as a 0\-relative
index in the range 0 to 26, where alternates are sequenced
alphabetically following the primary representation.
.TP
\fB\-b\fR
Use wcsbth() for primary image headers, normally wcspih()
is used.  (Implies \fB\-i\fR.)
.TP
\fB\-f\fR
Apply wcsfix() to the header.
.TP
\fB\-h\fR<hdu>
Move to HDU number (1\-relative) which is expected to
contain an image array.  Overrides cfitsio extended
filename syntax.  Also useful for input from stdin.
.TP
\fB\-i\fR
Allow image header WCS keywords in binary table headers.
.TP
\fB\-l\fR
Validate (lint) the WCS keyrecords in the specified FITS
header for conformance to the WCS standard.  (Implies \fB\-s\fR.)
.TP
\fB\-o\fR
Use wcshdo() to translate the wcsprm struct into a FITS
header and print it.
.TP
\fB\-p\fR
Print the struct(s) using wcsprt() (default operation).
.TP
\fB\-P\fR
Same as \fB\-p\fR but don't print a default struct.
.TP
\fB\-r\fR
Require strict adherence to the FITS WCS standard, though
allowing the deprecated AIPS\-convention keywords, CROTAn,
EPOCH, and VELREF, and also some other deprecated usage.
(Must follow \fB\-l\fR if relaxed linting is required.)
.TP
\fB\-s\fR
Require strict adherence to the FITS WCS standard,
disallowing all deprecated features.
.TP
\fB\-t\fR
Terse (with \fB\-l\fR), report rejected WCS keyrecords only.
.TP
\fB\-v\fR
Verbose (with \fB\-l\fR), report recognised WCS keyrecords as well.
.TP
\fB\-w\fR
Convert world coordinates, obtained from stdin, to pixel
coordinates using wcss2p().
.TP
\fB\-x\fR
Convert pixel coordinates, obtained from stdin, to world
coordinates using wcsp2s().