source: trunk/src/Cubes/getImage.cc

// -----------------------------------------------------------------------
// getImage.cc: Read in a FITS file to a Cube object.
// -----------------------------------------------------------------------
// Copyright (C) 2006, Matthew Whiting, ATNF
//
// 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 2 of the License, or (at your
// option) any later version.
//
// Duchamp 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 Duchamp; if not, write to the Free Software Foundation,
// Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA
//
// Correspondence concerning Duchamp may be directed to:
//    Internet email: Matthew.Whiting [at] atnf.csiro.au
//    Postal address: Dr. Matthew Whiting
//                    Australia Telescope National Facility, CSIRO
//                    PO Box 76
//                    Epping NSW 1710
//                    AUSTRALIA
// -----------------------------------------------------------------------
#include <iostream>
#include <string>
#include <string.h>
#include <wcslib/wcs.h>
#include <wcslib/wcshdr.h>
#include <wcslib/fitshdr.h>
#include <wcslib/wcsfix.h>
#include <wcslib/wcsunits.h>
#define WCSLIB_GETWCSTAB // define this so that we don't try and redefine 
                         //  wtbarr (this is a problem when using gcc v.4+)
#include <fitsio.h>
#include <math.h>
#include <duchamp/duchamp.hh>
#include <duchamp/param.hh>
#include <duchamp/fitsHeader.hh>
#include <duchamp/Cubes/cubes.hh>

namespace duchamp
{

  std::string imageType[4] = {"point", "spectrum", "image", "cube"};

  OUTCOME Cube::getMetadata()
  {  
    ///  @details
    /// A front-end to the Cube::getMetadata() function, that does
    ///  subsection checks. Does the flux unit conversion if the user
    ///  has requested it. Assumes the Param is set up properly.

    // int exists;
    // fits_file_exists(fname.c_str(),&exists,&status);
    // if(exists<=0){
    //   fits_report_error(stderr, status);
    //   DUCHAMPERROR("Cube Reader", Requested image (" << fname << ") does not exist!);
    //   return FAILURE;
    // }
    if(this->par.checkImageExists() == FAILURE) return FAILURE;

    std::string fname = par.getImageFile();
    if(par.getFlagSubsection()) fname+=par.getSubsection();

    OUTCOME result=SUCCESS;
    int openStatus = this->head.openFITS(fname);
    if (openStatus){
        result = FAILURE;
    }
    else {

        result = getMetadata(fname);
    
        if(result==SUCCESS){
            // Convert the flux Units if the user has so requested
            this->convertFluxUnits(this->head.getFluxUnits(),this->par.getNewFluxUnits());
        }

        int closeStatus = this->head.closeFITS();
        if (closeStatus && result==SUCCESS)
            DUCHAMPWARN("Metadata reader","Error closing the FITS file, but will persist as the metadata was read successfully.");
    }

    return result;
  }
  //--------------------------------------------------------------------

  OUTCOME Cube::getMetadata(std::string fname)
  {
    /// @details
    /// Read in the metadata associated with the cube from the file
    ///  fname (assumed to be in FITS format).  Function is a front end
    ///  to the I/O functions in the FitsIO/ directory.  This function
    ///  will check that the file exists, report the dimensions and
    ///  then get other functions to read the WCS and necessary header
    ///  keywords. This function does not read in the data array --
    ///  that is done by Cube::getCube(). Note that no conversion of
    ///  flux units is done -- you need to call Cube::getMetadata() or
    ///  do it separately.
    ///  \param fname A std::string with name of FITS file.
    ///  \return SUCCESS or FAILURE.

    int numAxes, status = 0;  /* MUST initialize status */

    // Read the size information -- number and lengths of all axes.
    // Just use this for reporting purposes.
    status = 0;
    if(fits_get_img_dim(this->head.FPTR(), &numAxes, &status)){
      fits_report_error(stderr, status);
      return FAILURE;
    }

    this->head.setNumAxes(numAxes);
    long *dimAxes = new long[numAxes];
    for(int i=0;i<numAxes;i++) dimAxes[i]=1;
    status = 0;
    if(fits_get_img_size(this->head.FPTR(), numAxes, dimAxes, &status)){
      fits_report_error(stderr, status);
      return FAILURE;
    }

    // Report the size of the FITS file
    if(this->par.isVerbose()){
      std::cout << "Dimensions of FITS file: ";
      int dim = 0;
      std::cout << dimAxes[dim];
      while(dim+1<numAxes) std::cout << "x" << dimAxes[++dim];
      std::cout << std::endl;
    }


    // Get the WCS information
    if(this->head.defineWCS(this->par) == FAILURE) return FAILURE;

    // Read the necessary header information, and copy some of it into the Param.
    if(this->head.readHeaderInfo(this->par) == FAILURE){
     DUCHAMPWARN("Cube Reader", "Problems with metadata, but will press on...");
    }

    if(!this->head.isWCS()) 
      DUCHAMPWARN("Cube Reader","WCS is not good enough to be used.\n");

    // allocate the dimension array in the Cube.
    if(this->initialiseCube(dimAxes,false) == FAILURE) return FAILURE;

    delete [] dimAxes;

    return SUCCESS;

  }
  //--------------------------------------------------------------------


  OUTCOME Cube::getCube(std::string fname)
  {
    /// @details
    /// Read in a cube from the file fname (assumed to be in FITS
    ///  format).  Function is a front end to the data I/O function in
    ///  the FitsIO/ directory.  This function calls the getMetadata()
    ///  function, then reads in the actual data array.
    ///  \param fname A std::string with name of FITS file.
    ///  \return SUCCESS or FAILURE.

    if(this->head.openFITS(fname)) return FAILURE;

    if(this->getMetadata(fname) == FAILURE) return FAILURE;

    // Get the data array from the FITS file.
    // Report the dimensions of the data array that was read (this can be
    //   different to the full FITS array).
    if(this->par.isVerbose()) std::cout << "Reading data ... "<<std::flush;
    if(this->getFITSdata() == FAILURE) return FAILURE;

    if(this->par.isVerbose()){
      std::cout << "Done. Data array has dimensions: ";
      std::cout << this->axisDim[0];
      std::cout  <<"x"<< this->axisDim[1];
      if(this->axisDim[2]>1) std::cout  <<"x"<< this->axisDim[2];
      std::cout << "\n";
    }   

    // Convert the flux Units if the user has so requested
    this->convertFluxUnits(this->head.getFluxUnits(),this->par.getNewFluxUnits(),ARRAY);

    this->head.closeFITS();

    return SUCCESS;    

  }
  //--------------------------------------------------------------------


  void Cube::convertFluxUnits(std::string oldUnit, std::string newUnit, ARRAYREF whichArray)
  {
    /// @details
    ///  If the user has requested new flux units (via the input
    ///  parameter newFluxUnits), this function converts the units
    ///  given by BUNIT to those given by newFluxUnits. If no simple
    ///  conversion can be found (by using wcsunits()) then nothing is
    ///  done and the user is informed, otherwise the
    ///  FitsHeader::fluxUnits parameter is updated and the pixel array
    ///  is converted accordingly.

    if(newUnit!=""){

      if(oldUnit != newUnit){

        if(this->par.isVerbose()){
          std::cout << "Converting flux units from " << oldUnit << " to " << newUnit << "... ";
          std::cout << std::flush;
        }

        double scale,offset,power;
        int status = wcsunits(oldUnit.c_str(), newUnit.c_str(), &scale, &offset, &power);

        if(status==0){
        
          this->head.setFluxUnits( newUnit );
          this->head.setIntFluxUnits();

          if(whichArray == ARRAY){
            if(this->arrayAllocated){
              for(size_t i=0;i<this->numPixels;i++)
                if(!this->isBlank(i)) this->array[i] = pow(scale * this->array[i] + offset, power);
            }
          }
          else if(whichArray==RECON){
            if(this->reconAllocated){
              for(size_t i=0;i<this->numPixels;i++)
                if(!this->isBlank(i)) this->recon[i] = pow(scale * this->recon[i] + offset, power);
            }
          }
          else if(whichArray==BASELINE){
            if(this->baselineAllocated){
              for(size_t i=0;i<this->numPixels;i++)
                if(!this->isBlank(i)) this->baseline[i] = pow(scale * this->baseline[i] + offset, power);
            }
          }
          if(this->par.isVerbose()) {
            std::cout << " Done.\n";
          }
        }
        else{
          if(this->par.isVerbose()) std::cout << "\n";
          DUCHAMPWARN("convertFluxUnits", "Could not convert units from " << oldUnit << " to " << newUnit << ". Leaving BUNIT as " << oldUnit);
        }
      }
    }

  }


}