diff options
Diffstat (limited to 'funtools/fitsy/doc/headfile.wu')
-rw-r--r-- | funtools/fitsy/doc/headfile.wu | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/funtools/fitsy/doc/headfile.wu b/funtools/fitsy/doc/headfile.wu new file mode 100644 index 0000000..23aa8e8 --- /dev/null +++ b/funtools/fitsy/doc/headfile.wu @@ -0,0 +1,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.
\ No newline at end of file |