//# FITS2Image.cc: Class implementing templated functions for FITSImage
//# Copyright (C) 2001,2002
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library 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 Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//#        Internet email: casa-feedback@nrao.edu.
//#        Postal address: AIPS++ Project Office
//#                        National Radio Astronomy Observatory
//#                        520 Edgemont Road
//#                        Charlottesville, VA 22903-2475 USA

#ifndef IMAGES_FITS2IMAGE_TCC
#define IMAGES_FITS2IMAGE_TCC


#include <casacore/images/Images/FITSImage.h>

#include <casacore/casa/Arrays/IPosition.h>
#include <casacore/coordinates/Coordinates/CoordinateSystem.h>
#include <casacore/casa/Containers/Record.h>
#include <casacore/casa/Exceptions/Error.h>
#include <casacore/fits/FITS/hdu.h>
#include <casacore/fits/FITS/FITSKeywordUtil.h>
#include <casacore/images/Images/ImageInfo.h>
#include <casacore/images/Images/ImageFITSConverter.h>
#include <casacore/casa/Logging/LogIO.h>
#include <casacore/casa/BasicMath/Math.h>
#include <casacore/casa/Quanta/Unit.h>
#include <casacore/casa/Utilities/DataType.h>
#include <casacore/casa/BasicSL/String.h>


namespace casacore { //# NAMESPACE CASACORE - BEGIN

template <typename T>
void FITSImage::crackHeader (CoordinateSystem& cSys,
                             IPosition& shape, ImageInfo& imageInfo,
                             Unit& brightnessUnit, RecordInterface& miscInfo,
                             Float& scale, Float& offset, 
			     uChar& magicUChar, Short& magicShort, 
                             Int& magicInt, Bool& hasBlanks, 
                             LogIO& os, FitsInput& infile, uInt whichRep)
{
   
// Shape
   PrimaryArray<T> fitsImage(infile);
   Int ndim = fitsImage.dims();

   shape.resize(ndim);
   for (Int i=0; i<ndim; i++) {
       shape(i) = fitsImage.dim(i);
   }

// Get header as Vector of strings
   Vector<String> header = fitsImage.kwlist_str(True);
   
// Get Coordinate System.  Return un-used FITS cards in a Record for further use.

    Record headerRec;
    Bool dropStokes = True;
    Int stokesFITSValue = 1;
    cSys = ImageFITSConverter::getCoordinateSystem(stokesFITSValue, headerRec, header,
                                                   os, whichRep, shape, dropStokes);
    ndim = shape.nelements();

    _hasBeamsTable = headerRec.isDefined(ImageFITSConverter::CASAMBM)
      && headerRec.asRecord(ImageFITSConverter::CASAMBM).asBool("value");

// BITPIX

    DataType dataType = whatType<T>();
//
    Int bitpix;   
    Record subRec = headerRec.asRecord("bitpix");
    subRec.get("value", bitpix);
    headerRec.removeField("bitpix");   
    if (dataType==TpFloat) {
       if (bitpix != -32) {
          throw (AipsError("bitpix card inconsistent with data type: expected bitpix = -32"));
       }  
    } else if (dataType==TpDouble) {
       if (bitpix != -64) {
          throw (AipsError("bitpix card inconsistent with data type: expected bitpix = -64"));
       }  
    } else if (dataType==TpInt) {
       if (bitpix != 32) {
          throw (AipsError("bitpix card inconsistent with data type: expected bitpix = 32"));
       }  
    } else if (dataType==TpShort) {
       if (bitpix != 16) {
          throw (AipsError("bitpix card inconsistent with data type: expected bitpix = 16"));
       }  
    } else if (dataType==TpUChar) {
       if (bitpix != 8) {
          throw (AipsError("bitpix card inconsistent with data type: expected bitpix = 8"));
       }  
    } else {
       throw (AipsError("Unsupported Template type; Float & Double only are supported"));
    }

// Scale and blank (will only be present for Int and Short)

    Double s = 1.0;
    Double o = 0.0;
    if (headerRec.isDefined("bscale")) {
       subRec = headerRec.asRecord("bscale");
       subRec.get("value", s);
       headerRec.removeField("bscale");
    }
    if (headerRec.isDefined("bzero")) {
       subRec = headerRec.asRecord("bzero");
       subRec.get("value", o);
       headerRec.removeField("bzero");
    }
    scale = s; 
    offset = o;

// Will only be present for Int and Short and uChar

    hasBlanks = False;
    if (headerRec.isDefined("blank")) {
       subRec = headerRec.asRecord("blank");
       Int m;
       subRec.get("value", m);
       headerRec.removeField("blank");
       if (dataType==TpUChar) {
          magicUChar = m;
       } else if (dataType==TpShort) {
          magicShort = m;
       } else if (dataType==TpInt) {
          magicInt = m;
       } else {
          magicUChar = m;
          magicShort = m;
          magicInt = m;
       }
       hasBlanks = True;
    }

// Brightness Unit

    brightnessUnit = ImageFITSConverter::getBrightnessUnit(headerRec, os);

// ImageInfo

    imageInfo = ImageFITSConverter::getImageInfo(headerRec);

// If we had one of those unofficial pseudo-Stokes on the Stokes axis, store it in the imageInfo

    if (stokesFITSValue != -1) {
       ImageInfo::ImageTypes type = ImageInfo::imageTypeFromFITS(stokesFITSValue);
       if (type!= ImageInfo::Undefined) {
          imageInfo.setImageType(type);
       }
    }

// Get rid of anything else we don't want to end up in MiscInfo
// that will have passed through the FITS parsing process

    Vector<String> ignore(9);
    ignore(0) = "^datamax$";
    ignore(1) = "^datamin$";
    ignore(2) = "^origin$";
    ignore(3) = "^extend$";
    ignore(4) = "^blocked$";
    ignore(5) = "^blank$";
    ignore(6) = "^simple$";
    ignore(7) = "bscale";
    ignore(8) = "bzero";
    FITSKeywordUtil::removeKeywords(headerRec, ignore);

// MiscInfo is whats left

    ImageFITSConverter::extractMiscInfo(miscInfo, headerRec);

// Get and store history.

    Vector<String> lines;
    String groupType;
    ConstFitsKeywordList kw = fitsImage.kwlist();
    kw.first();

// Set the contents of the ImageInterface logger object (history)

    LoggerHolder& log = logger();
    ImageFITSConverter::restoreHistory(log, kw);

// Try and find the restoring beam in the history cards if
// its not in the header

    if (! imageInfo.hasBeam()) {
       imageInfo.getRestoringBeam(log);
    }
}


template <typename T>
void FITSImage::crackExtHeader (CoordinateSystem& cSys,
				IPosition& shape, ImageInfo& imageInfo,
				Unit& brightnessUnit, RecordInterface& miscInfo,
				Float& scale, Float& offset, uChar& magicUChar,
				Short& magicShort,
				Int& magicInt, Bool& hasBlanks,
				LogIO& os, FitsInput& infile, uInt whichRep)
{

// Shape

	ImageExtension<T> fitsImage(infile);
    Int ndim = fitsImage.dims();

    shape.resize(ndim);
    for (Int i=0; i<ndim; i++) {
       shape(i) = fitsImage.dim(i);
    }

// Get header as Vector of strings

   Vector<String> header = fitsImage.kwlist_str(True);

// Get Coordinate System.  Return un-used FITS cards in a Record for further use.

    Record headerRec;
    Bool dropStokes = True;
    Int stokesFITSValue = 1;
    cSys = ImageFITSConverter::getCoordinateSystem(stokesFITSValue, headerRec, header,
                                                   os, whichRep, shape, dropStokes);
    ndim = shape.nelements();
    _hasBeamsTable = headerRec.isDefined(ImageFITSConverter::CASAMBM)
      && headerRec.asRecord(ImageFITSConverter::CASAMBM).asBool("value");

// BITPIX

    DataType dataType = whatType<T>();
//
    Int bitpix;
    Record subRec = headerRec.asRecord("bitpix");
    subRec.get("value", bitpix);
    headerRec.removeField("bitpix");
    if (dataType==TpFloat) {
       if (bitpix != -32) {
          throw (AipsError("bitpix card inconsistent with data type: expected bitpix = -32"));
       }
    } else if (dataType==TpDouble) {
       if (bitpix != -64) {
          throw (AipsError("bitpix card inconsistent with data type: expected bitpix = -64"));
       }
    } else if (dataType==TpInt) {
       if (bitpix != 32) {
          throw (AipsError("bitpix card inconsistent with data type: expected bitpix = 32"));
       }
    } else if (dataType==TpShort) {
       if (bitpix != 16) {
          throw (AipsError("bitpix card inconsistent with data type: expected bitpix = 16"));
       }
    }  else if (dataType==TpUChar) {
       if (bitpix != 8) {
          throw (AipsError("bitpix card inconsistent with data type: expected bitpix = 16"));
       }
    } else {
       throw (AipsError("Unsupported Template type; Float & Double only are supported"));
    }

// Scale and blank (will only be present for Int and Short)

    Double s = 1.0;
    Double o = 0.0;
    if (headerRec.isDefined("bscale")) {
       subRec = headerRec.asRecord("bscale");
       subRec.get("value", s);
       headerRec.removeField("bscale");
    }
    if (headerRec.isDefined("bzero")) {
       subRec = headerRec.asRecord("bzero");
       subRec.get("value", o);
       headerRec.removeField("bzero");
    }
    scale = s;
    offset = o;

// Will only be present for Int and Short

    hasBlanks = False;
    if (headerRec.isDefined("blank")) {
       subRec = headerRec.asRecord("blank");
       Int m;
       subRec.get("value", m);
       headerRec.removeField("blank");
       if (dataType==TpUChar) {
          magicUChar = m;
       } else if (dataType==TpShort) {
          magicShort = m;
       } else if (dataType==TpInt) {
          magicInt = m;
       } else {
          magicUChar = m;
          magicShort = m;
          magicInt = m;
       }
       hasBlanks = True;
    }

// Brightness Unit

    brightnessUnit = ImageFITSConverter::getBrightnessUnit(headerRec, os);

// ImageInfo

    imageInfo = ImageFITSConverter::getImageInfo(headerRec);

// If we had one of those unofficial pseudo-Stokes on the Stokes axis, store it in the imageInfo

    if (stokesFITSValue != -1) {
       ImageInfo::ImageTypes type = ImageInfo::imageTypeFromFITS(stokesFITSValue);
       if (type!= ImageInfo::Undefined) {
          imageInfo.setImageType(type);
       }
    }

// Get rid of anything else we don't want to end up in MiscInfo
// that will have passed through the FITS parsing process

    Vector<String> ignore(12);
    ignore(0) = "^datamax$";
    ignore(1) = "^datamin$";
    ignore(2) = "^origin$";
    ignore(3) = "^extend$";
    ignore(4) = "^blocked$";
    ignore(5) = "^blank$";
    ignore(6) = "^simple$";
    ignore(7) = "bscale";
    ignore(8) = "bzero";
    ignore(9) = "xtension";
    ignore(10) = "pcount";
    ignore(11) = "gcount";
    FITSKeywordUtil::removeKeywords(headerRec, ignore);

// MiscInfo is whats left

    ImageFITSConverter::extractMiscInfo(miscInfo, headerRec);

// Get and store history.

    Vector<String> lines;
    String groupType;
    ConstFitsKeywordList kw = fitsImage.kwlist();
    kw.first();

// Set the contents of the ImageInterface logger object (history)

    LoggerHolder& log = logger();
    ImageFITSConverter::restoreHistory(log, kw);

// Try and find the restoring beam in the history cards if
// its not in the header

    if (! imageInfo.hasSingleBeam()) {
       imageInfo.getRestoringBeam(log);
    }
}

/*
template void FITSImage::crackHeader<Double> (CoordinateSystem &, IPosition &, ImageInfo &, Unit &, RecordInterface &, Float &, Float &, Short &, Int &, Bool &, LogIO &, FitsInput &, uInt);
template void FITSImage::crackHeader<Float> (CoordinateSystem &, IPosition &, ImageInfo &, Unit &, RecordInterface &, Float &, Float &, Short &, Int &, Bool &, LogIO &, FitsInput &, uInt);
template void FITSImage::crackHeader<Int> (CoordinateSystem &, IPosition &, ImageInfo &, Unit &, RecordInterface &, Float &, Float &, Short &, Int &, Bool &, LogIO &, FitsInput &, uInt);
template void FITSImage::crackHeader<Short> (CoordinateSystem &, IPosition &, ImageInfo &, Unit &, RecordInterface &, Float &, Float &, Short &, Int &, Bool &, LogIO &, FitsInput &, uInt);
*/

} //# NAMESPACE CASACORE - END


#endif
