ossimERS.cpp

Go to the documentation of this file.

//*******************************************************************
//
// License:  See top level LICENSE.txt file.
//
// Author: Chong-Ket Chuah
// Contributor: Anrew Huang
// 
// Description:
// Implementation of ossimERS class for parsing a ER Mapper raster
// file format header.
//
//********************************************************************
// $Id: ossimERS.cpp 17501 2010-06-02 11:14:55Z dburken $

#include <cstdio>
#include <fstream>
#include <iostream>
#include <iomanip>

#include <ossim/base/ossimCommon.h>
#include <ossim/base/ossimTrace.h>
#include <ossim/support_data/ossimERS.h>
#include <ossim/base/ossimKeywordNames.h>
#include <ossim/base/ossimNotifyContext.h>

static ossimTrace traceDebug("ossimERS:debug");


ossimERS::ossimERS()
   :
      ossimErrorStatusInterface()
{
   clearFields();
}

ossimERS::ossimERS(const char* headerFile)
   :
      ossimErrorStatusInterface()
{
   clearFields();

   // open the header file:
   std::ifstream in;
   in.open(headerFile, std::ios::in | std::ios::binary);

   if (!in)
   {
      theErrorStatus = ossimErrorCodes::OSSIM_ERROR;
   }

   // Begin parsing records:
   if (!theErrorStatus)
   {
      parseHeader(in);
   }

   if (traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "ossimERS DEBUG:"
         << *this
         << std::endl;
   }
}

void ossimERS::parseError(const char* /* msg*/ )
{
   theErrorStatus = ossimErrorCodes::OSSIM_ERROR;
}

void ossimERS::parseRasterInfo(std::istream& in)
{
   std::vector<ossimString> tokens;

   bool done = false;
   while (!done)
   {
      tokens = parseLine(in);
      if (tokens.empty())
      {
         parseError("premature end of header file.");
         return;
      }
      if (tokens[0] == "CellType")
      {
         if (tokens[1] == "Unsigned8BitInteger")
         {
            theCelltype = OSSIM_UCHAR;
         }
         else if (tokens[1] == "Unsigned16BitInteger")
         {
            theCelltype = OSSIM_USHORT16;
         }
         else if (tokens[1] == "Signed16BitInteger")
         {
            theCelltype = OSSIM_SSHORT16;
         }
         else if (tokens[1] == "IEEE4ByteReal")
         {
            theCelltype = OSSIM_FLOAT;
         }
         else if (tokens[1] == "IEEE8ByteReal")
         {
            theCelltype = OSSIM_DOUBLE;
         }
         else
         {
            parseError("Unsupported CellType.");
         }
      }
      else if (tokens[0] == "NullCellValue")
      {
         theHasNullCells = true;
         theNullCell = tokens[1].toInt();    // float nullcell value?
      }
      else if (tokens[0] == "Xdimension")
      { // ignore "CellInfo"
         theCellSizeX = tokens[1].toDouble();
      }
      else if (tokens[0] == "Ydimension")
      { // ignore "CellInfo"
         theCellSizeY = tokens[1].toDouble();
      }
      else if (tokens[0] == "NrOfLines")
      {
         theLine = tokens[1].toInt();
      }
      else if (tokens[0] == "NrOfCellsPerLine")
      {
         theSample = tokens[1].toInt();
      }
      else if (tokens[0] == "Eastings")
      { // ignore "RegistrationCoord"
         theTieUnitType = OSSIM_METERS;
         theOriginX = tokens[1].toDouble();
      }
      else if (tokens[0] == "Northings")
      { // ignore "RegistrationCoord"
         theTieUnitType = OSSIM_METERS;
         theOriginY = tokens[1].toDouble();
      }
      else if (tokens[0] == "Longitude")
      { // ignore "RegistrationCoord"
                                                // need to check coordinatestype ("Cannot use Latitude with UTM projection")
         double deg, min, sec;
         sscanf (tokens[1].chars(), "%lg:%lg:%lg", &deg, &min, &sec);
         theOriginX = std::abs(deg) + min/60.0 + sec/3600.0;
         if (deg < 0.0)
         {
            theOriginX = -theOriginX;
         }
         theTieUnitType = OSSIM_DEGREES;
      }
      else if (tokens[0] == "Latitude")
      { // ignore "RegistrationCoord"
         double deg, min, sec;
         sscanf (tokens[1].chars(), "%lg:%lg:%lg", &deg, &min, &sec);
         theOriginY = std::abs(deg) + min/60.0 + sec/3600.0;
         if (deg < 0.0)
         {
            theOriginY = -theOriginY;
         }
         theTieUnitType = OSSIM_DEGREES;
      }
      else if (tokens[0] == "NrOfBands")
      {
         theBands = tokens[1].toInt();
      }
      else if (tokens[0] == "Value")
      { // ignore "BandID"
        // keep adding to the bandID vector
        // delete Value key then join the rest of tokens
         tokens.erase(tokens.begin());
         ossimString id;
         id.join(tokens, " ");
         theBandID.push_back(id);
      }
      else if (tokens[0] == "RasterInfo")
      {
         done = true;
      }
   }
}


void ossimERS::parseCoordinateSpace(std::istream& in)
{
   std::vector<ossimString> tokens;

   bool done = false;
   while (!done)
   {
      tokens = parseLine(in);
      if (tokens.empty())
      {
         parseError("premature end of header file.");
         return;
      }
      if (tokens[0] == "Datum")
      {
         theDatum = tokens[1];
         if (theDatum != "WGS84" && theDatum != "RAW")
         {
            parseError("Datum must be WGS84 or RAW");
         }
      }
      else if (tokens[0] == "Projection")
      {
         theProjection = tokens[1];
         // need to parse projection string
         /*(EqualStrings (tok(1,3), "UTM")) {
           coordinateSystem = 'U';
           if (tok(0) == 'N')
           northernHemisphere = 1;
           else
           northernHemisphere = 0;
           spString zoneStr = tok(4,2);
           sscanf (zoneStr.chars(), "%d", &zone);
         */
      }
      else if (tokens[0] == "CoordinateType")
      {
         // ignore it
      }
      else if (tokens[0] == "Units")
      {
         // ignore it for now
      }
      else if (tokens[0] == "Rotation")
      {
         double deg, min, sec;
         sscanf (tokens[1].chars(), "%lg:%lg:%lg", &deg, &min, &sec);
         theRotation = deg + min/60.0 + sec/3600.0;
      }
      else if (tokens[0] == "CoordinateSpace")
      {
         done = true;
      }
   }

   // requires more error checking on unit and rotation here
   return;
}

void ossimERS::parseHeader(std::istream& in)
{
   theErrorStatus = ossimErrorCodes::OSSIM_OK;
   char magicNumberTest[14];
   in.read(magicNumberTest, 13);
   if(ossimString(magicNumberTest,
                  magicNumberTest+13) != "DatasetHeader")
   {
      parseError("First line must be DatasetHeader");
      return;
   }
   in.seekg(0);
   std::vector<ossimString> tokens = parseLine(in);
   if(!tokens.size())
   {
      parseError("First line must be DatasetHeader");
      return;
   }
   if (tokens[0] != "DatasetHeader")
   {
      parseError("First line must be DatasetHeader");
      return;
   }

   bool done = false;
   while (!done)
   {
      tokens = parseLine(in);
      if (tokens.empty())
      {
         parseError("premature end of header file.");
         return;
      }
      if (tokens[0] == "Version")
      {
         theVersion = tokens[1].toDouble();
         if (theVersion < 4.0)
         {
            parseError("Version must be 4.0 or greater");
         }
      }
      else if (tokens[0] == "DataSetType")
      {
         theDatasetType = tokens[1];
         if (theDatasetType != "ERStorage")
         {
            parseError("DataSetType must be ERStorage");
         }
      }
      else if (tokens[0] == "DataType")
      {
         theDatatype = tokens[1];
         if (theDatatype != "Raster")
         {
            parseError("DataType must be Raster");
         }
      }
      else if (tokens[0] == "ByteOrder")
      {
         theByteorder = tokens[1];
         if (theByteorder != "MSBFirst" && theByteorder != "LSBFirst")
         {
            parseError("ByteOrder must either be MSBFirst or LSBFirst");
         }
      }
      else if (tokens[0] == "CoordinateSpace")
      {
         if (tokens[1] == "Begin")
         {
            parseCoordinateSpace(in);
         }
      }
      else if (tokens[0] == "RasterInfo")
      {
         if (tokens[1] == "Begin")
         {
            parseRasterInfo(in);
         }
      }
      else if (tokens[0] == "SenseDate")
      {
         // ignore for now
      }
      else if (tokens[0] == "Comments")
      {
         // ignore for now
      }
      else if (tokens[0] == "DatasetHeader")
      {
         done = true;
      }
   }

   if(theProjection.contains("GEODETIC"))
   {
      theTieUnitType = OSSIM_DEGREES;
   }

   return;
}


// read a line from the file, split it using "= \t\n" delimiters.
// if the first token is empty, if the line begins with a tab, delete
// the token.  The second token, the value for the key, may be quoted.
// trim the quotes.
std::vector<ossimString> ossimERS::parseLine(std::istream& in)
{
/*   const int bufSize = 500; */
   ossimString line;
   std::vector<ossimString> tokens;
   bool invalidCharHit = false;
   const int MAX_LENGTH = 10000;
   int tempCount = 0;
   // read a line, skipping empty line
   while (tokens.empty()&&(in)&&(tempCount < MAX_LENGTH))
   {
     tempCount = 1;
      char c = in.get();
      while( (c != '\n')&&
             (!in.eof())&&
             (!invalidCharHit))
      {
         if(c > 0x7e)
         {
            invalidCharHit = true;
         }
         else
         {
            line += (char)c;
            c = in.get();
        ++tempCount;
         }
      }

      if(!invalidCharHit)
      {
         line.trim('\t');
         line.trim('\n');
         line.trim('\r');
         line.trim(' ');

         if(line != "")
         {
            tokens = line.split("= \t");
            if (tokens.size() > 1)
            {
               tokens[1].trim('\"');
               tokens.back().trim('\"');
            }
         }
      }
      else
      {
         tokens.clear();
         return tokens;
      }
   }
   if(in.bad()||(tempCount>=MAX_LENGTH))
     {
       tokens.clear();
     }

   return tokens;
}

bool ossimERS::writeFile(const ossimFilename &file)
{
   if (theDescription.empty())
   {
      theDescription = file;
   }
   
   std::ofstream out(file.c_str(), std::ios_base::out);
   
   if (!out)
   {
      return false;
   }
   
   print(out);
   out.close();
   return true;

}

std::ostream& ossimERS::print(std::ostream& out) const
{
   out<< std::setiosflags(std::ios::fixed) << std::setprecision(12);
   out<<"DatasetHeader Begin" <<std::endl;
   out<<"   Version     = \"5.5\"" <<std::endl;
   out<<"   DataSetType = " <<theDatasetType <<std::endl;
   out<<"   DataType    = " <<theDatatype <<std::endl;
   out<<"   ByteOrder   = " <<theByteorder <<std::endl;
   
   out<<"   CoordinateSpace Begin" <<std::endl;
   out<<"       Datum       = \"" <<theDatum <<"\"" <<std::endl;
   out<<"       Projection  = \"" <<theProjection <<"\"" <<std::endl;
   out<<"       CoordinateType  = " <<theCoordSysType <<std::endl;
   out<<"   CoordinateSpace End" <<std::endl;
   
   ossimString celltype;
   if (theCelltype == OSSIM_UINT8)
      celltype = "Unsigned8BitInteger";
   else if (theCelltype == OSSIM_SINT8)
      celltype = "Signed8BitInteger";
   else if (theCelltype == OSSIM_UINT16)
      celltype = "Unsigned16BitInteger";
   else if (theCelltype == OSSIM_SINT16)
      celltype = "Signed16BitInteger";
   else if (theCelltype == OSSIM_UINT32)
      celltype = "Unsigned32BitInteger";
   else if (theCelltype == OSSIM_SINT32)
      celltype = "Signed32BitInteger";
   else if (theCelltype == OSSIM_USHORT11)
      celltype = "Unsigned16BitInteger";
   else if (theCelltype == OSSIM_USHORT12)
      celltype = "Unsigned16BitInteger";
   else if (theCelltype == OSSIM_USHORT13)
      celltype = "Unsigned16BitInteger";
   else if (theCelltype == OSSIM_USHORT14)
      celltype = "Unsigned16BitInteger";
   else if (theCelltype == OSSIM_USHORT15)
      celltype = "Unsigned16BitInteger";
   else if (theCelltype == OSSIM_USHORT16)
      celltype = "Unsigned16BitInteger";
   
   out<<"   RasterInfo Begin" <<std::endl;
   out<<"       CellType    = " <<celltype <<std::endl;
   
   out<<"       CellInfo Begin" <<std::endl;
   out<<"           Xdimension  = " <<theCellSizeX <<std::endl;
   out<<"           Ydimension  = " <<theCellSizeY <<std::endl;
   out<<"       CellInfo End" <<std::endl;
   
   out<<"       NrOfLines   = " <<theLine <<std::endl;
   out<<"       NrOfCellsPerLine    = " <<theSample <<std::endl;
   
   out<<"       RegistrationCoord Begin" <<std::endl;
   if (theTieUnitType == OSSIM_METERS)
   {
      out<<"            Eastings    = " <<theOriginX <<std::endl;
      out<<"            Northings   = " <<theOriginY <<std::endl;
   }
   else if (theTieUnitType == OSSIM_DEGREES)
   {
      bool minus = false;
      int min;
      double degrees, seconds;
      degrees = theOriginY;
      if (theOriginY < 0)
      {
         minus = true;
         degrees *=-1;
      }
      min = (int)((degrees-(int)degrees)*60);
      seconds =  ((degrees-(int)degrees)*60 - min)*60;
      if (minus)
         degrees *= -1;
      out<<"            Latitude    = "
         <<(int)degrees<<":"<<min<<":"<<seconds<<std::endl;
      
      minus = false;
      degrees = theOriginX;
      if (theOriginX < 0)
      {
         minus = true;
         degrees *=-1;
      }
      min = (int)((degrees-(int)degrees)*60);
      seconds =  ((degrees-(int)degrees)*60 - min)*60;
      if (minus)
         degrees *= -1;
      out<<"            Longitude   = "
         <<(int)degrees<<":"<<min<<":"<<seconds<<std::endl;
   }
   out<<"       RegistrationCoord End" <<std::endl;
   
   out<<"       NrOfBands   = " <<theBands <<std::endl;
   out<<"   RasterInfo End" <<std::endl;
   
   out<<"DatasetHeader End" <<std::endl;
   
   return out;
}

bool ossimERS::toOssimProjectionGeom(ossimKeywordlist& kwl,
                                     const char* prefix)const
{
   ossimString proj  = toOssimProjection();
   ossimString datum = toOssimDatum();

   if(proj == "")
   {
      return false;
   }

   kwl.add(prefix,
           ossimKeywordNames::TYPE_KW,
           proj.c_str(),
           true);

   kwl.add(prefix,
           ossimKeywordNames::DATUM_KW,
           datum.c_str(),
           true);

   // if it's UTM we have to extract out zone and hemisphere
   // from the projection name stored by ERMapper.
   //
   if(proj == "ossimUtmProjection")
   {
      ossimString zone(theProjection.begin()+4,
                       theProjection.end());
      ossimString hemisphere(theProjection.begin(),
                             theProjection.begin()+1);
      kwl.add(prefix,
              ossimKeywordNames::ZONE_KW,
              zone.c_str(),
              true);
      kwl.add(prefix,
              ossimKeywordNames::HEMISPHERE_KW,
              hemisphere.c_str(),
              true);
   }

   if(theTieUnitType == OSSIM_METERS)
   {
      kwl.add(prefix,
              ossimKeywordNames::TIE_POINT_EASTING_KW,
              theOriginX + theCellSizeX/2,
              true);
      kwl.add(prefix,
              ossimKeywordNames::TIE_POINT_NORTHING_KW,
              theOriginY - theCellSizeY/2,
              true);
      kwl.add(prefix,
              ossimKeywordNames::METERS_PER_PIXEL_X_KW,
              theCellSizeX,
              true);
      kwl.add(prefix,
              ossimKeywordNames::METERS_PER_PIXEL_Y_KW,
              theCellSizeY,
              true);

   }
   else if(theTieUnitType == OSSIM_DEGREES)
   {
      kwl.add(prefix,
              ossimKeywordNames::TIE_POINT_LAT_KW,
              theOriginY - theCellSizeY/2,
              true);
      kwl.add(prefix,
              ossimKeywordNames::TIE_POINT_LON_KW,
              theOriginX + theCellSizeX/2,
              true);
      kwl.add(prefix,
              ossimKeywordNames::DECIMAL_DEGREES_PER_PIXEL_LON,
              theCellSizeX,
              true);
      kwl.add(prefix,
              ossimKeywordNames::DECIMAL_DEGREES_PER_PIXEL_LAT,
              theCellSizeY,
              true);
   }

   return true;
}

ossimString ossimERS::toOssimProjection()const
{
   ossimString result = "";

   if(theProjection.contains("UTM"))
   {
      result = "ossimUtmProjection";
   }
   else if(theProjection.contains("GEODETIC"))
   {
      result = "ossimEquDistCylProjection";
   }

   return result;
}

ossimString ossimERS::toOssimDatum()const
{
   ossimString result = "WGE"; // wgs 84 default datum code

   if(theDatum != "WGS84")
   {
      ossimNotify(ossimNotifyLevel_WARN) << "WARNING Datum ossimERS::toOssimDatum: " << theDatum << " is not handled in ossimERS::toOssimDatum()\n"
                                            << "Please notify us with the datum name so we can add it\n";
   }

   return result;
}

//***************************************************************************
// PRIVATE METHOD: ossimERS::initialize()
// Initializes all fields to blanks (or 0's) and null terminates strings.
//***************************************************************************
void ossimERS::clearFields()
{
//   static const char source[] = "";

   theErrorStatus = ossimErrorCodes::OSSIM_OK;
   theVersion       = 0;
   theFilename      = "";
   theDescription   = "";
   theSensorname    = "";
   theHeaderOffset = 0;
   theDatasetType   = "";
   theDatatype      = "";
   theByteorder     = "";
   theComments      = "";
   theDatum         = "";
   theProjection    = "";
   theCoordSysType  = "";
   theUnits         = "";
   theRotation      = 0.0;
   theCelltype      = OSSIM_SCALAR_UNKNOWN;
   theCellsizeof    = 0;
   theHasNullCells  = false;
   theNullCell      = 0;
   theCellSizeX     = 0;
   theCellSizeY     = 0;
   theLine       = 0;
   theSample     = 0;
   theOriginX       = 0;
   theOriginY       = 0;
   theBands      = 0;
   theTieUnitType= OSSIM_UNIT_UNKNOWN;
   theBandID.clear();

   return;
}