1Astro::FITS::Header module 2-------------------------- 3 4What is it? 5----------- 6Astro::FITS::Header and associated sub-classes are tools for reading, 7modifying and then writing out FITS standard header blocks to FITS, NDF 8and GSD files. The module now fully supports ESO HIERARCH header keywords. 9Support for instantiating Astro::FITS:Header objects from Starlink::AST 10FrameSet objects is also supported. 11 12Full documentation is included in the POD attached to the modules. 13 14Tied Interface 15-------------- 16This is a warning for those of you using the tied interface from previous 17versions of the module. The interface now acts very differently, theoretically 18the changes shouldn't break existing code, but it has diverged sufficiently 19far from the original that I'm no longer convinced that it will work in all 20cases. Be warned! 21 22Requirements 23------------ 24 25The Astro::FITS::Header module can work with FITS Header blocks, either 26directly from the primary FITS HDU of a file complying with the FITS data 27standard, or from the FITS extension in an extensible N-dimensional data 28format (NDF) file or from a Global Section Data file (GSD). Additionally 29the module also supports .HEADER in HDS contanier files, and Starlink::AST 30FrameSet objects. 31 32To work with FITS files, the Astro::FITS::Header module requires Pete 33Ratzlaff's <pratzlaff@cfa.harvard.edu> Astro::FITS::CFITSIO library 34(v 1.01 or greater), which in turn requires William Pence's CFITSIO 35subroutine library (v2.430 or greater). It should be noted that to 36build the CFITSIO subroutine library on RedHat Linux 7.x you need to 37use version 2.202 or above, however the module requires v2.400 at least 38to work with the Astro::FITS::CFITSIO module. 39 40For more information on CFITSIO, see https://heasarc.gsfc.nasa.gov/fitsio/ 41 42To work with NDF, HDS and GSD files, the Astro::FITS::Header module 43requires Tim Jenness' <t.jenness@jach.hawaii.edu> NDF (version 1.42 or 44greater) and GSD modules. These modules are installed as part of the 45PERLMODS package in the Starlink Software Collection. 46 47To work with AST FrameSet objects the Starlink::AST module is required, 48this module (should) be available from CPAN or by contacting the authors 49of this package. 50 51For more information on the Starlink Software Collection and the Starlink 52Project in general see https://www.starlink.ac.uk/ 53 54Provides 55-------- 56The package provides the following classes 57 58 Astro::FITS::Header 59 Astro::FITS::Header::Item 60 Astro::FITS::Header::NDF 61 Astro::FITS::Header::CFITSIO 62 Astro::FITS::Header::GSD 63 Astro::FITS::Header::AST 64 65which all include POD format documentation. 66 67Where can I get it? 68------------------- 69The package is available from CPAN <https://www.cpan.org/> 70 71Installation 72------------ 73Installation is automated using the ExtUtils::MakeMaker library 74 75 % perl Build.PL 76 % ./Build 77 % ./Build test 78 % ./Build install 79 80If the Astro::FITS::CFITSIO, NDF or Starlink::AST modules are not 81installed 'make test' will detect this and skip the test harness 82for the relevant modules with a warning. 83 84Note on Versioning 85--------------- 86 87Due to misunderstandings on the CPAN versioning scheme all modules in this 88release have jumped to version >= 3.0 to force reindexing. Patch numbers are 89no longer included in the distribution. 90 91Authors 92------- 93The module was originally written by Alasdair Allan <aa@astro.ex.ac.uk>, of 94the University of Exeter Astrophysics Group (http://www.astro.ex.ac.uk/) as 95part of his work for the Starlink Project (http://www.starlink.ac.uk/), and 96Tim Jenness <timj@jach.hawaii.edu> of the Joint Astronomy Center (JAC) 97(http://www.jach.hawaii.edu/) in Hawaii. 98 99This version of the module includes patches supplied by Diab Jerius 100<dj@head-cfa.harvard.edu>, of the Harvard-Smithsonian Center for Astrophysics, 101and by Jim Lewis <jrl@ast.cam.ac.uk>, of the Cambridge Astronomy Survey Unit 102at the Institute of Astronomy, to allow access to Multi-Extension FITS files. 103 104The tied interface was updated for version 2.x by Craig DeForest 105<deforest@boulder.swri.edu> of the Department of Space Studies, Southwest 106Research Institute and Tim Jenness <timj@jach.hawaii.edu> of the Joint 107Astronomy Center (JAC) in Hawaii. Patches to fix some bugs in the tied 108interface when dealing with blank cards were supplied by Brad Cavangh 109<bradc@jach.hawaii.edu> of the Joint Astronomy Center (JAC) in Hawaii. 110 111Modifications to parse ESO HIERARCH keywords, read-only, were added by 112Malcolm Currie <mjc@star.rl.ac.uk> of the Rutherford Appleton Laboratory. 113 114Maintainer 115---------- 116The package is currently maintained by Tim Jenness <tjenness@cpan.org>. 117Please use CPAN RT for bug reports and github pull requests for patches. 118The source code repository is at 119 120 git://github.com/timj/perl-Astro-FITS-Header.git 121 122License 123------- 124This program is free software; you can redistribute it and/or modify it under 125the terms of the GNU General Public License as published by the Free Software 126Foundation; either version 3 of the License, or (at your option) any later 127version. 128 129This program is distributed in the hope that it will be useful,but WITHOUT ANY 130WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A 131PARTICULAR PURPOSE. See the GNU General Public License for more details. 132 133You should have received a copy of the GNU General Public License along with 134this program; if not, write to the Free Software Foundation, Inc., 59 Temple 135Place,Suite 330, Boston, MA 02111-1307, USA 136