summaryrefslogtreecommitdiffstats
path: root/funtools/fitsy/doc/cardins.wu
blob: 26109f98a32834fe70aadf8109397e0152bbc9e0 (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
Title: cardins


NAME
====
 ft_cardins,ft_cardapp,ft_carddel -Fitsy FITS card insert and delete routines.

SYNOPSIS
========
 

-
FITSCard ft_cardins(FITSHead fits, FITSCard card, FITSCard here);
FITSCard ft_cardapp(FITSHead fits, FITSCard card);
FITSCard ft_carddel(FITSHead fits, FITSCard card);


-
PARAMETERS
==========
  * #"FITSHead fits" - FITS header.
  * #"FITSCard card" - FITS card to insert, append or
      delete.
  * #"FITSCard here" - Insert #card after #here

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

 ft_cardins
 ----------
 Insert a #card into a FITS header after #here.
 
 If #here is NULL #card is inserted before the END card.
 
 Returns #card;

 ft_cardapp
 ----------
 Append a card to the end of the FITS header.
 
 Retuns #card.

 ft_carddel
 ----------
 Delete a card from a FITS header.
 
 Returns #card which now points the the card after
 the one deleted

EXAMPLES
========

+
		FITSCard	here;
		FITSBuff	card;

	#ft_cardkey(&card, "Keyword", 0);
	#ft_cardseti(&card, 4, NULL);

	/* Insert a new card "Keyword" after the 4th card.
	 *-/
	here = #ft_cardins(fits, &card, #ft_cardnth(4));

	/* Append the same card to the header
	 *-/
	card = #ft_cardapp(fits, &card);

	/* Delete the first card.
	 *-/
	#ft_carddel(fits, here);

+