ossimSrtmSupportData Class Reference

#include <ossimSrtmSupportData.h>

Inheritance diagram for ossimSrtmSupportData:

Public Member Functions
	ossimSrtmSupportData ()
	default constructor More...
virtual	~ossimSrtmSupportData ()
	destructor More...
bool	setFilename (const ossimFilename &srtmFile, bool scanForMinMax=false)
	Initializes object from file. More...
ossimFilename	getFilename () const
ossim_uint32	getNumberOfLines () const
ossim_uint32	getNumberOfSamples () const
virtual bool	getImageGeometry (ossimKeywordlist &kwl, const char *prefix=0)
	Populates the keyword list with image geometry information. More...
ossimRefPtr< ossimProjection >	getProjection () const
	Gets the projection for srtm cell. 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...
ossim_float64	getSouthwestLatitude () const
ossim_float64	getSouthwestLongitude () const
ossim_float64	getLatitudeSpacing () const
ossim_float64	getLongitudeSpacing () const
ossim_float64	getMinPixelValue () const
ossim_float64	getMaxPixelValue () const
ossimScalarType	getScalarType () const
virtual std::ostream &	print (std::ostream &out) const
	Prints data members for debug. 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

Private Member Functions
bool	loadOmd (const ossimKeywordlist &kwl, const char *prefix=0)
	This is a loadState called by setFilename that does not reset "theFile". More...
void	clear ()
	Sets all data members to an unitialized state. More...
bool	setCornerPoints ()
	Sets corner points from "theFile". More...
bool	setSize ()
	Sets lines and samples from "theFile" size. More...
bool	computeMinMax ()
	Scans file for min and max pixels. More...
template<class T >
bool	computeMinMaxTemplate (T dummy, double defaultNull)

Private Attributes
ossimFilename	m_file
ossim_uint32	m_numberOfLines
ossim_uint32	m_numberOfSamples
ossim_float64	m_southwestLatitude
ossim_float64	m_southwestLongitude
ossim_float64	m_latSpacing
ossim_float64	m_lonSpacing
ossim_float64	m_minPixelValue
ossim_float64	m_maxPixelValue
ossimScalarType	m_scalarType
std::shared_ptr< ossim::istream >	m_str

Additional Inherited Members
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Detailed Description

Definition at line 35 of file ossimSrtmSupportData.h.

Constructor & Destructor Documentation

ossimSrtmSupportData()

ossimSrtmSupportData::ossimSrtmSupportData

(

)

default constructor

Definition at line 45 of file ossimSrtmSupportData.cpp.

   :
   m_file(),
   m_numberOfLines(0),
   m_numberOfSamples(0),
   m_southwestLatitude(ossim::nan()),
   m_southwestLongitude(ossim::nan()),
   m_latSpacing(ossim::nan()),
   m_lonSpacing(ossim::nan()),
   m_minPixelValue(DEFAULT_MIN),
   m_maxPixelValue(DEFAULT_MAX),
   m_scalarType(OSSIM_SCALAR_UNKNOWN),
   m_str(0)
{
}

~ossimSrtmSupportData()

ossimSrtmSupportData::~ossimSrtmSupportData ( )

virtual

destructor

Definition at line 61 of file ossimSrtmSupportData.cpp.

{
}

Member Function Documentation

clear()

void ossimSrtmSupportData::clear ( )

private

Sets all data members to an unitialized state.

Definition at line 537 of file ossimSrtmSupportData.cpp.

References m_file, m_latSpacing, m_lonSpacing, m_minPixelValue, m_numberOfLines, m_numberOfSamples, m_southwestLatitude, m_southwestLongitude, ossim::nan(), and ossimFilename::NIL.

{
   m_file               = ossimFilename::NIL;
   m_numberOfLines      = 0;
   m_numberOfSamples    = 0;
   m_southwestLatitude  = ossim::nan();
   m_southwestLongitude = ossim::nan();
   m_latSpacing         = ossim::nan();
   m_lonSpacing         = ossim::nan();
   m_minPixelValue      = DEFAULT_MIN;
   m_maxPixelValue      = DEFAULT_MAX;
}

computeMinMax()

bool ossimSrtmSupportData::computeMinMax ( )

private

Scans file for min and max pixels.

true on success, false on error.

Definition at line 820 of file ossimSrtmSupportData.cpp.

References computeMinMaxTemplate(), m_scalarType, and OSSIM_FLOAT32.

{
   if(m_scalarType == OSSIM_FLOAT32)
   {
      return computeMinMaxTemplate((ossim_float32)0,
                                   -32768.0);
   }
   return computeMinMaxTemplate((ossim_sint16)0,
                                -32768.0);
}

computeMinMaxTemplate()

template<class T >

bool ossimSrtmSupportData::computeMinMaxTemplate ( T  dummy, double  defaultNull  )

private

Definition at line 832 of file ossimSrtmSupportData.cpp.

References ossim::byteOrder(), ossim::StreamFactoryRegistry::createIstream(), ossim::defaultNull(), FLT_EPSILON, ossim::StreamFactoryRegistry::instance(), m_file, m_maxPixelValue, m_minPixelValue, m_numberOfLines, m_numberOfSamples, m_str, OSSIM_LITTLE_ENDIAN, and ossimEndian::swap().

Referenced by computeMinMax().

{

   if(!m_str)
   {
      m_str =
         ossim::StreamFactoryRegistry::instance()->createIstream(
                                              m_file);
   }
   
   if (!m_str)
   {
      return false;
   }

   if(m_str->fail())
   {
      return false;
   }
   
   const size_t BYTES_IN_LINE = m_numberOfSamples * 2;
   const T NULL_PIX = (T)defaultNull;

   double minValue = 1.0/FLT_EPSILON;
   double maxValue = -1.0/FLT_EPSILON;
   T* line_buf = new T[m_numberOfSamples];
   char* char_buf = (char*)line_buf;
   ossimEndian swapper;

   ossimByteOrder endianType = ossim::byteOrder();
   for (ossim_uint32 line = 0; line < m_numberOfLines; ++line)
   {
      m_str->read(char_buf, (std::streamsize)BYTES_IN_LINE);
      if(endianType == OSSIM_LITTLE_ENDIAN)
      {
         swapper.swap(line_buf, m_numberOfSamples);
      }
      for (ossim_uint32 sample = 0; sample < m_numberOfSamples; ++sample)
      {
         if (line_buf[sample] == NULL_PIX) continue;
         if (line_buf[sample] > maxValue) maxValue = line_buf[sample];
         if (line_buf[sample] < minValue) minValue = line_buf[sample];
      }
   }
   delete [] line_buf;
   m_minPixelValue = minValue;
   m_maxPixelValue = maxValue;

   m_str = 0;
   return true;
}

getFilename()

ossimFilename ossimSrtmSupportData::getFilename

(

)

const

Returns

Returns the srtm file name.

Definition at line 182 of file ossimSrtmSupportData.cpp.

References m_file.

{
   return m_file;
}

getImageGeometry()

bool ossimSrtmSupportData::getImageGeometry ( ossimKeywordlist &  kwl, const char *  prefix = 0  )

virtual

Populates the keyword list with image geometry information.

This method is used to relay projection information to users.

Parameters

kwl	Keyword list that will be initialized with geometry info. Returns true if geometry info is present, false if not.
prefix	The prefix is added to the resulting keyword list keywords. So is you if you pass in a prefix of "image01.", the keyword ul_lat will be like: "image01.ul_lat: -40.00000"

Definition at line 197 of file ossimSrtmSupportData.cpp.

References ossimKeywordlist::add(), ossimKeywordNames::CENTRAL_MERIDIAN_KW, ossimKeywordNames::DATUM_KW, ossimKeywordNames::DECIMAL_DEGREES_PER_PIXEL_LAT, ossimKeywordNames::DECIMAL_DEGREES_PER_PIXEL_LON, ossimDatumFactory::instance(), m_file, m_latSpacing, m_lonSpacing, m_numberOfLines, m_numberOfSamples, m_southwestLatitude, m_southwestLongitude, ossimFilename::NIL, ossimKeywordNames::NUMBER_LINES_KW, ossimKeywordNames::NUMBER_SAMPLES_KW, ossimKeywordNames::ORIGIN_LATITUDE_KW, ossimKeywordNames::TIE_POINT_LAT_KW, ossimKeywordNames::TIE_POINT_LON_KW, and ossimKeywordNames::TYPE_KW.

{
   if (m_file == ossimFilename::NIL)
   {
      return false;
   }
   
   kwl.add(prefix,
           ossimKeywordNames::TYPE_KW,
           "ossimEquDistCylProjection",
           true);

   kwl.add(prefix,
           ossimKeywordNames::ORIGIN_LATITUDE_KW,
           0.0,
           true);
   
   kwl.add(prefix,
           ossimKeywordNames::CENTRAL_MERIDIAN_KW,
           m_southwestLongitude,
           true);
   
   kwl.add(prefix,
           ossimKeywordNames::TIE_POINT_LAT_KW,
           (m_southwestLatitude+1.0),
           true);

   kwl.add(prefix,
           ossimKeywordNames::TIE_POINT_LON_KW,
           m_southwestLongitude,
           true);

   // Add the pixel scale.
   kwl.add(prefix,
           ossimKeywordNames::DECIMAL_DEGREES_PER_PIXEL_LAT,
           m_latSpacing,
           true);
   
   kwl.add(prefix,
           ossimKeywordNames::DECIMAL_DEGREES_PER_PIXEL_LON,
           m_lonSpacing,
           true);

   // Add the datum.  (always WGS-84 per spec)
   kwl.add(prefix,
           ossimKeywordNames::DATUM_KW,
           ossimDatumFactory::instance()->wgs84()->code(),
           true);

   // Add the number of lines and samples.
   kwl.add(prefix,
           ossimKeywordNames::NUMBER_LINES_KW,
           m_numberOfLines,
           true);

   kwl.add(prefix,
           ossimKeywordNames::NUMBER_SAMPLES_KW,
           m_numberOfSamples,
           true);
   
   return true;
}

getLatitudeSpacing()

ossim_float64 ossimSrtmSupportData::getLatitudeSpacing

(

)

const

Returns

Returns the latitude spacing in decimal degrees. Returns OSSIM_DBL_NAN if not initialized or file was invalid.

Definition at line 527 of file ossimSrtmSupportData.cpp.

References m_latSpacing.

Referenced by ossimSrtmHandler::open().

{
   return m_latSpacing;
}

getLongitudeSpacing()

ossim_float64 ossimSrtmSupportData::getLongitudeSpacing

(

)

const

Returns

Returns the longitude spacing in decimal degrees. Returns OSSIM_DBL_NAN if not initialized or file was invalid.

Definition at line 532 of file ossimSrtmSupportData.cpp.

References m_lonSpacing.

Referenced by ossimSrtmHandler::open().

{
   return m_lonSpacing;
}

getMaxPixelValue()

ossim_float64 ossimSrtmSupportData::getMaxPixelValue

(

)

const

Returns

Returns the maximum pixel value. This is also the minimum height above sea level. Returns OSSIM_SSHORT_NAN if not initialized or file was invalid.

Definition at line 890 of file ossimSrtmSupportData.cpp.

References m_maxPixelValue.

{
   return m_maxPixelValue;
}

getMinPixelValue()

ossim_float64 ossimSrtmSupportData::getMinPixelValue

(

)

const

Returns

Returns the minimum pixel value. This is also the minimum height above sea level. Returns OSSIM_SSHORT_NAN if not initialized or file was invalid.

Definition at line 885 of file ossimSrtmSupportData.cpp.

References m_minPixelValue.

{
   return m_minPixelValue;
}

getNumberOfLines()

ossim_uint32 ossimSrtmSupportData::getNumberOfLines

(

)

const

Returns

Returns the number of lines or rows. Returns OSSIM_UINT_NAN if not initialized or file was invalid.

Definition at line 187 of file ossimSrtmSupportData.cpp.

References m_numberOfLines.

Referenced by ossimSrtmHandler::open().

{
   return m_numberOfLines;
}

getNumberOfSamples()

ossim_uint32 ossimSrtmSupportData::getNumberOfSamples

(

)

const

Returns

Returns the number of samples or columns. Returns OSSIM_UINT_NAN if not initialized or file was invalid.

Definition at line 192 of file ossimSrtmSupportData.cpp.

References m_numberOfSamples.

Referenced by ossimSrtmHandler::open().

{
   return m_numberOfSamples;
}

getProjection()

ossimRefPtr< ossimProjection > ossimSrtmSupportData::getProjection

(

)

const

Gets the projection for srtm cell.

Returns

The projection for srtm cell.

Definition at line 261 of file ossimSrtmSupportData.cpp.

References ossimDatum::ellipsoid(), ossimRefPtr< T >::get(), ossimDatumFactory::instance(), m_latSpacing, m_lonSpacing, m_southwestLatitude, m_southwestLongitude, ossimMapProjection::setDecimalDegreesPerPixel(), ossimMapProjection::setUlTiePoints(), and ossimDatumFactory::wgs84().

{
   //---
   // Make an Equidistant Cylindrical projection with a origin at the equator
   // since the DTED post spacing is considered to be square.
   //---
   const ossimDatum* datum = ossimDatumFactory::instance()->wgs84();
   ossimRefPtr<ossimEquDistCylProjection> eq = new ossimEquDistCylProjection(*(datum->ellipsoid()));
   
   //---
   // Set the tie point.
   // NOTE: Latitude southwest corner we need northwest; hence, the +1.
   //---
   eq->setUlTiePoints( ossimGpt(m_southwestLatitude+1.0, m_southwestLongitude, 0.0, datum) );
   
   // Set the scale:
   eq->setDecimalDegreesPerPixel( ossimDpt(m_lonSpacing, m_latSpacing) );

   ossimRefPtr<ossimProjection> proj = eq.get();

   return proj;
}

getScalarType()

ossimScalarType ossimSrtmSupportData::getScalarType

(

)

const

Definition at line 895 of file ossimSrtmSupportData.cpp.

References m_scalarType.

Referenced by ossimSrtmHandler::open().

{
   return m_scalarType;
}

getSouthwestLatitude()

ossim_float64 ossimSrtmSupportData::getSouthwestLatitude

(

)

const

Returns

Returns the Southwest latitude in decimal degrees. Returns OSSIM_DBL_NAN if not initialized or file was invalid.

Definition at line 518 of file ossimSrtmSupportData.cpp.

References m_southwestLatitude.

Referenced by ossimSrtmHandler::open().

{
   return m_southwestLatitude;
}

getSouthwestLongitude()

ossim_float64 ossimSrtmSupportData::getSouthwestLongitude

(

)

const

Returns

Returns the Southwest longitude in decimal degrees. Returns OSSIM_DBL_NAN if not initialized or file was invalid.

Definition at line 523 of file ossimSrtmSupportData.cpp.

References m_southwestLongitude.

Referenced by ossimSrtmHandler::open().

{
   return m_southwestLongitude;
}

loadOmd()

bool ossimSrtmSupportData::loadOmd ( const ossimKeywordlist &  kwl, const char *  prefix = 0  )

private

This is a loadState called by setFilename that does not reset "theFile".

Definition at line 418 of file ossimSrtmSupportData.cpp.

References ossimKeywordlist::findKey(), ossimLookUpTable::getEntryNumber(), ossimScalarTypeLut::instance(), m_latSpacing, m_lonSpacing, m_maxPixelValue, m_minPixelValue, m_numberOfLines, m_numberOfSamples, m_scalarType, m_southwestLatitude, m_southwestLongitude, ossimKeywordNames::MAX_VALUE_KW, ossimKeywordNames::MIN_VALUE_KW, ossimLookUpTable::NOT_FOUND, ossimKeywordNames::NUMBER_LINES_KW, ossimKeywordNames::NUMBER_SAMPLES_KW, OSSIM_FLOAT32, OSSIM_SINT16, ossimString::size(), ossimString::string(), ossimKeywordNames::TIE_POINT_LAT_KW, ossimKeywordNames::TIE_POINT_LON_KW, ossimString::toFloat64(), and ossimString::toUInt32().

Referenced by loadState().

{
   std::string pfx;
   std::string bandPrefix;
   
   if (prefix) // Cannot give null to std::string.
   {
      pfx        = prefix;
      bandPrefix = prefix;
   }
   bandPrefix += "band1.";
   
   ossimString value;

   //---
   // Look for the min and max first since they could have been populated by
   // "cmm" (compute min max).  Min and Max are not required by this method
   // as they are handled elsewhere if they are not found here.
   //---
   
   // Not an error if not present.
   value.string() = kwl.findKey(bandPrefix, std::string(ossimKeywordNames::MIN_VALUE_KW));
   if ( value.size() )
   {
      m_minPixelValue = value.toFloat64();
   }
   
   // Not an error if not present.
   value.string() = kwl.findKey(bandPrefix.c_str(), std::string(ossimKeywordNames::MAX_VALUE_KW));
   if ( value.size() )
   {
      m_maxPixelValue = value.toFloat64();
   }
   
   value.string() = kwl.findKey(pfx, std::string(ossimKeywordNames::NUMBER_LINES_KW));
   if ( value.size() )
   {
      m_numberOfLines = value.toUInt32();
   }
   else
   {
      return false;
   }
   
   value.string() = kwl.findKey(pfx, std::string(ossimKeywordNames::NUMBER_SAMPLES_KW));
   if ( value.size() )
   {
      m_numberOfSamples = value.toUInt32();
   }
   else
   {
      return false;
   }

   //---
   // Special case the tie point was stored as the upper left so we must
   // subtract one.
   //---
   value.string() = kwl.findKey(pfx, std::string(ossimKeywordNames::TIE_POINT_LAT_KW));
   if ( value.size() )
   {
      m_southwestLatitude = value.toFloat64() - 1.0;
   }
   else
   {
      return false;
   }

   value.string() = kwl.findKey(pfx, std::string(ossimKeywordNames::TIE_POINT_LON_KW));
   if ( value.size() )
   {
      m_southwestLongitude = value.toFloat64();
   }
   else
   {
      return false;
   }
   
   int scalar = ossimScalarTypeLut::instance()->getEntryNumber(kwl, prefix);
   
   if (scalar != ossimLookUpTable::NOT_FOUND)
   {
      m_scalarType = (ossimScalarType)scalar;
      if((m_scalarType != OSSIM_FLOAT32) && (m_scalarType != OSSIM_SINT16))
      {
         return false;
      }
   }
   else
   {
      return false;
   }
   
   m_latSpacing = 1.0 / (m_numberOfLines   - 1);
   m_lonSpacing = 1.0 / (m_numberOfSamples - 1);
   
   return true;
}

loadState()

bool ossimSrtmSupportData::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 381 of file ossimSrtmSupportData.cpp.

References ossimKeywordNames::FILENAME_KW, ossimKeywordlist::find(), ossimKeywordNames::IMAGE_FILE_KW, loadOmd(), and m_file.

{
   ossimString bandPrefix;
   if (prefix)
   {
      bandPrefix = prefix;
   }
   bandPrefix += "band1.";
   
   ossimString s; // For numeric conversions.
   
   const char* lookup;

   // Look for "filename" then look for deprecated "image_file" next.
   lookup = kwl.find(prefix, ossimKeywordNames::FILENAME_KW);
   if (lookup)
   {
      m_file = lookup;
   }
   else
   {
      // Deprecated...
      lookup = kwl.find(prefix, ossimKeywordNames::IMAGE_FILE_KW);
      if (lookup)
      {
         m_file = lookup;
      }
      else
      {
         return false;
      }
   }

   return loadOmd(kwl, prefix);
}

print()

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

virtual

Prints data members for debug.

Returns

std::ostream&

Reimplemented from ossimObject.

Definition at line 900 of file ossimSrtmSupportData.cpp.

References m_file, m_latSpacing, m_lonSpacing, m_maxPixelValue, m_minPixelValue, m_numberOfLines, m_numberOfSamples, m_southwestLatitude, and m_southwestLongitude.

{
   out << std::setprecision(15) << "ossimSrtmSupportData data members:"
       << "\nFile:                  " << m_file
       << "\nLines:                 " << m_numberOfLines
       << "\nSamples:               " << m_numberOfSamples
       << "\nSouth West Latitude:   " << m_southwestLatitude
       << "\nSouth West Longitude:  " << m_southwestLongitude
       << "\nLatitude spacing:      " << m_latSpacing
       << "\nLongitude spacing:     " << m_lonSpacing
       << "\nMin post value:        " << m_minPixelValue
       << "\nMax post value:        " << m_maxPixelValue
       << std::endl;
   return out;
}

saveState()

bool ossimSrtmSupportData::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 284 of file ossimSrtmSupportData.cpp.

References ossimKeywordlist::add(), ossimString::c_str(), ossimKeywordNames::DECIMAL_DEGREES_PER_PIXEL_LAT, ossimKeywordNames::DECIMAL_DEGREES_PER_PIXEL_LON, ossimKeywordNames::FILENAME_KW, m_file, m_latSpacing, m_lonSpacing, m_minPixelValue, m_numberOfLines, m_numberOfSamples, m_southwestLatitude, m_southwestLongitude, ossimFilename::NIL, ossimKeywordNames::NUMBER_BANDS_KW, ossimKeywordNames::NUMBER_LINES_KW, ossimKeywordNames::NUMBER_SAMPLES_KW, ossimKeywordNames::TIE_POINT_LAT_KW, and ossimKeywordNames::TIE_POINT_LON_KW.

{
   if (m_file == ossimFilename::NIL)
   {
      return false;
   }
   
   ossimString bandPrefix;
   if (prefix)
   {
      bandPrefix = prefix;
   }
   bandPrefix += "band1.";
   
   kwl.add(prefix,
           ossimKeywordNames::FILENAME_KW,
           m_file.c_str(),
           true);

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

   kwl.add(prefix,
           ossimKeywordNames::NUMBER_LINES_KW,
           m_numberOfLines,
           true);
   
   kwl.add(prefix,
           ossimKeywordNames::NUMBER_SAMPLES_KW,
           m_numberOfSamples,
           true);

   //---
   // Special case, store the tie point as the upper left lat so add one.
   //---
   kwl.add(prefix,
           ossimKeywordNames::TIE_POINT_LAT_KW,
           (m_southwestLatitude + 1.0),
           true);

   kwl.add(prefix,
           ossimKeywordNames::TIE_POINT_LON_KW,
           m_southwestLongitude,
           true);

   kwl.add(prefix,
           ossimKeywordNames::DECIMAL_DEGREES_PER_PIXEL_LAT,
           m_latSpacing,
           true);
   
   kwl.add(prefix,
           ossimKeywordNames::DECIMAL_DEGREES_PER_PIXEL_LON,
           m_lonSpacing,
           true);

   // User can opt out of scanning for this so don't save if it is still nan.
   if (m_minPixelValue != DEFAULT_MIN)
   {
      kwl.add(bandPrefix,
              ossimKeywordNames::MIN_VALUE_KW,
              m_minPixelValue,
              true);
   }

   // User can opt out of scanning for this so don't save if it is still nan.
   if (m_maxPixelValue != DEFAULT_MAX)
   {
      kwl.add(bandPrefix.c_str(),
              ossimKeywordNames::MAX_VALUE_KW,
              m_maxPixelValue,
              true);
   }

   // constant
   kwl.add(bandPrefix,
           ossimKeywordNames::NULL_VALUE_KW,
           "-32768",
           true);

   // constant
   kwl.add(prefix,
           ossimKeywordNames::BYTE_ORDER_KW,
           "big_endian",
           true);

   // constant
   kwl.add(prefix,
           ossimKeywordNames::SCALAR_TYPE_KW,
           ossimScalarTypeLut::instance()->getEntryString(m_scalarType),
           true);

   return true;
}

setCornerPoints()

bool ossimSrtmSupportData::setCornerPoints ( )

private

Sets corner points from "theFile".

Returns

true on success, false on error.

Definition at line 550 of file ossimSrtmSupportData.cpp.

{
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "ossimSrtmSupportData::setCornerPoints(): entered..." << std::endl;
   }
   
   ossimFilename f = m_file.fileNoExtension();
   ossimString regularExp1 = "[N|S][0-9][0-9][E|W][0-9][0-9][0-9]";
   ossimString regularExp2 = "[E|W][0-9][0-9][0-9][N|S][0-9][0-9]";
   ossimRegExp regEx;
   bool latLonOrderFlag = true;
   bool foundFlag = false;
   f = f.upcase();

   regEx.compile(regularExp1.c_str());
   foundFlag = regEx.find(f.c_str());
   if(!foundFlag)
   {
      regEx.compile(regularExp2.c_str());
      foundFlag = regEx.find(f.c_str());
      if(foundFlag)
      {
         latLonOrderFlag = false;
         f = ossimFilename(ossimString(f.begin()+regEx.start(),
                                       f.begin()+regEx.end()));
      }
   }
   if(foundFlag)
   {
      f = ossimFilename(ossimString(f.begin()+regEx.start(),
                                    f.begin()+regEx.end()));
   }
   if (f.size() != 7)
   {
      return false;
   }
//    ossimString s;

   if(latLonOrderFlag)
   {
      
//       s.push_back(f[1]);
//       s.push_back(f[2]);
      m_southwestLatitude = ossimString(f.begin()+1,
                                         f.begin()+3).toDouble();//s.toDouble();
      // Get the latitude.
      if (f[static_cast<std::string::size_type>(0)] == 'S')
      {
         m_southwestLatitude *= -1;
      }
      else if (f[static_cast<std::string::size_type>(0)] != 'N')
      {
         return false; // Must be either 's' or 'n'.
      }
      // Get the longitude.
//       s.clear();
//       s.push_back(f[4]);
//       s.push_back(f[5]);
//       s.push_back(f[6]);
      m_southwestLongitude = ossimString(f.begin()+4,
                                          f.begin()+7).toDouble();//s.toDouble();
      if (f[static_cast<std::string::size_type>(3)] == 'W')
      {
      m_southwestLongitude *= -1;
      }
      else if (f[static_cast<std::string::size_type>(3)] != 'E')
      {
         return false; // Must be either 'e' or 'w'.
      }
   }
   else
   {
      // Get the longitude.
//       s.clear();
//       s.push_back(f[1]);
//       s.push_back(f[2]);
//       s.push_back(f[3]);
      m_southwestLongitude =  ossimString(f.begin()+1,
                                           f.begin()+4).toDouble();//s.toDouble();
      if (f[static_cast<std::string::size_type>(0)] == 'W')
      {
      m_southwestLongitude *= -1;
      }
      else if (f[static_cast<std::string::size_type>(0)] != 'E')
      {
         return false; // Must be either 'e' or 'w'.
      }
//       s.clear();
      
//       s.push_back(f[5]);
//       s.push_back(f[6]);
      m_southwestLatitude = ossimString(f.begin()+5,
                                         f.begin()+7).toDouble();//s.toDouble();
      // Get the latitude.
      if (f[static_cast<std::string::size_type>(4)] == 'S')
      {
         m_southwestLatitude *= -1;
      }
      else if (f[static_cast<std::string::size_type>(4)] != 'N')
      {
         return false; // Must be either 's' or 'n'.
      }
   }
   

   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "ossimSrtmSupportData::setCornerPoints(): leaving with true..."
         << std::endl;
   }
   return true;
}

setFilename()

bool ossimSrtmSupportData::setFilename	(	const ossimFilename &	srtmFile,
		bool	scanForMinMax = false
	)

Initializes object from file.

File is expected to be in a format like N27W081.hgt or n27w081.hgt where "N27" is the South West latitude of the cell and "W081" is the South West longitude of the cell.

Parameters

srtmFile	File to set.
scanForMinMax	If true and there is no ossim meta data file with the min and max keywords in it, this will call computeMinMax which will scan the file for min and max.

Returns

Returns true if file is deemed to be an srtm, false if not.

Note

This will write an ossim meta data (.omd) if one does not exists.

Definition at line 65 of file ossimSrtmSupportData.cpp.

References m_file.

Referenced by ossimSrtmHandler::open().

{
   m_file = srtmFile;

   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "ossimSrtmSupportData::setFilename: entered:"
         << "\nsrtmFile:  " << srtmFile
         << "\nscanForMinMax flag:  " << scanForMinMax
         << std::endl;
   }
   
   m_str =  ossim::StreamFactoryRegistry::instance()->
      createIstream(m_file);
   if (m_str)
   {
      if(m_str->fail())
      {
         if(traceDebug())
         {
            ossimNotify(ossimNotifyLevel_DEBUG)
               << m_file << " does not exist: leaving ..." << std::endl;
         }
         clear();
         return false;
      }
   }
   else
   {
      return false;
   }

   // Start with default.
   m_minPixelValue = DEFAULT_MIN;
   m_maxPixelValue = DEFAULT_MAX;
   
   // See if we have an ossim metadata file to initialize from.
   bool outputOmd     = false;
   bool loadedFromOmd = false;
   
   ossimFilename omdFile = m_file;
   omdFile.setExtension(ossimString("omd"));
   if (omdFile.exists())
   {
      //---
      // The loadOmd is called instead of loadState so m_file is not
      // overwrote.
      //---
      ossimKeywordlist kwl(omdFile);
      loadedFromOmd = loadOmd(kwl);
   }

   if (!loadedFromOmd)
   {
      if (!setCornerPoints())
      {
         clear();
         return false;
      }
      if (!setSize())
      {
         clear();
         return false;
      }
      outputOmd = true;
   }

   if (scanForMinMax)
   {
      // These could have been picked up in the loadOmd.
      if ( (m_minPixelValue == DEFAULT_MIN) ||
           (m_maxPixelValue == DEFAULT_MAX) )
      {
         if ( computeMinMax() )
         {
            outputOmd = true;
         }
         else
         {
            if(traceDebug())
            {
               ossimNotify(ossimNotifyLevel_DEBUG)
                  << "Unable to compute min max: leaving ..." << std::endl;
            }
            clear();
            return false;
         }
      }
   }

   //---
   // NOTE:  The outputOmd flag should probably be set if !loadedFromOmd.
   // Leaving as is for now (only set if scanForMinMax).
   //---
   if (outputOmd)
   {
      ossimKeywordlist kwl;
      saveState(kwl);
      kwl.write(omdFile);
   }

   m_str = 0;
   // if(m_str->is_open())
   // {
   //    m_str->close();
   // }
   
   if (traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG) << *this << std::endl;
   }
   
   return true;
}

setSize()

bool ossimSrtmSupportData::setSize ( )

private

Sets lines and samples from "theFile" size.

Returns

true on success, false on error.

Definition at line 666 of file ossimSrtmSupportData.cpp.

{
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "ossimSrtmSupportData::setSize(): entered..." << std::endl;
   }
   if(!m_str)
   {
      m_str = ossim::StreamFactoryRegistry::instance()->createIstream(
                                                              m_file);
   }
   
   if (!m_str)
   {
      return false;
   }

   if(m_str->fail())
   {
      return false;
   }
   
   ossim_float64 size = 0.0;
   m_str->seekg(0, std::ios::beg);

#if 0 /* tmp drb */
   if(m_str->isCompressed())
   {
      ossimFilename tmp = m_file;
      tmp.setExtension("hgt");
      if(!tmp.exists())
      {
         ossimOFStream out(tmp.c_str(),
                           std::ios::out|std::ios::binary);

         if(!out.fail())
         {
            bool done = false;
            char buf[1024];
            while(!done&&!m_str->fail())
            {
               m_str->read(buf, 1024);
               if(m_str->gcount() < 1024)
               {
                  done = true;
               }
               if(m_str->gcount() > 0)
               {
                  out.write(buf, m_str->gcount());
               }
            }
            out.close();
            size = tmp.fileSize();
            tmp.remove();
         }
      }
   }
   else
   {
      size = m_file.fileSize();
   }
#endif /* tmp drb */
   
   size = m_file.fileSize();
   if (!size)
   {
      if(traceDebug())
      {
         ossimNotify(ossimNotifyLevel_DEBUG)
            << "ossimSrtmSupportData::setSize(): leaving with false at line "
            << __LINE__ << std::endl;
      }
      return false;
   }

   m_scalarType = OSSIM_SCALAR_UNKNOWN;
   
   //---
   // Assuming square for now.  Have to check the spec for this.
   //---
   if (size == 25934402) // 2 * 3601 * 3601 three arc second
   {
      m_numberOfLines     = 3601;
      m_numberOfSamples   = 3601;
      m_scalarType = OSSIM_SINT16;
   }
   else if(size == 51868804) // 4*3601*3601
   {
      m_numberOfLines   = 3601;
      m_numberOfSamples = 3601;
      m_scalarType = OSSIM_FLOAT32;
   }
   else if (size == 2884802) // 2 * 1201 * 1201 one arc second
   {
      m_numberOfLines   = 1201;
      m_numberOfSamples = 1201;
      m_scalarType = OSSIM_SINT16;
   }
   else if (size == 5769604)
   {
      m_numberOfLines   = 1201;
      m_numberOfSamples = 1201;
      m_scalarType = OSSIM_FLOAT32;
   }
   else // try to get a square width and height
   {
      ossim_uint64 lines   = (ossim_uint64)sqrt((ossim_float64)(size / 2));
      ossim_uint64 samples = (ossim_uint64)sqrt((ossim_float64)(size / 2));
      // check square
      if(lines*samples*2 == size)
      {
         m_numberOfLines   = lines;
         m_numberOfSamples = samples;
         m_scalarType = OSSIM_SINT16;
         
      }
      else
      {
         ossim_uint64 lines   = (ossim_uint64)sqrt((ossim_float64)(size / 4));
         ossim_uint64 samples = (ossim_uint64)sqrt((ossim_float64)(size / 4));
         // check square
         if(lines*samples*4 == size)
         {
            m_numberOfLines   = lines;
            m_numberOfSamples = samples;
            m_scalarType = OSSIM_FLOAT32;
         }
         else
         {
            if(traceDebug())
            {
               ossimNotify(ossimNotifyLevel_DEBUG)
                  << "ossimSrtmSupportData::setSize(): leaving with false at line " << __LINE__ << std::endl;
            }
            return false;
         }
      }
   }
      
   m_latSpacing      = 1.0 / (m_numberOfLines   - 1);
   m_lonSpacing      = 1.0 / (m_numberOfSamples - 1);
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "ossimSrtmSupportData::setSize(): leaving with true..."
         << std::endl;
   }

   m_str=0;
   
   return true;
}

Member Data Documentation

m_file

ossimFilename ossimSrtmSupportData::m_file

private

Definition at line 187 of file ossimSrtmSupportData.h.

Referenced by clear(), computeMinMaxTemplate(), getFilename(), getImageGeometry(), loadState(), print(), saveState(), and setFilename().

m_latSpacing

ossim_float64 ossimSrtmSupportData::m_latSpacing

private

Definition at line 192 of file ossimSrtmSupportData.h.

Referenced by clear(), getImageGeometry(), getLatitudeSpacing(), getProjection(), loadOmd(), print(), and saveState().

m_lonSpacing

ossim_float64 ossimSrtmSupportData::m_lonSpacing

private

Definition at line 193 of file ossimSrtmSupportData.h.

Referenced by clear(), getImageGeometry(), getLongitudeSpacing(), getProjection(), loadOmd(), print(), and saveState().

m_maxPixelValue

ossim_float64 ossimSrtmSupportData::m_maxPixelValue

private

Definition at line 195 of file ossimSrtmSupportData.h.

Referenced by computeMinMaxTemplate(), getMaxPixelValue(), loadOmd(), and print().

m_minPixelValue

ossim_float64 ossimSrtmSupportData::m_minPixelValue

private

Definition at line 194 of file ossimSrtmSupportData.h.

Referenced by clear(), computeMinMaxTemplate(), getMinPixelValue(), loadOmd(), print(), and saveState().

m_numberOfLines

ossim_uint32 ossimSrtmSupportData::m_numberOfLines

private

Definition at line 188 of file ossimSrtmSupportData.h.

Referenced by clear(), computeMinMaxTemplate(), getImageGeometry(), getNumberOfLines(), loadOmd(), print(), and saveState().

m_numberOfSamples

ossim_uint32 ossimSrtmSupportData::m_numberOfSamples

private

Definition at line 189 of file ossimSrtmSupportData.h.

Referenced by clear(), computeMinMaxTemplate(), getImageGeometry(), getNumberOfSamples(), loadOmd(), print(), and saveState().

m_scalarType

ossimScalarType ossimSrtmSupportData::m_scalarType

private

Definition at line 197 of file ossimSrtmSupportData.h.

Referenced by computeMinMax(), getScalarType(), and loadOmd().

m_southwestLatitude

ossim_float64 ossimSrtmSupportData::m_southwestLatitude

private

Definition at line 190 of file ossimSrtmSupportData.h.

Referenced by clear(), getImageGeometry(), getProjection(), getSouthwestLatitude(), loadOmd(), print(), and saveState().

m_southwestLongitude

ossim_float64 ossimSrtmSupportData::m_southwestLongitude

private

Definition at line 191 of file ossimSrtmSupportData.h.

Referenced by clear(), getImageGeometry(), getProjection(), getSouthwestLongitude(), loadOmd(), print(), and saveState().

m_str

std::shared_ptr<ossim::istream> ossimSrtmSupportData::m_str

mutableprivate

Definition at line 200 of file ossimSrtmSupportData.h.

Referenced by computeMinMaxTemplate().

---

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

• ossimSrtmSupportData.h
• ossimSrtmSupportData.cpp