ossimTiffWorld Class Reference

#include <ossimTiffWorld.h>

Public Member Functions
	ossimTiffWorld ()
	ossimTiffWorld (const char *source, ossimPixelType ptype=OSSIM_PIXEL_IS_POINT, ossimUnitType unit=OSSIM_METERS)
	~ossimTiffWorld ()
bool	open (const ossimFilename &file, ossimPixelType ptype, ossimUnitType unit)
bool	saveToOssimGeom (ossimKeywordlist &kwl, const char *prefix=NULL) const
bool	loadFromOssimGeom (const ossimKeywordlist &kwl, const char *prefix=NULL)
std::ostream &	print (std::ostream &out) const
void	forward (const ossimDpt &imagePoint, ossimDpt &transformedPoint)
const ossimDpt &	getScale () const
	Converts world file parameters into x, y scale (for use in affine transform) More...
double	getRotation () const
	Converts world file parameters into RH rotation in radians (for use in affine transform) More...
const ossimDpt &	getTranslation () const
	Provides access to the translation (for use in affine transform) More...

Protected Attributes
double	theXform1
double	theXform2
double	theXform3
double	theXform4
ossimDpt	theTranslation
ossimPixelType	thePixelType
ossimUnitType	theUnit
ossimDpt	theComputedScale
double	theComputedRotation
	Radians. More...

Friends
OSSIMDLLEXPORT std::ostream &	operator<< (std::ostream &out, const ossimTiffWorld &obj)

Detailed Description

Definition at line 26 of file ossimTiffWorld.h.

Constructor & Destructor Documentation

ossimTiffWorld() [1/2]

ossimTiffWorld::ossimTiffWorld

(

)

Definition at line 30 of file ossimTiffWorld.cpp.

   :
      theXform1(1.0),
      theXform2(0.0),
      theXform3(0.0),
      theXform4(-1.0),
      theTranslation(0.0,0.0),
      thePixelType(OSSIM_PIXEL_IS_AREA),
      theUnit(OSSIM_METERS),
      theComputedScale(0.0, 0.0),
      theComputedRotation(0.0)
{}

ossimTiffWorld() [2/2]

ossimTiffWorld::ossimTiffWorld	(	const char *	source,
		ossimPixelType	ptype = OSSIM_PIXEL_IS_POINT,
		ossimUnitType	unit = OSSIM_METERS
	)

Definition at line 46 of file ossimTiffWorld.cpp.

References open().

   :
      theXform1(1.0),
      theXform2(0.0),
      theXform3(0.0),
      theXform4(-1.0),
      theTranslation(0.0,0.0),
      thePixelType(ptype),
      theUnit(scaleUnits),
      theComputedScale(0.0, 0.0),
      theComputedRotation(0.0)
{
   open(ossimFilename(file), ptype, scaleUnits);
}

~ossimTiffWorld()

ossimTiffWorld::~ossimTiffWorld

(

)

Definition at line 138 of file ossimTiffWorld.cpp.

{
}

Member Function Documentation

forward()

void ossimTiffWorld::forward	(	const ossimDpt &	imagePoint,
		ossimDpt &	transformedPoint
	)

transformed.x = imagePoint.x*theX_scale + imagePoint.y*the3rdValue + theTranslateX

transformed.y = imagePoint.x*the2ndValue + imagePoint.y*theY_scale + theTranslateY

Definition at line 142 of file ossimTiffWorld.cpp.

References theTranslation, theXform1, theXform2, theXform3, theXform4, ossimDpt::x, and ossimDpt::y.

{
   transformedPoint.x = ip.x*theXform1 + ip.y*theXform2 + theTranslation.x;
   transformedPoint.y = ip.x*theXform3 + ip.y*theXform4 + theTranslation.y;
}

getRotation()

double ossimTiffWorld::getRotation ( ) const

inline

Converts world file parameters into RH rotation in radians (for use in affine transform)

Definition at line 62 of file ossimTiffWorld.h.

{ return theComputedRotation; }

getScale()

const ossimDpt& ossimTiffWorld::getScale ( ) const

inline

Converts world file parameters into x, y scale (for use in affine transform)

Definition at line 59 of file ossimTiffWorld.h.

{ return theComputedScale; }

getTranslation()

const ossimDpt& ossimTiffWorld::getTranslation ( ) const

inline

Provides access to the translation (for use in affine transform)

Definition at line 65 of file ossimTiffWorld.h.

{ return theTranslation; }

loadFromOssimGeom()

bool ossimTiffWorld::loadFromOssimGeom	(	const ossimKeywordlist &	kwl,
		const char *	prefix = NULL
	)

Definition at line 206 of file ossimTiffWorld.cpp.

References ossimKeywordlist::find(), ossimKeywordNames::METERS_PER_PIXEL_X_KW, ossimKeywordNames::METERS_PER_PIXEL_Y_KW, ossimKeywordNames::PIXEL_SCALE_XY_KW, theTranslation, theXform1, theXform2, theXform3, theXform4, ossimKeywordNames::TIE_POINT_EASTING_KW, ossimKeywordNames::TIE_POINT_NORTHING_KW, ossimKeywordNames::TIE_POINT_XY_KW, ossimString::toDouble(), ossimDpt::toPoint(), ossimDpt::x, and ossimDpt::y.

{
   theXform2 = 0.0;
   theXform3 = 0.0;

   const char* lookup;

   // Get the scale...
   lookup = kwl.find(prefix, ossimKeywordNames::PIXEL_SCALE_XY_KW);
   if (lookup)
   {
      ossimDpt scale;
      scale.toPoint(std::string(lookup));
      theXform1      = scale.x;
      theXform4      = -(scale.y);
   }
   else // BACKWARDS COMPATIBILITY LOOKUPS...
   {
      ossimString xscale = kwl.find(prefix, ossimKeywordNames::METERS_PER_PIXEL_X_KW);
      ossimString yscale = kwl.find(prefix, ossimKeywordNames::METERS_PER_PIXEL_Y_KW);
      theXform1 = xscale.toDouble();
      theXform4 = -(yscale.toDouble());
   }

   // Get the tie...
   lookup = kwl.find(prefix, ossimKeywordNames::TIE_POINT_XY_KW);
   if (lookup)
   {
      ossimDpt tie;
      tie.toPoint(std::string(lookup));
      theTranslation.x  = tie.x;
      theTranslation.y  = tie.y;
   }
   else // BACKWARDS COMPATIBILITY LOOKUPS...
   {
      ossimString easting  =
         kwl.find(prefix, ossimKeywordNames::TIE_POINT_EASTING_KW);
      ossimString northing =
         kwl.find(prefix, ossimKeywordNames::TIE_POINT_NORTHING_KW);
      theTranslation.x  = easting.toDouble();
      theTranslation.y  = northing.toDouble(); 
   }
   
   return true;
}

open()

bool ossimTiffWorld::open	(	const ossimFilename &	file,
		ossimPixelType	ptype,
		ossimUnitType	unit
	)

Definition at line 63 of file ossimTiffWorld.cpp.

References ossimString::c_str(), ossimFilename::file(), ossimNotify(), ossimNotifyLevel_WARN, ossimFilename::path(), ossimString::size(), theComputedRotation, theComputedScale, thePixelType, theTranslation, theUnit, theXform1, theXform2, theXform3, theXform4, ossimDpt::x, x, ossimDpt::y, and y.

Referenced by ossimTiffWorld().

{
   bool result = false;

   ifstream is;
   is.open(file.c_str());

   if( !is.is_open() )
   {
      // ESH 07/2008, Trac #234: OSSIM is case sensitive 
      // when using worldfile templates during ingest
      // -- If first you don't succeed with the user-specified
      // filename, try again with the results of a case insensitive search.
      ossimFilename fullName(file);
      ossimDirectory directory(fullName.path());
      ossimFilename filename(fullName.file());
      
      std::vector<ossimFilename> result;
      bool bSuccess = directory.findCaseInsensitiveEquivalents(
         filename, result );
      if ( bSuccess == true )
      {
         int numResults = (int)result.size();
         int i;
         for ( i=0; i<numResults && !is.is_open(); ++i )
         {
            is.open( result[i].c_str() );
         }
      }
   }
      
   if ( is.is_open() )
   {
      double x,y;
      is >> theXform1 >> theXform2 >> theXform3 >> theXform4 >> x >> y;
      theTranslation = ossimDpt(x,y);
      
      // Compute the affine parameters from the transform:
      theComputedRotation = atan2(theXform2,theXform1);
      
/*
 * Commented out warning.
 * Used all the time for tie and scale, NOT for affine. We could wrap around trace
 * if we added trace to class. (drb - 20110115)
 */
#if 0
      double angle2 = atan2(theXform4,theXform3);
      if (fabs(theComputedRotation - angle2) > 0.00001)
      {
         ossimNotify(ossimNotifyLevel_WARN)
            << "ossimTiffWorld -- Non-affine transform encountered."
            << " Use of an affine transform to represent this world file geometry will result in errors."
            << endl;
      }
#endif
      
      double cos_rot = cos(theComputedRotation);
      if (cos_rot != 0.0)
      {
         theComputedScale.x = theXform1/cos_rot;
         theComputedScale.y = theXform4/cos_rot;
      }
      else
      {
         theComputedScale.x = theXform4;
         theComputedScale.y = theXform1;
      }
      thePixelType = ptype;
      theUnit = unit;
      is.close();
      result = true;
   }
   return result;
}

print()

std::ostream & ossimTiffWorld::print

(

std::ostream &

out

)

const

Definition at line 252 of file ossimTiffWorld.cpp.

References theTranslation, theXform1, theXform2, theXform3, and theXform4.

Referenced by operator<<().

{
   out << setiosflags(ios::fixed) << setprecision(15)
       << theXform1     << "\n"
       << theXform2     << "\n"
       << theXform3     << "\n"
       << theXform4     << "\n"
       << theTranslation
       << endl;
   return out;
}

saveToOssimGeom()

bool ossimTiffWorld::saveToOssimGeom	(	ossimKeywordlist &	kwl,
		const char *	prefix = NULL
	)		const

Definition at line 149 of file ossimTiffWorld.cpp.

References ossimKeywordlist::add(), ossimString::c_str(), ossimUnitConversionTool::getMeters(), OSSIM_DEGREES, OSSIM_FEET, OSSIM_PIXEL_IS_AREA, OSSIM_US_SURVEY_FEET, ossimKeywordNames::PIXEL_SCALE_UNITS_KW, ossimKeywordNames::PIXEL_SCALE_XY_KW, ossimKeywordNames::PIXEL_TYPE_KW, thePixelType, theTranslation, theUnit, theXform1, theXform4, ossimKeywordNames::TIE_POINT_UNITS_KW, ossimKeywordNames::TIE_POINT_XY_KW, ossimDpt::toString(), ossimDpt::x, and ossimDpt::y.

{
   ossimDpt scale(fabs(theXform1), fabs(theXform4));
   ossimDpt tie(theTranslation.x, theTranslation.y);

   if ( (theUnit == OSSIM_FEET) || (theUnit == OSSIM_US_SURVEY_FEET) )
   {
      // Convert to meters.
      scale.x = ossimUnitConversionTool(scale.x, theUnit).getMeters();
      scale.y = ossimUnitConversionTool(scale.y, theUnit).getMeters();
      tie.x   = ossimUnitConversionTool(tie.x, theUnit).getMeters();
      tie.y   = ossimUnitConversionTool(tie.y, theUnit).getMeters();
   }
   
   // Shift the tie point to be relative to the center of the pixel.
   if(thePixelType == OSSIM_PIXEL_IS_AREA)
   {
      tie.x += (scale.x/2.0);
      tie.y -= (scale.y/2.0);

      // Adjust the keyword list to reflect pixel is point.
      kwl.add(prefix,
              ossimKeywordNames::PIXEL_TYPE_KW,
              "pixel_is_point",
              true);
   }

   // Units in feet converted to meters up above.
   ossimString units = "meters";
   if(theUnit == OSSIM_DEGREES)
   {
      units = "degrees";
   }
   
   kwl.add(prefix,
           ossimKeywordNames::TIE_POINT_XY_KW,
           tie.toString().c_str(),
           true);
   
   kwl.add(prefix,
           ossimKeywordNames::TIE_POINT_UNITS_KW,
           units.c_str(),
           true);

   kwl.add(prefix,
           ossimKeywordNames::PIXEL_SCALE_XY_KW,
           scale.toString().c_str(),
           true);

   kwl.add(prefix,
           ossimKeywordNames::PIXEL_SCALE_UNITS_KW,
           units.c_str(),
           true);

   return true;
}

Friends And Related Function Documentation

operator<<

OSSIMDLLEXPORT std::ostream& operator<< ( std::ostream &  out, const ossimTiffWorld &  obj  )

friend

Definition at line 264 of file ossimTiffWorld.cpp.

{
   return obj.print(out);
}

Member Data Documentation

theComputedRotation

double ossimTiffWorld::theComputedRotation

protected

Radians.

Definition at line 77 of file ossimTiffWorld.h.

Referenced by open().

theComputedScale

ossimDpt ossimTiffWorld::theComputedScale

protected

Definition at line 76 of file ossimTiffWorld.h.

Referenced by open().

thePixelType

ossimPixelType ossimTiffWorld::thePixelType

protected

Definition at line 74 of file ossimTiffWorld.h.

Referenced by open(), and saveToOssimGeom().

theTranslation

ossimDpt ossimTiffWorld::theTranslation

protected

Definition at line 72 of file ossimTiffWorld.h.

Referenced by forward(), loadFromOssimGeom(), open(), print(), and saveToOssimGeom().

theUnit

ossimUnitType ossimTiffWorld::theUnit

protected

Definition at line 75 of file ossimTiffWorld.h.

Referenced by open(), and saveToOssimGeom().

theXform1

double ossimTiffWorld::theXform1

protected

Definition at line 68 of file ossimTiffWorld.h.

Referenced by forward(), loadFromOssimGeom(), open(), print(), and saveToOssimGeom().

theXform2

double ossimTiffWorld::theXform2

protected

Definition at line 69 of file ossimTiffWorld.h.

Referenced by forward(), loadFromOssimGeom(), open(), and print().

theXform3

double ossimTiffWorld::theXform3

protected

Definition at line 70 of file ossimTiffWorld.h.

Referenced by forward(), loadFromOssimGeom(), open(), and print().

theXform4

double ossimTiffWorld::theXform4

protected

Definition at line 71 of file ossimTiffWorld.h.

Referenced by forward(), loadFromOssimGeom(), open(), print(), and saveToOssimGeom().

---

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

• ossimTiffWorld.h
• ossimTiffWorld.cpp