ossimIkonosMetaData Class Reference

#include <ossimIkonosMetaData.h>

Inheritance diagram for ossimIkonosMetaData:

Public Member Functions
	ossimIkonosMetaData ()
	default constructor More...
bool	open (const ossimFilename &imageFile)
	Open method that takes the image file, derives the metadata, header and rpc files, then calls parse methods parseMetaData, parseHdrData, and parseRpcData. More...
void	clearFields ()
ossimString	getSensorID () const
virtual std::ostream &	print (std::ostream &out) const
	Generic print method. More...
virtual bool	saveState (ossimKeywordlist &kwl, const char *prefix=0) const
	Method to save the state of the object to a keyword list. More...
virtual bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)
	Method to the load (recreate) the state of the object from a keyword list. More...
bool	parseMetaData (const ossimFilename &metadata)
	Method to parse Ikonos metadata file. More...
bool	parseHdrData (const ossimFilename &data_file)
	Method to parse Ikonos header file. More...
bool	parseRpcData (const ossimFilename &data_file)
	Method to parse Ikonos rpc file. More...
Public Member Functions inherited from ossimObject
	ossimObject ()
virtual	~ossimObject ()
virtual ossimObject *	dup () const
virtual ossimString	getShortName () const
virtual ossimString	getLongName () const
virtual ossimString	getDescription () const
virtual ossimString	getClassName () const
virtual RTTItypeid	getType () const
virtual bool	canCastTo (ossimObject *obj) const
virtual bool	canCastTo (const RTTItypeid &id) const
virtual bool	canCastTo (const ossimString &parentClassName) const
virtual bool	isEqualTo (const ossimObject &obj, ossimCompareType compareType=OSSIM_COMPARE_FULL) const
virtual void	accept (ossimVisitor &visitor)
Public Member Functions inherited from ossimReferenced
	ossimReferenced ()
	ossimReferenced (const ossimReferenced &)
ossimReferenced &	operator= (const ossimReferenced &)
void	ref () const
	increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
void	unref () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
void	unref_nodelete () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
int	referenceCount () const

Protected Member Functions
virtual	~ossimIkonosMetaData ()
	virtual destructor More...
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Private Attributes
ossim_float64	theNominalCollectionAzimuth
ossim_float64	theNominalCollectionElevation
ossim_float64	theSunAzimuth
ossim_float64	theSunElevation
ossim_uint32	theNumBands
ossimString	theBandName
ossimString	theProductionDate
ossimString	theAcquisitionDate
ossimString	theAcquisitionTime
ossimString	theSensorID

Detailed Description

Definition at line 27 of file ossimIkonosMetaData.h.

Constructor & Destructor Documentation

ossimIkonosMetaData()

ossimIkonosMetaData::ossimIkonosMetaData

(

)

default constructor

Definition at line 30 of file ossimIkonosMetaData.cpp.

  :
  theNominalCollectionAzimuth(0.0),
  theNominalCollectionElevation(0.0),
  theSunAzimuth(0.0),
  theSunElevation(0.0),
  theNumBands(0),
  theBandName("Unknown"),
  theProductionDate("Unknown"),
  theAcquisitionDate("Unknown"),
  theAcquisitionTime("Unknown"),
  theSensorID("Unknown")
{
}

~ossimIkonosMetaData()

ossimIkonosMetaData::~ossimIkonosMetaData ( )

protectedvirtual

virtual destructor

Definition at line 45 of file ossimIkonosMetaData.cpp.

{
}

Member Function Documentation

clearFields()

void ossimIkonosMetaData::clearFields

(

)

Definition at line 116 of file ossimIkonosMetaData.cpp.

References theAcquisitionDate, theAcquisitionTime, theBandName, theNominalCollectionAzimuth, theNominalCollectionElevation, theNumBands, theProductionDate, theSensorID, theSunAzimuth, and theSunElevation.

Referenced by loadState(), and open().

{
  theNominalCollectionAzimuth = 0.0;
  theNominalCollectionElevation = 0.0;
  theSunAzimuth = 0.0;
  theSunElevation = 0.0;
  theNumBands = 0;
  theBandName = "Unknown";
  theProductionDate = "Unknown";
  theAcquisitionDate = "Unknown";
  theAcquisitionTime = "Unknown";
  theSensorID = "Unknown";
}

getSensorID()

ossimString ossimIkonosMetaData::getSensorID

(

)

const

Definition at line 151 of file ossimIkonosMetaData.cpp.

References theSensorID.

{
  return theSensorID;
}

loadState()

bool ossimIkonosMetaData::loadState ( const ossimKeywordlist &  kwl, const char *  prefix = 0  )

virtual

Method to the load (recreate) the state of the object from a keyword list.

Return true if ok or false on error.

Reimplemented from ossimObject.

Definition at line 218 of file ossimIkonosMetaData.cpp.

References ossimKeywordNames::AZIMUTH_ANGLE_KW, clearFields(), ossimKeywordNames::ELEVATION_ANGLE_KW, ossimKeywordlist::find(), ossimKeywordNames::NUMBER_BANDS_KW, theAcquisitionDate, theAcquisitionTime, theBandName, theNominalCollectionAzimuth, theNominalCollectionElevation, theNumBands, theProductionDate, theSensorID, theSunAzimuth, theSunElevation, ossimString::toFloat64(), ossimString::toUInt32(), and ossimKeywordNames::TYPE_KW.

Referenced by ossimIkonosRpcModel::loadState().

{
   clearFields();

   const char* lookup = 0;
   ossimString s;
  
   lookup = kwl.find(prefix, ossimKeywordNames::TYPE_KW);
   if (lookup)
   {
      s = lookup;
      if(s != "ossimIkonosMetaData")
      {
         return false;
      }
   }

  lookup = kwl.find(prefix, "nominal_collection_azimuth_angle");
  if (lookup)
  {
     s = lookup;
     theNominalCollectionAzimuth = s.toFloat64();
  }

  lookup = kwl.find(prefix, "nominal_collection_elevation_angle");
  if (lookup)
  {
     s = lookup;
     theNominalCollectionElevation = s.toFloat64();
  }
  
   lookup = kwl.find(prefix, ossimKeywordNames::AZIMUTH_ANGLE_KW);
   if (lookup)
   {
      s = lookup;
      theSunAzimuth = s.toFloat64();
   }

   lookup = kwl.find(prefix, ossimKeywordNames::ELEVATION_ANGLE_KW);
   if (lookup)
   {
      s = lookup;
      theSunElevation = s.toFloat64();
   }
  
   lookup = kwl.find(prefix, ossimKeywordNames::NUMBER_BANDS_KW);
   if (lookup)
   {
      s = lookup;
      theNumBands = s.toUInt32();
   }

   lookup = kwl.find(prefix, "band_name");
   if (lookup)
   {
      theBandName = lookup;
   }

   lookup = kwl.find(prefix, "production_date");
   if (lookup)
   {
      theProductionDate = lookup;
   }

  lookup = kwl.find(prefix, "acquisition_date");
  if (lookup)
  {
     theAcquisitionDate = lookup;
  }

  lookup = kwl.find(prefix, "acquisition_time");
  if (lookup)
  {
     theAcquisitionTime = lookup;
  }

  lookup = kwl.find(prefix, "sensor");
  if (lookup)
  {
     theSensorID = lookup;
  }
  
   return true;
}

open()

bool ossimIkonosMetaData::open

(

const ossimFilename &

imageFile

)

Open method that takes the image file, derives the metadata, header and rpc files, then calls parse methods parseMetaData, parseHdrData, and parseRpcData.

Parameters

imageFile

Usually in the form of "po_2619900_pan_0000000.tif".

Returns

true on success, false on error.

Definition at line 49 of file ossimIkonosMetaData.cpp.

References clearFields(), ossimFilename::fileNoExtension(), and ossimString::split().

Referenced by ossimIkonosRpcModel::parseTiffFile().

{
   static const char MODULE[] = "ossimIkonosMetaData::open";
   
   clearFields();
   
   //retrieve information from the metadata file
   //if the ikonos tif is po_2619900_pan_0000000.tif
   //the metadata file will be po_2619900_metadata.txt

   ossimString separator("_");
   ossimString filenamebase = imageFile.fileNoExtension();
   std::vector< ossimString > filenameparts = filenamebase.split(separator);
   
   if(filenameparts.size() < 2)
   {
      if(traceDebug())
      {
         ossimNotify(ossimNotifyLevel_DEBUG)
            << MODULE << " Ikonos filename non standard" << std::endl;
      }
      return false;
   }
   ossimFilename metadatafile = filenameparts[0];
   metadatafile += "_";
   metadatafile += filenameparts[1];
   metadatafile += "_metadata.txt";
   
   metadatafile.setPath(imageFile.path());
   
   if( parseMetaData(metadatafile) == false )
   {
      if(traceDebug())
      {
         ossimNotify(ossimNotifyLevel_WARN)
            << MODULE << " errors parsing metadata" << std::endl;
      }
      return false;
   }
   
   ossimFilename hdrfile = imageFile;
   hdrfile.setExtension(ossimString("hdr"));
   if( parseHdrData(hdrfile) == false )
   {
      if(traceDebug())
      {
         ossimNotify(ossimNotifyLevel_WARN)
            << MODULE << " errors parsing hdr" << std::endl;
      }
      return false;
   }
   
   ossimFilename rpcfile = imageFile.noExtension();
   rpcfile += "_rpc.txt";
   if (parseRpcData (rpcfile) == false)
   {
      if(traceDebug())
      {
         ossimNotify(ossimNotifyLevel_WARN)
            << MODULE << " errors parsing rpc" << std::endl;
      }
      return false;
   }

   return true;
}

parseHdrData()

bool ossimIkonosMetaData::parseHdrData

(

const ossimFilename &

data_file

)

Method to parse Ikonos header file.

Parameters

metadata

File name usually in the form of "po_149875_pan_0000000.hdr"

Returns

true on success, false on error.

Definition at line 506 of file ossimIkonosMetaData.cpp.

{
   if (traceExec())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "DEBUG ossimIkonosRpcModel::parseHdrData(data_file): entering..."
         << std::endl;
   }

   FILE* fptr = fopen (data_file, "r");
   if (!fptr)
   {
      if (traceDebug())
      {
         ossimNotify(ossimNotifyLevel_WARN)
            << "ossimIkonosRpcModel::parseHdrData(data_file) WARN:"
            << "\nCould not open hdr data file <" << data_file << ">. "
            << "returning with error..." << std::endl;
      }
      return false;
   }

   char* strptr;
   // char linebuf[80];
   char dummy[80];
   char name[80];
   int value=0;

   //***
   // Read the file into a buffer:
   //***
   char filebuf[5000];
   fread(filebuf, 1, 5000, fptr);
   fclose(fptr);

   //***
   // Band name:
   //***
   strptr = strstr(filebuf, "\nBand:");
   if (!strptr)
   {
      if(traceDebug())
      {
         ossimNotify(ossimNotifyLevel_WARN)
            << "ossimIkonosRpcModel::parseHdrData(data_file):"
            << "\n\tAborting construction. Error encountered parsing "
            << "presumed hdr file." << std::endl;
      }

      return false;
   }

   sscanf(strptr, "%6c %s", dummy, name);
   theBandName = name;

   //***
   // Number of Bands:
   //***
   strptr = strstr(filebuf, "\nNumber of Bands:");
   if (!strptr)
   {
      if(traceDebug())
      {
         ossimNotify(ossimNotifyLevel_WARN)
            << "ossimIkonosRpcModel::parseHdrData(data_file):"
            << "\n\tAborting construction. Error encountered parsing "
            << "presumed hdr file." << std::endl;
      }

      return false;
   }

   sscanf(strptr, "%17c %d", dummy, &value);
   theNumBands = value;

   if (traceExec())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "DEBUG ossimIkonosRpcModel::parseHdrData(data_file): returning..."
         << std::endl;
   }
   return true;
}

parseMetaData()

bool ossimIkonosMetaData::parseMetaData

(

const ossimFilename &

metadata

)

Method to parse Ikonos metadata file.

Parameters

metadata

File name usually in the form of "po_149875_metadata.txt."

Returns

true on success, false on error.

Definition at line 310 of file ossimIkonosMetaData.cpp.

{
   if (traceExec())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "DEBUG ossimIkonosRpcModel::parseMetaData(data_file): entering..."
         << std::endl;
   }

   FILE* fptr = fopen (data_file, "r");
   if (!fptr)
   {
      if (traceDebug())
      {
         ossimNotify(ossimNotifyLevel_DEBUG)
            << "ossimIkonosRpcModel::parseMetaData(data_file) DEBUG:"
            << "\nCould not open Meta data file:  " << data_file
            << "\nreturning with error..." << std::endl;
      }
      return false;
   }

   char* strptr;
   char dummy[80], name[80];
   double value;

   //---
   // Read the file into a buffer:
   //---
   ossim_int32 fileSize = static_cast<ossim_int32>(data_file.fileSize());
   char* filebuf = new char[fileSize];
   fread(filebuf, 1, fileSize, fptr);
   fclose(fptr);

   //---
   // Production date:
   //---
   strptr = strstr(filebuf, "\nCreation Date:");
   if (!strptr)
   {
      if(traceDebug())
      {
         ossimNotify(ossimNotifyLevel_FATAL)
            << "FATAL ossimIkonosRpcModel::parseMetaData(data_file): "
            << "\n\tAborting construction. Error encountered parsing "
            << "presumed meta-data file." << std::endl;
      }
      delete [] filebuf;
      return false;
   }

   sscanf(strptr, "%15c %s", dummy, name);
   theProductionDate = name;

   //***
   // Sensor Type:
   //***
   strptr = strstr(strptr, "\nSensor:");
   if (!strptr)
   {
      if(traceDebug())
      { 
         ossimNotify(ossimNotifyLevel_FATAL)
            << "FATAL ossimIkonosRpcModel::parseMetaData(data_file): "
            << "\n\tAborting construction. Error encountered parsing "
            << "presumed meta-data file." << std::endl;
      }
      delete [] filebuf;
      return false;
   }

   sscanf(strptr, "%8c %s", dummy, name);
   theSensorID = name;


   //***
   // Nominal Azimuth:
   //***
   strptr = strstr(strptr, "\nNominal Collection Azimuth:");
   if (!strptr)
   {
      if(traceDebug())
      {
         ossimNotify(ossimNotifyLevel_FATAL)
            << "FATAL ossimIkonosRpcModel::parseMetaData(data_file): "
            << "\n\tAborting construction. Error encountered parsing "
            << "presumed meta-data file." << std::endl;
      }
      delete [] filebuf;
      return false;
   }

   sscanf(strptr, "%28c %lf %s", dummy, &value, dummy);
   theNominalCollectionAzimuth = value;

   //***
   // Nominal Elevation:
   //***
   strptr = strstr(strptr, "\nNominal Collection Elevation:");
   if (!strptr)
   {
      if(traceDebug())
      {
         ossimNotify(ossimNotifyLevel_FATAL)
            << "FATAL ossimIkonosRpcModel::parseMetaData(data_file): "
            << "\n\tAborting construction. Error encountered parsing "
            << "presumed meta-data file." << std::endl;
      }
      delete [] filebuf;
      return false;
   }
  
   sscanf(strptr, "%31c %lf %s", dummy, &value, dummy);
   theNominalCollectionElevation = value;

   //***
   // Sun Azimuth:
   //***
   strptr = strstr(strptr, "\nSun Angle Azimuth:");
   if (!strptr)
   {
      if(traceDebug())
      {
         ossimNotify(ossimNotifyLevel_FATAL)
            << "FATAL ossimIkonosRpcModel::parseMetaData(data_file): "
            << "\n\tAborting construction. Error encountered parsing "
            << "presumed meta-data file." << std::endl;
      }
      delete [] filebuf;
      return false;
   }

   sscanf(strptr, "%19c %lf %s", dummy, &value, dummy);
   theSunAzimuth = value;

   //***
   // Sun Elevation:
   //***
   strptr = strstr(strptr, "\nSun Angle Elevation:");
   if (!strptr)
   {
      if(traceDebug())
      {
         ossimNotify(ossimNotifyLevel_FATAL)
            << "FATAL ossimIkonosRpcModel::parseMetaData(data_file): "
            << "\n\tAborting construction. Error encountered parsing "
            << "presumed meta-data file." << std::endl;
      }
      delete [] filebuf;
      return false;
   }

   sscanf(strptr, "%21c %lf %s", dummy, &value, name);
   theSunElevation = value;

   //---
   // Acquisition date and time:
   //---
   strptr = strstr(filebuf, "\nAcquisition Date/Time:");
   if (!strptr)
   {
      if(traceDebug())
      {
      ossimNotify(ossimNotifyLevel_FATAL)
          << "FATAL ossimIkonosRpcModel::parseMetaData(data_file): "
          << "\n\tAborting construction. Error encountered parsing "
          << "presumed meta-data file." << std::endl;
      }
      delete [] filebuf;
      return false;
   }

   char name2[80];
   sscanf(strptr, "%23c %s %s", dummy, name, name2);
   theAcquisitionDate = name;
   theAcquisitionTime = name2;

   delete [] filebuf;
   filebuf = 0;

   if (traceExec())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "DEBUG ossimIkonosRpcModel::parseMetaData(data_file): returning..."
         << std::endl;
   }

   return true;
}

parseRpcData()

bool ossimIkonosMetaData::parseRpcData

(

const ossimFilename &

data_file

)

Method to parse Ikonos rpc file.

Parameters

metadata

File name usually in the form of "po_149875_pan_0000000_rpc.txt"

Returns

true on success, false on error.

Note

Currently NOT implemented.

Definition at line 596 of file ossimIkonosMetaData.cpp.

{
   return true;
}

print()

std::ostream & ossimIkonosMetaData::print ( std::ostream &  out ) const

virtual

Generic print method.

Derived classes should re-implement as they see fit.

Returns

std::ostream&

Reimplemented from ossimObject.

Definition at line 130 of file ossimIkonosMetaData.cpp.

References theAcquisitionDate, theAcquisitionTime, theBandName, theNominalCollectionAzimuth, theNominalCollectionElevation, theNumBands, theProductionDate, theSensorID, theSunAzimuth, and theSunElevation.

{

  out << "\n----------------- Info on Ikonos Image -------------------"
      << "\n  "
      << "\n  Nominal Azimuth:    " << theNominalCollectionAzimuth
      << "\n  Nominal Elevation:   " << theNominalCollectionElevation
      << "\n  Sun Azimuth:    " << theSunAzimuth
      << "\n  Sun Elevation:   " << theSunElevation
      << "\n  Number of bands:   " << theNumBands
      << "\n  Band name:   " << theBandName
      << "\n  Production date:   " << theProductionDate
      << "\n  Acquisition date:   " << theAcquisitionDate
      << "\n  Acquisition time:   " << theAcquisitionTime
      << "\n  Sensor Type:   " << theSensorID
      << "\n"
      << "\n---------------------------------------------------------"
      << "\n  " << std::endl;
  return out;
}

saveState()

bool ossimIkonosMetaData::saveState ( ossimKeywordlist &  kwl, const char *  prefix = 0  ) const

virtual

Method to save the state of the object to a keyword list.

Return true if ok or false on error.

Reimplemented from ossimObject.

Definition at line 156 of file ossimIkonosMetaData.cpp.

References ossimKeywordlist::add(), ossimKeywordNames::AZIMUTH_ANGLE_KW, ossimKeywordNames::ELEVATION_ANGLE_KW, ossimKeywordNames::NUMBER_BANDS_KW, theAcquisitionDate, theAcquisitionTime, theBandName, theNominalCollectionAzimuth, theNominalCollectionElevation, theNumBands, theProductionDate, theSensorID, theSunAzimuth, theSunElevation, and ossimKeywordNames::TYPE_KW.

Referenced by ossimIkonosRpcModel::saveState().

{

  kwl.add(prefix,
          ossimKeywordNames::TYPE_KW,
          "ossimIkonosMetaData",
          true);

  kwl.add(prefix,
          "nominal_collection_azimuth_angle",
          theNominalCollectionAzimuth,
          true);

  kwl.add(prefix,
          "nominal_collection_elevation_angle",
          theNominalCollectionElevation,
          true);
          
  kwl.add(prefix,
          ossimKeywordNames::AZIMUTH_ANGLE_KW,
          theSunAzimuth,
          true);

  kwl.add(prefix,
          ossimKeywordNames::ELEVATION_ANGLE_KW,
          theSunElevation,
          true);

  kwl.add(prefix,
          ossimKeywordNames::NUMBER_BANDS_KW,
          theNumBands,
          true);

  kwl.add(prefix,
          "band_name",
          theBandName,
          true);

  kwl.add(prefix,
          "production_date",
          theProductionDate,
          true);

  kwl.add(prefix,
          "acquisition_date",
          theAcquisitionDate,
          true);

  kwl.add(prefix,
          "acquisition_time",
          theAcquisitionTime,
          true);

  kwl.add(prefix,
          "sensor",
          theSensorID,
          true);

  return true;
}

Member Data Documentation

theAcquisitionDate

ossimString ossimIkonosMetaData::theAcquisitionDate

private

Definition at line 113 of file ossimIkonosMetaData.h.

Referenced by clearFields(), loadState(), print(), and saveState().

theAcquisitionTime

ossimString ossimIkonosMetaData::theAcquisitionTime

private

Definition at line 114 of file ossimIkonosMetaData.h.

Referenced by clearFields(), loadState(), print(), and saveState().

theBandName

ossimString ossimIkonosMetaData::theBandName

private

Definition at line 111 of file ossimIkonosMetaData.h.

Referenced by clearFields(), loadState(), print(), and saveState().

theNominalCollectionAzimuth

ossim_float64 ossimIkonosMetaData::theNominalCollectionAzimuth

private

Definition at line 106 of file ossimIkonosMetaData.h.

Referenced by clearFields(), loadState(), print(), and saveState().

theNominalCollectionElevation

ossim_float64 ossimIkonosMetaData::theNominalCollectionElevation

private

Definition at line 107 of file ossimIkonosMetaData.h.

Referenced by clearFields(), loadState(), print(), and saveState().

theNumBands

ossim_uint32 ossimIkonosMetaData::theNumBands

private

Definition at line 110 of file ossimIkonosMetaData.h.

Referenced by clearFields(), loadState(), print(), and saveState().

theProductionDate

ossimString ossimIkonosMetaData::theProductionDate

private

Definition at line 112 of file ossimIkonosMetaData.h.

Referenced by clearFields(), loadState(), print(), and saveState().

theSensorID

ossimString ossimIkonosMetaData::theSensorID

private

Definition at line 115 of file ossimIkonosMetaData.h.

Referenced by clearFields(), getSensorID(), loadState(), print(), and saveState().

theSunAzimuth

ossim_float64 ossimIkonosMetaData::theSunAzimuth

private

Definition at line 108 of file ossimIkonosMetaData.h.

Referenced by clearFields(), loadState(), print(), and saveState().

theSunElevation

ossim_float64 ossimIkonosMetaData::theSunElevation

private

Definition at line 109 of file ossimIkonosMetaData.h.

Referenced by clearFields(), loadState(), print(), and saveState().

---

The documentation for this class was generated from the following files:

• ossimIkonosMetaData.h
• ossimIkonosMetaData.cpp