logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

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

Authors

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

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.

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.

           Throws an exception (croaks) on error.

Name

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

Notes

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

Revision

       $Id$

See Also

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

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 );

See Also