summaryrefslogtreecommitdiffstats
path: root/funtools/fitsy/doc/headset.html
blob: e0a674a46680453f7c07e44d3ba4d4b964314588 (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
97
98
99
100
101
102
103
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 3.2//EN">
<HTML>
<HEAD>
<TITLE> headset
</TITLE>
<p>
<!-- pnuts --> <a href="headget.html">[Previous]</a> <a href="headfind.html">[Next]</a> <a href="fitsy.html">[Up]</a> <a href="../mmtilib.html">[Top]</a>
<META NAME="generator" CONTENT="txt2html v1.3">
</HEAD>
<BODY>


<A NAME="section-1.1.1"><H3>NAME</H3></A>

<P>
 ft_headsetl,ft_headseti,ft_headsetr,ft_headsets -Fitsy FITS header set routines.

<A NAME="section-1.1.2"><H3>SYNOPSIS</H3></A>

 

<PRE>
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);


<P>
</PRE>
<A NAME="section-1.1.3"><H3>PARAMETERS</H3></A>

<UL>
<P>
  <LI> <B>FITSHead fits</B> - FITS header to search in.
  <LI> <B>char *name</B> - keyword name.
  <LI> <B>int n</B> - keyword index number, if is zero no
      index number is appended to the keyword.
  <LI> <B>int lvalue</B> - Logical to format as a FITS value.
  <LI> <B>char *comm</B> - Comment for the card.
  <LI> <B>int ivalue</B> - Integer to format as a FITS value.
  <LI> <B>double rvalue</B> - Double to format as a FITS value.
  <LI> <B>int prec</B> - The value is formatted
      at this precision.
  <LI> <B>char *svalue</B> - String to format as a FITS value.

</UL>
<A NAME="section-1.1.4"><H3>DESCRIPTION</H3></A>


<A NAME="section-1.1.4.1"><H4>ft_headsetl</H4></A>

<P>
 Find a FITS card in the header and format a logical value into it.

<A NAME="section-1.1.4.2"><H4>ft_headseti</H4></A>

<P>
 Find a FITS card in the header and format a logical value into it.

<A NAME="section-1.1.4.3"><H4>ft_headsetr</H4></A>

<P>
 Find a FITS card in the header and format a logical value into it.

<A NAME="section-1.1.4.4"><H4>ft_headsets</H4></A>

<P>
 Find a FITS card in the header and format a logical value into it.

<A NAME="section-1.1.5"><H3>EXAMPLES</H3></A>

<P>
 Set the value part of a card in a header:

<PRE>
                int     i = 15;
                double  d = 34.7;
                char   *c = "Shutter";

                FITSCard        fits;
                FITSCard        card;

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

        card = <B>ft_headsetr</B>(fits, "Gain", 1, d, 2, "GAIN1");
        card = <B>ft_headsetr</B>(fits, "Gain", 2, d, 2, "GAIN2");

        card = <B>ft_headsets</B>(fits, "XHIST", 1, "Xray processed!", NULL);

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

<P>
</PRE>

<p>
<!-- pnuts --> <a href="headget.html">[Previous]</a> <a href="headfind.html">[Next]</a> <a href="fitsy.html">[Up]</a> <a href="../mmtilib.html">[Top]</a>
</BODY>
</HTML>