File: replacekey.1

package info (click to toggle)
qfits 6.2.0-8
  • links: PTS
  • area: main
  • in suites: bullseye, buster, jessie, jessie-kfreebsd, sid, stretch
  • size: 2,976 kB
  • ctags: 1,019
  • sloc: ansic: 11,631; sh: 8,330; makefile: 131
file content (58 lines) | stat: -rw-r--r-- 1,710 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
.TH replacekey 1 "28 Oct 1999"
.SH NAME 
replacekey \- replace keywords in a FITS header
.SH SYNOPSIS
.B replacekey
[options] <in>
.SH DESCRIPTION
.PP
.B replacekey
is aimed at replacing keywords in a FITS file's header by
new keywords provided by the user on the command-line. 
.PP
.SH ALGORITHM
The user can provide a new_keyword, an old_keyword, a value and a comment.
.B replacekey
first searchs for old_keyword if provided. If it finds it, it replaces the
associated card by the new one (new_keyword=value/comment).
If old_keyword is either not found or not provided,
.B replacekey
searchs for new_keyword, and if it finds it, replaces the
associated card by the new one (new_keyword=value/comment).
new_keyword has to be provided.
.PP
Examples:
You want to change the value of VALUE from 32 to 16 in myfile.fits:
% replacekey -k "VALUE" -v "16" myfile.fits
.PP
If you want to replace the card with the keyword OLD by 
"NEW = 3.14 / This is a usefull key" in myfile.fits:
% replacekey -k "NEW" -v "3.14" -c "This is a usefull key" -K "OLD" myfile.fits
.PP
If your do not care about the HISTORY cards you have in the header,
and want to replace the first one by VALUE=32, you would do:
.br
% replacekey -k "VALUE" -v "32" -K "HISTORY" myfile.fits
.SH OPTIONS
.TP
.B \-k or \--key key
To provide the new keyword.
.TP
.B \-K or \--old key
To provide the old keyword.
.TP
.B \-v or \--val val
To provide the new value.
.TP
.B \-c or \--com com
To provide the new comment.
.SH SEE ALSO
.B hierarch28
to convert HIERARCH ESO keywords to regular 8-char keywords.
.SH FILES
.PP
Files shall all comply with FITS format
.SH BUGS
.PP
Modifications are so far only possible in the main header, not in the
extensions.