MAN page from Other perl-Astro-FITS-Header-3.07-1.i386.rpm

Astro::FITS::Header::NDF

Section: User Contributed Perl Documentation (3)
Updated: 2012-12-17
Index

NAME

Astro::FITS::Header::NDF - Manipulate FITS headers from NDF files

SYNOPSIS

  use Astro::FITS::Header::NDF;  $hdr = new Astro::FITS::Header::NDF( Cards => \@cards );  $hdr = new Astro::FITS::Header::NDF( Items => \@items );  $hdr = new Astro::FITS::Header::NDF( ndfID => $indf );  $hdr = new Astro::FITS::Header::NDF( File => $file );  $hdr->writehdr( $indf );  $hdr->writehdr( File => $file );

DESCRIPTION

This module makes use of the Starlink NDF module to read andwrite to an NDF FITS extension or to a ".HEADER" block in an HDScontainer file. If the file is found to be an HDS containercontaining multiple NDFs at the top level, either the .HEADER NDF orthe first NDF containing a FITS header is deemed to be the primaryheader, and all other headers a subsidiary headers indexed by the nameof the NDF in the container.

It stores information about a FITS header block in an object. Takes anhash as an argument, with either an array reference pointing to anarray of FITS header cards, array of "Astro::FITS::Header::Item"objects, or a filename, or (alternatively) an NDF identifier.

Currently, subheader support is readonly.

METHODS

configure

Reads a FITS header from an NDF.

  $hdr->configure( Cards => \@cards );  $hdr->configure( ndfID => $indf );  $hdr->configure( File => $filename );

Accepts an NDF identifier or a filename. If both "ndfID" and "File" keysexist, "ndfID" key takes priority.

If the file is actually an HDS container, an attempt will be madeto read a ``.HEADER'' NDF inside that container (this is the standardlayout of UKIRT (and some JCMT) data files). If an extension is specifiedexplicitly (that is not ``.sdf'') that path is treated as an explicit pathto an NDF. If an explicit path is specified no attempt is made to locateother NDFs in the HDS container.

If the NDF can be opened successfully but there is no .MORE.FITSextension, an empty header is returned rather than throwing an error.

writehdr

Write a FITS header to an NDF.

  $hdr->writehdr( ndfID => $indf );  $hdr->writehdr( File => $file );

Accepts an NDF identifier or a filename. If both "ndfID" and "File" keysexist, "ndfID" key takes priority.

Throws an exception (croaks) on error.

NOTES

This module requires the Starlink NDF module.

AUTHORS

Tim Jenness <t.jennessAATTjach.hawaii.edu>,Alasdair Allan <aaAATTastro.ex.ac.uk>,Brad Cavanagh <b.cavanaghAATTjach.hawaii.edu>

COPYRIGHT

This program is free software; you can redistribute it and/or modify it underthe terms of the GNU General Public License as published by the Free SoftwareFoundation; either version 3 of the License, or (at your option) any laterversion.

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

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

This document was created byman2html,using the manual pages.