summaryrefslogtreecommitdiffstats
path: root/funtools/fitsy/doc/headins.wu
blob: a9852f40aa22845e884ebc19607c602c02224d82 (plain)
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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
Title: headins


NAME
====
 ft_headinsl,ft_headinsi,ft_headinsr,ft_headinss,ft_headinsv,ft_headappl,ft_headappi,ft_headappr,ft_headapps,ft_headappv,ft_headdel
- Routines to insert, append and delete FITS cards from a header.

SYNOPSIS
========
 

-
FITSCard ft_headinsl(FITSHead fits, char *name, int n, int lvalue, char *comm, FITSCard here);
FITSCard ft_headinsi(FITSHead fits, char *name, int n, int ivalue, char *comm, FITSCard here);
FITSCard ft_headinsr(FITSHead fits, char *name, int n, double dvalue, int prec, char *comm, FITSCard here);
FITSCard ft_headinss(FITSHead fits, char *name, int n, char *svalue, char *comm, FITSCard here);
FITSCard ft_headinsv(FITSHead fits, char *name, int n, char *vvalue, char *comm, FITSCard here);
FITSCard ft_headappl(FITSHead fits, char *name, int n, int lvalue, char *comm);
FITSCard ft_headappi(FITSHead fits, char *name, int n, int ivalue, char *comm);
FITSCard ft_headappr(FITSHead fits, char *name, int n, double dvalue, int prec, char *comm);
FITSCard ft_headapps(FITSHead fits, char *name, int n, char *svalue, char *comm);
FITSCard ft_headappv(FITSHead fits, char *name, int n, char *vvalue, char *comm);
FITSCard ft_headdel(FITSHead fits, char *name, int n);


-
PARAMETERS
==========
  * #"FITSHead fits" - FITS header to insert, append or
      delete a card.
  * #"char *name" - Name of the FITS card.
  * #"int n" - keyword index number, if is zero no
      index number is appended to the
      keyword.
  * #"int lvalue" - Logical to format as a FITS value.
  * #"char *comm" - Comment for the new card.
  * #"FITSCard here" - Insert the new card after this card.
  * #"int ivalue" - Integer to format as a FITS value.
  * #"double dvalue" - Double to format as a FITS value.
  * #"int prec" - Precision for the value
  * #"char *svalue" - String to format as a FITS value
  * #"char *vvalue" - Raw value to format as a FITS value

DESCRIPTION
===========
 These routines allow FITS cards to be inserted, appended and deleted
 by keyword value.
 
 The insertion routines format a new card with the supplied keyword and
 value and insert it after indicated card. The append routines add new
 cards to the end of the header (before the END card).

 ft_headinsl
 -----------
 Insert a logical value FITS card into a header.

 ft_headinsi
 -----------
 Insert a integer value FITS card into a header.

 ft_headinsr
 -----------
 Insert a real value FITS card into a header.

 ft_headinss
 -----------
 Insert a string value FITS card into a header.

 ft_headinsv
 -----------
 Insert a raw value FITS card into a header.

 ft_headappl
 -----------
 Append a logical value FITS card to a header.

 ft_headappi
 -----------
 Append a integer value FITS card to a header.

 ft_headappr
 -----------
 Append a real value FITS card to a header.

 ft_headapps
 -----------
 Append a string value FITS card to a header.

 ft_headappv
 -----------
 Append a raw value FITS card to a header.

 ft_headdel
 ----------
 Find and delete a card from a FITS header.