Provided by: libastro-fits-header-perl_3.07-2_all bug

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
       argument, with either an array reference pointing to an array of FITS header cards, or a
       filename, or (alternatively) and FITS identifier.

REVISION

       $Id$

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 Astro::FITS::CFITSIO module, and  William Pence's
       "cfitsio" subroutine library (v2.1 or greater).

SEE ALSO

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

AUTHORS

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

COPYRIGHT

       Copyright (C) 2007-2009 Science & Technology Facilities Council.  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 terms of
       the GNU General Public License as published by the Free Software Foundation; either
       version 3 of the License, or (at your option) any later version.

       This program is distributed in the hope that it will be useful,but WITHOUT ANY WARRANTY;
       without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
       See the GNU General Public License for more details.

       You should have received a copy of the GNU General Public License along with this program;
       if not, write to the Free Software Foundation, Inc., 59 Temple Place,Suite 330, Boston, MA
       02111-1307, USA