ossimGeoidImage Class Reference

Generic geoid source which uses a image handler for reading the grid. More...

#include <ossimGeoidImage.h>

Inheritance diagram for ossimGeoidImage:

Public Member Functions
	ossimGeoidImage ()
	default constructor More...
virtual	~ossimGeoidImage ()
	destructor More...
virtual bool	open (const ossimFilename &file, ossimByteOrder byteOrder=OSSIM_BIG_ENDIAN)
	open method More...
virtual ossimString	getShortName () const
void	setShortName (const std::string &geoidTypeName)
	Sets the geoid type name string. More...
bool	getMemoryMapFlag () const
	Gets the memory map flag. More...
void	setMemoryMapFlag (bool flag)
	Set the memory map flag. 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...
virtual double	offsetFromEllipsoid (const ossimGpt &gpt)
bool	getEnableFlag () const
void	setEnableFlag (bool flag)
Public Member Functions inherited from ossimGeoid
	ossimGeoid ()
Public Member Functions inherited from ossimObject
	ossimObject ()
virtual	~ossimObject ()
virtual ossimObject *	dup () 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 std::ostream &	print (std::ostream &out) const
	Generic print method. More...
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
Public Member Functions inherited from ossimErrorStatusInterface
	ossimErrorStatusInterface ()
virtual	~ossimErrorStatusInterface ()
virtual ossimErrorCode	getErrorStatus () const
virtual ossimString	getErrorStatusString () const
virtual void	setErrorStatus (ossimErrorCode error_status) const
virtual void	setErrorStatus () const
virtual void	clearErrorStatus () const
bool	hasError () const
virtual std::ostream &	print (std::ostream &out) const
	Outputs theErrorStatus as an ossimErrorCode and an ossimString. More...

Protected Member Functions
template<class T >
double	offsetFromEllipsoidTemplate (T dummy, const ossimGpt &gpt)
Protected Member Functions inherited from ossimGeoid
virtual	~ossimGeoid ()
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Protected Attributes
ossimRefPtr< ossimImageGeometry >	m_geom
ossimRefPtr< ossimImageHandler >	m_handler
ossimRefPtr< ossimImageData >	m_cacheTile
std::string	m_connectionString
ossimString	m_geoidTypeName
bool	m_memoryMapFlag
bool	m_enabledFlag
ossimIrect	m_imageRect
ossimScalarType	m_scalarType
Protected Attributes inherited from ossimErrorStatusInterface
ossimErrorCode	theErrorStatus

Detailed Description

Generic geoid source which uses a image handler for reading the grid.

The settable keyword "geoid.type", e.g. "egm2008" is used to attach a given geoid to an elevation source.

The keyword "type" is fixed for this object as "geoid_image".

Definition at line 35 of file ossimGeoidImage.h.

Constructor & Destructor Documentation

ossimGeoidImage()

ossimGeoidImage::ossimGeoidImage

(

)

default constructor

Definition at line 28 of file ossimGeoidImage.cpp.

   : m_geom(0),
     m_handler(0),
     m_cacheTile(0),
     m_geoidTypeName(),
     m_memoryMapFlag(false),
     m_enabledFlag(true),
     m_imageRect()
{
}

~ossimGeoidImage()

ossimGeoidImage::~ossimGeoidImage ( )

virtual

destructor

Definition at line 39 of file ossimGeoidImage.cpp.

References m_cacheTile, m_geom, and m_handler.

{
   m_geom = 0;
   m_handler = 0;
   m_cacheTile = 0;
}

Member Function Documentation

getEnableFlag()

bool ossimGeoidImage::getEnableFlag

(

)

const

getMemoryMapFlag()

bool ossimGeoidImage::getMemoryMapFlag

(

)

const

Gets the memory map flag.

Returns

true if geoid image is memory mapped; else, false.

Definition at line 137 of file ossimGeoidImage.cpp.

References m_memoryMapFlag.

{
   return m_memoryMapFlag;
}

getShortName()

ossimString ossimGeoidImage::getShortName ( ) const

virtual

Returns

The short name which represents the "geoid.type" keyword which is used by ossimGeoidFactory.

Reimplemented from ossimObject.

Definition at line 127 of file ossimGeoidImage.cpp.

References m_geoidTypeName.

{
   return m_geoidTypeName;
}

loadState()

bool ossimGeoidImage::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 178 of file ossimGeoidImage.cpp.

References ossimKeywordNames::ENABLED_KW, ossimKeywordlist::findKey(), m_connectionString, m_enabledFlag, m_geoidTypeName, m_memoryMapFlag, open(), ossimString::toBool(), and ossimKeywordNames::TYPE_KW.

{
   bool result = false;
   
   std::string myPrefix = prefix ? prefix : "";
   
   // Check the type name:
   std::string key = ossimKeywordNames::TYPE_KW;
   std::string value = kwl.findKey( myPrefix, key );

   if ( (value == "geoid_image" ) || ( value == "ossimGeoidImage" ) )
   {
      // Get the geoid type name:
      key = "geoid.type";
      m_geoidTypeName = kwl.findKey( myPrefix, key );

      // Get the memory map flag:
      key = "memory_map";
      value = kwl.findKey( myPrefix, key );
      m_memoryMapFlag = ossimString( value ).toBool();

      // Get the enabled flag:
      key = ossimKeywordNames::ENABLED_KW;
      value = kwl.findKey( myPrefix, key );
      m_enabledFlag = ossimString( value ).toBool();
      
      // Get the connection string:
      std::string key = "connection_string";
      m_connectionString = kwl.findKey( myPrefix, key );
      if ( m_connectionString.size() )
      {
         result = open( ossimFilename( m_connectionString ) );
      }
   }
   
   return result;
}

offsetFromEllipsoid()

double ossimGeoidImage::offsetFromEllipsoid ( const ossimGpt &  gpt )

virtual

Returns

The offset from the ellipsoid to the geoid or ossim::nan() (IEEE NAN) if grid does not contain the point.

Implements ossimGeoid.

Definition at line 218 of file ossimGeoidImage.cpp.

References ossimLookUpTable::getEntryString(), ossimScalarTypeLut::instance(), m_cacheTile, m_enabledFlag, m_geom, m_handler, m_memoryMapFlag, m_scalarType, ossim::nan(), offsetFromEllipsoidTemplate(), OSSIM_FLOAT32, OSSIM_FLOAT64, OSSIM_SINT16, ossimNotify(), ossimNotifyLevel_WARN, and ossimRefPtr< T >::valid().

{
   double offset = ossim::nan();

   if ( m_enabledFlag )
   {
      if ( m_geom.valid() &&
           ( m_handler.valid() ||
             ( m_memoryMapFlag && m_cacheTile.valid() )
             )
           )
      {
         switch(m_scalarType)
         {
            case OSSIM_SINT16:
            {
               offset = offsetFromEllipsoidTemplate((ossim_sint16)0, gpt);
               break;
            }
            case OSSIM_FLOAT32:
            {
               offset = offsetFromEllipsoidTemplate((ossim_float32)0, gpt);
               break;
            }
            case OSSIM_FLOAT64:
            {
               offset = offsetFromEllipsoidTemplate((ossim_float64)0, gpt);
               break;
            }
            default:
            {
               ossimNotify(ossimNotifyLevel_WARN)
                  << "ossimGeoidImage::offsetFromEllipsoid ERROR:\n"
                  << "Unhandled scalar type: "
                  << ossimScalarTypeLut::instance()->getEntryString( m_scalarType )
                  << std::endl;
               break;
            }
         }
      }
      else
      {
         ossimNotify(ossimNotifyLevel_WARN)
            << "ossimGeoidImage::offsetFromEllipsoid ERROR: Object not initialized!\n"
            << std::endl;
      }
      
   } // Matches: if ( m_enabledFlag )
   
   return offset;
}

offsetFromEllipsoidTemplate()

template<class T >

double ossimGeoidImage::offsetFromEllipsoidTemplate ( T  dummy, const ossimGpt &  gpt  )

protected

Definition at line 271 of file ossimGeoidImage.cpp.

References ossimGpt::changeDatum(), ossimImageData::getBuf(), ossimImageData::getNullPix(), ossimImageData::getOrigin(), ossimImageSource::getTile(), ossimImageData::getWidth(), ossimIrect::height(), ossimDatumFactory::instance(), m_cacheTile, m_geom, m_handler, m_imageRect, m_memoryMapFlag, ossim::nan(), ossimIrect::pointWithin(), ossimRefPtr< T >::valid(), ossimIrect::width(), ossimImageGeometry::worldToLocal(), ossimGpt::wrap(), ossimIpt::x, ossimDpt::x, ossimIpt::y, and ossimDpt::y.

Referenced by offsetFromEllipsoid().

{
   double geoidOffset = ossim::nan();

   // Change the datum if needed:
   ossimGpt copyGpt = gpt;
   if(ossimDatumFactory::instance()->wgs84())
   {
      copyGpt.changeDatum(ossimDatumFactory::instance()->wgs84());
   }
   
   // Fix wrap conditions:
   copyGpt.wrap();
   
   // Get the local image point for the input ground point.
   ossimDpt imgDpt;
   m_geom->worldToLocal( copyGpt, imgDpt );

   if ( m_imageRect.pointWithin( ossimIpt( imgDpt ) ) )
   {
      ossim_int32 x0 = static_cast<ossim_int32>( imgDpt.x );
      ossim_int32 y0 = static_cast<ossim_int32>( imgDpt.y );
      
      ossim_int32 IW = static_cast<ossim_int32>(m_imageRect.width());
      ossim_int32 IH = static_cast<ossim_int32>(m_imageRect.height());
      
      if ( x0 == (IW-1) )
      {
         --x0;  // Move over one point.
      }
      if ( y0 == (IH-1) )
      {
         --y0; // Move over one point.
      }

      if ( !m_memoryMapFlag )
      {
         // Get the four points from the image handler.
         ossimIrect tileRect(ossimIpt(x0, y0), ossimIpt(x0+1, y0+1));
         m_cacheTile = m_handler->getTile( tileRect, 0 );
      }
      
      if ( m_cacheTile.valid() )
      {
         // Get a pointer to the buffer.
         const T* buf = static_cast<const T*>(m_cacheTile->getBuf());
         
         if ( buf )
         {
            const ossim_float64 NP = m_cacheTile->getNullPix(0);
            const ossim_int64 TW = static_cast<ossim_int64>(m_cacheTile->getWidth());
            ossim_int64 offset = (y0 - m_cacheTile->getOrigin().y) * TW +
               (x0 - m_cacheTile->getOrigin().x);
            ossim_int64 offset2 = offset + TW;
            
            double p00 = buf[offset];
            double p01 = buf[offset+1];
            double p10 = buf[offset2];
            double p11 = buf[offset2+1];
            
            double xt0 = imgDpt.x - x0;
            double yt0 = imgDpt.y - y0;
            double xt1 = 1-xt0;
            double yt1 = 1-yt0;
            
            double w00 = xt1*yt1;
            double w01 = xt0*yt1;
            double w10 = xt1*yt0;
            double w11 = xt0*yt0;
            
            //---
            // Test for null posts and set the corresponding weights to 0:
            //---
            if (p00 == NP) w00 = 0.0;
            if (p01 == NP) w01 = 0.0;
            if (p10 == NP) w10 = 0.0;
            if (p11 == NP) w11 = 0.0;                  
            
            double sum_weights = w00 + w01 + w10 + w11;
            if (sum_weights)
            {
               geoidOffset = (p00*w00 + p01*w01 + p10*w10 + p11*w11) / sum_weights;
            }
         }
         
      } // Matches: if ( m_cacheTile.valid() )
      
   } // Matches: if ( m_imageRect.pointWithin( imgPt ) )

   return geoidOffset;
}

open()

bool ossimGeoidImage::open ( const ossimFilename &  file, ossimByteOrder  byteOrder = OSSIM_BIG_ENDIAN  )

virtual

open method

Parameters

file	This can be any image that ossim can open and get geometry info for.
byteOrder	Not used by this object.

Returns

true on success, false on erro.

Implements ossimGeoid.

Definition at line 46 of file ossimGeoidImage.cpp.

References ossimImageHandler::close(), ossimImageHandler::getImageGeometry(), ossimImageHandler::getImageRectangle(), ossimImageSource::getOutputScalarType(), ossimImageGeometry::getProjection(), ossimImageSource::getTile(), ossimImageHandlerRegistry::instance(), m_cacheTile, m_geom, m_handler, m_imageRect, m_memoryMapFlag, m_scalarType, ossimImageHandlerRegistry::open(), ossimNotify(), ossimNotifyLevel_WARN, ossimRefPtr< T >::valid(), and ossimException::what().

Referenced by loadState().

{
   static const char MODULE[] = "ossimGeoidImage::open";
   
   m_geom = 0;
   m_cacheTile = 0;
   if ( m_handler.valid() )
   {
      m_handler->close();
   }

   m_handler =
      ossimImageHandlerRegistry::instance()->open(file,
                                                  true, // try suffix 1st
                                                  false); // open overview
   if ( m_handler.valid() )
   {
      // Store the bounding rectangle:
      m_imageRect = m_handler->getImageRectangle( 0 );

      // Scalar type:
      m_scalarType = m_handler->getOutputScalarType();
      
      // Get the geometry info.  Need this to compute grid indexes.
      m_geom = m_handler->getImageGeometry();

      if ( m_geom.valid() )
      {
         // Verify the geometry object has a good projection.
         if ( m_geom->getProjection() )
         {
            if ( m_memoryMapFlag )
            {
               try
               {
                  m_cacheTile = m_handler->getTile( m_imageRect, 0 );
                  
                  if ( m_cacheTile.valid() )
                  {
                     // Close the image handler:
                     m_handler->close();
                     m_handler = 0;
                  }
               }
               catch ( const ossimException& e )
               {
                  m_memoryMapFlag = false;
                  m_cacheTile = 0;
                  
                  ossimNotify(ossimNotifyLevel_WARN)
                     << MODULE << " ERROR: Caught Exception!"
                     << "\n" << e.what()
                     << "\nMemory mapping entire grid into memory has been disabled..."
                     << std::endl;
               }
            }
         }
         else
         {
            m_handler = 0;
            m_geom    = 0;
            ossimNotify(ossimNotifyLevel_WARN)
               << MODULE << " ERROR:"
               << "\nGeometry object has null projection!"
               << std::endl;
         }
      }
         
      else
      {
         m_handler = 0;
         ossimNotify(ossimNotifyLevel_WARN)
            << MODULE << " ERROR:"
            << "\nCould not get geometry info!"
            << std::endl;
      }
   }
   
   return ( m_geom.valid() && (m_handler.valid() || (m_memoryMapFlag && m_cacheTile.valid()) ));
}

saveState()

bool ossimGeoidImage::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 147 of file ossimGeoidImage.cpp.

References ossimKeywordlist::addPair(), ossimKeywordNames::ENABLED_KW, m_connectionString, m_enabledFlag, m_geoidTypeName, m_memoryMapFlag, ossimString::string(), true, and ossimKeywordNames::TYPE_KW.

{
   std::string myPrefix = ( prefix ? prefix : "" );

   // Save the connection string:
   std::string key = "connection_string";
   kwl.addPair( myPrefix, key, m_connectionString, true );

   // Save the geoid type name:
   key = "geoid.type";
   kwl.addPair( myPrefix, key, m_geoidTypeName.string(), true );

   // Save the memory map flag:
   key = "memory_map";
   std::string value = (m_memoryMapFlag ? "true" : "false");
   kwl.addPair( myPrefix, key, value, true );

   // Save the enabledFlag:
   key = ossimKeywordNames::ENABLED_KW;
   value = m_enabledFlag ? "true" : "false";
   kwl.addPair( myPrefix, key, value, true );

   // Save the type:
   key = ossimKeywordNames::TYPE_KW;
   value = "geoid_image";
   kwl.addPair( myPrefix, key, value, true );
   
   return true;
}

setEnableFlag()

void ossimGeoidImage::setEnableFlag

(

bool

flag

)

setMemoryMapFlag()

void ossimGeoidImage::setMemoryMapFlag

(

bool

flag

)

Set the memory map flag.

Definition at line 142 of file ossimGeoidImage.cpp.

References m_memoryMapFlag.

{
   m_memoryMapFlag = flag; 
}

setShortName()

void ossimGeoidImage::setShortName

(

const std::string &

geoidTypeName

)

Sets the geoid type name string.

Definition at line 132 of file ossimGeoidImage.cpp.

References m_geoidTypeName.

{
   m_geoidTypeName = geoidTypeName;
}

Member Data Documentation

m_cacheTile

ossimRefPtr<ossimImageData> ossimGeoidImage::m_cacheTile

protected

Definition at line 107 of file ossimGeoidImage.h.

Referenced by offsetFromEllipsoid(), offsetFromEllipsoidTemplate(), open(), and ~ossimGeoidImage().

m_connectionString

std::string ossimGeoidImage::m_connectionString

protected

Definition at line 108 of file ossimGeoidImage.h.

Referenced by loadState(), and saveState().

m_enabledFlag

bool ossimGeoidImage::m_enabledFlag

protected

Definition at line 111 of file ossimGeoidImage.h.

Referenced by loadState(), offsetFromEllipsoid(), and saveState().

m_geoidTypeName

ossimString ossimGeoidImage::m_geoidTypeName

protected

Definition at line 109 of file ossimGeoidImage.h.

Referenced by getShortName(), loadState(), saveState(), and setShortName().

m_geom

ossimRefPtr<ossimImageGeometry> ossimGeoidImage::m_geom

protected

Definition at line 105 of file ossimGeoidImage.h.

Referenced by offsetFromEllipsoid(), offsetFromEllipsoidTemplate(), open(), and ~ossimGeoidImage().

m_handler

ossimRefPtr<ossimImageHandler> ossimGeoidImage::m_handler

protected

Definition at line 106 of file ossimGeoidImage.h.

Referenced by offsetFromEllipsoid(), offsetFromEllipsoidTemplate(), open(), and ~ossimGeoidImage().

m_imageRect

ossimIrect ossimGeoidImage::m_imageRect

protected

Definition at line 112 of file ossimGeoidImage.h.

Referenced by offsetFromEllipsoidTemplate(), and open().

m_memoryMapFlag

bool ossimGeoidImage::m_memoryMapFlag

protected

Definition at line 110 of file ossimGeoidImage.h.

Referenced by getMemoryMapFlag(), loadState(), offsetFromEllipsoid(), offsetFromEllipsoidTemplate(), open(), saveState(), and setMemoryMapFlag().

m_scalarType

ossimScalarType ossimGeoidImage::m_scalarType

protected

Definition at line 113 of file ossimGeoidImage.h.

Referenced by offsetFromEllipsoid(), and open().

---

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

• ossimGeoidImage.h
• ossimGeoidImage.cpp