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


Astro-FITS-Header documentation  | view source Contained in the Astro-FITS-Header distribution.

Index


NAME

Top

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

SYNOPSIS

Top

  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

Top

This module makes use of the CFITSIO (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

Top

$Id$

METHODS

Top

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

Top

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

SEE ALSO

Top

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

AUTHORS

Top

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

COPYRIGHT

Top


Astro-FITS-Header documentation  | view source Contained in the Astro-FITS-Header distribution.