summaryrefslogtreecommitdiffstats
path: root/funtools/fitsy/doc/headset.wu
blob: 779a7fbec76f95d37842377f62ddc2b04b7f579c (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
Title: headset


NAME
====
 ft_headsetl,ft_headseti,ft_headsetr,ft_headsets -Fitsy FITS header set routines.

SYNOPSIS
========
 

-
FITSCard ft_headsetl(FITSHead fits, char *name, int n, int lvalue, char *comm);
FITSCard ft_headseti(FITSHead fits, char *name, int n, int ivalue, char *comm);
FITSCard ft_headsetr(FITSHead fits, char *name, int n, double rvalue, int prec, char *comm);
FITSCard ft_headsets(FITSHead fits, char *name, int n, char *svalue, char *comm);


-
PARAMETERS
==========
  * #"FITSHead fits" - FITS header to search in.
  * #"char *name" - keyword name.
  * #"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 card.
  * #"int ivalue" - Integer to format as a FITS value.
  * #"double rvalue" - Double to format as a FITS value.
  * #"int prec" - The value is formatted
      at this precision.
  * #"char *svalue" - String to format as a FITS value.

DESCRIPTION
===========

 ft_headsetl
 -----------
 Find a FITS card in the header and format a logical value into it.

 ft_headseti
 -----------
 Find a FITS card in the header and format a logical value into it.

 ft_headsetr
 -----------
 Find a FITS card in the header and format a logical value into it.

 ft_headsets
 -----------
 Find a FITS card in the header and format a logical value into it.

EXAMPLES
========
 Set the value part of a card in a header:

+
		int	i = 15;
		double	d = 34.7;
		char   *c = "Shutter";

		FITSCard	fits;
		FITSCard	card;

	card = #ft_headsetl(fits, "Cosmic", 0, 1, "Removed Cosimics (silver bullet method)");
	card = #ft_headseti(fits, "IValue" , 0, i, "15 is the number");

	card = #ft_headsetr(fits, "Gain", 1, d, 2, "GAIN1");
	card = #ft_headsetr(fits, "Gain", 2, d, 2, "GAIN2");

	card = #ft_headsets(fits, "XHIST", 1, "Xray processed!", NULL);

	/* In this example the special pointer #ft_comment is used to 
	   use the existing comment in the card.
	 *-/
	card = #ft_headsets(fits, "FILTER", 0, "V", ft_comment);

+