summaryrefslogtreecommitdiffstats
path: root/funtools/fitsy/doc/headfile.wu
blob: 23aa8e8b6c010a0b58a02a8fec530c5bf8c9fa9f (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
Title: headfile


NAME
====
 ft_headread,ft_headwrite,ft_headseek -Fitsy FITS read and write header routines.

SYNOPSIS
========
 

-
FITSHead ft_headread(File file);
int ft_headwrite(File file, FITSHead fits);
int ft_headseek(File file, FITSHead fits);


-
PARAMETERS
==========
  * #"File file" - File pointer to read or write a FITS header on.
  * #"FITSHead fits" - Header to write.

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

 ft_headread
 -----------
 Read a FITS header from a file pointer.

 ft_headwrite
 ------------
 Write a FITS header to a file pointer.

 ft_headseek
 -----------
 Seek back to the header part of a FITS HDU. The file handle must be the same
 one from which the FITS header was read and must be seekable.

RETURNS
=======

 ft_headread
 -----------
 The #FITSHead read from #file.