Astro::FITS::Header::CFITSIO - Manipulates FITS headers from a FITS file


NAME

Astro::FITS::Header::CFITSIO - Manipulates FITS headers from a FITS file


SYNOPSIS

  use Astro::FITS::Header::CFITSIO;
  $header = new Astro::FITS::Header::CFITSIO( Cards => \@array );
  $header = new Astro::FITS::Header::CFITSIO( File => $file );
  $header = new Astro::FITS::Header::CFITSIO( fitsID => $ifits );
  $header->writehdr( File => $file );
  $header->writehdr( fitsID => $ifits );


DESCRIPTION

This module makes use of the CFITSIO module to read and write directly to a FITS HDU.

It stores information about a FITS header block in an object. Takes an hash as an arguement, with either an array reference pointing to an array of FITS header cards, or a filename, or (alternatively) and FITS identifier.


REVISION

$Id: CFITSIO.pm,v 3.0 2006/08/19 00:09:14 timj Exp $


METHODS

configure

Reads a FITS header from a FITS HDU

  $header->configure( Cards => \@cards );
  $header->configure( fitsID => $ifits );
  $header->configure( File => $file );
  $header->configure( File => $file, ReadOnly => $bool );

Accepts an FITS identifier or a filename. If both fitsID and File keys exist, fitsID key takes priority.

If File is specified, the file is normally opened in ReadWrite mode. The ReadOnly argument takes a boolean value which determines whether the file is opened ReadOnly.

writehdr

Write a FITS header to a FITS file

  $header->writehdr( File => $file );
  $header->writehdr( fitsID => $ifits );

Its accepts a FITS identifier or a filename. If both fitsID and File keys exist, fitsID key takes priority.

Returns undef on error, true if the header was written successfully.


NOTES

This module requires Pete Ratzlaff's the Astro::FITS::CFITSIO manpage module, and William Pence's cfitsio subroutine library (v2.1 or greater).


SEE ALSO

the Astro::FITS::Header manpage, the Astro::FITS::Header::Item manpage, the Astro::FITS::Header::NDF manpage, the Astro::FITS::CFITSIO manpage


AUTHORS

Alasdair Allan <aa@astro.ex.ac.uk>, Jim Lewis <jrl@ast.cam.ac.uk>


COPYRIGHT

Copyright (C) 2001-2006 Particle Physics and Astronomy Research Council. All Rights Reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.