ossimTiling Class Reference

#include <ossimTiling.h>

Inheritance diagram for ossimTiling:

Public Types
enum	ossimTilingDeltaType { ossimTilingDeltaType_TOTAL_PIXELS, ossimTilingDeltaType_PER_PIXEL }

Public Member Functions
	ossimTiling ()
bool	initialize (const ossimMapProjection &proj, const ossimIrect &boundingRect)
bool	next (ossimRefPtr< ossimMapProjection > &resultProjection, ossimIrect &resultingBounds, ossimString &resultingName) const
void	reset ()
void	setTilingDistance (const ossimDpt &tilingDistance, ossimUnitType unitType)
void	setDelta (const ossimDpt &delta, ossimTilingDeltaType deltaType)
	This sets the pixel delta. More...
void	setTileNameMask (const ossimString &mask)
	This sets the tilename mask. More...
ossimString	getTileNameMask () const
bool	getRowCol (ossim_int64 &row, ossim_int64 &col, ossim_int64 tileId) const
bool	getOrigin (ossimDpt &origin, ossim_int64 tileId) const
bool	getOrigin (ossimDpt &origin, ossim_int64 row, ossim_int64 col) const
void	setPaddingSizeInPixels (const ossimIpt &pizelOverlap)
ossimDpt	getDeltaPerPixel () const
virtual bool	saveState (ossimKeywordlist &kwl, const char *prefix=0) const
virtual bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)
virtual std::ostream &	print (std::ostream &out) const
	Generic print method. 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
void	getConvertedTilingDistance (ossimDpt &pt) const
bool	validate () const
bool	isAngularUnit (ossimUnitType unitType) const
bool	isLinearUnit (ossimUnitType unitType) const
void	getTileName (ossimString &resultingName, ossim_int64 row, ossim_int64 col, ossim_int64 id) const
void	clampGeographic (ossimDrect &rect) const
Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Protected Attributes
ossimDpt	theTilingDistance
	The size of a tile in theTilingDistanceUnitType. More...
ossimUnitType	theTilingDistanceUnitType
	The unit type for "theDelta", and "theTilingDistance". More...
ossimDpt	theDelta
	If (theDeltaType == ossimTilingDeltaType_TOTAL_PIXELS) then this is the size of the tile in pixels like 1024 x 1024. More...
ossimTilingDeltaType	theDeltaType
ossim_int64	theOutputSizeInBytes
	If set tiling size is controlled by the desired output size in bytes. More...
ossim_uint32	theNumberOfBands
	Output number of bands. More...
ossim_uint32	theNumberOfBytesPerPixelPerBand
	Output number of bytes per pixel. More...
ossimDpt	thePaddingSizeInPixels
ossimRefPtr< ossimMapProjection >	theMapProjection
ossimIrect	theImageRect
ossimDrect	theTilingRect
ossim_int64	theTileId
ossim_int64	theTotalHorizontalTiles
ossim_int64	theTotalVerticalTiles
ossim_int64	theTotalTiles
ossimString	theTileNameMask
bool	theEdgeToEdgeFlag
	This flags the code to shift the tie point so that the edge of the pixel falls on the tile boundary. More...

Detailed Description

Definition at line 24 of file ossimTiling.h.

Member Enumeration Documentation

ossimTilingDeltaType

enum ossimTiling::ossimTilingDeltaType

Enumerator
ossimTilingDeltaType_TOTAL_PIXELS
ossimTilingDeltaType_PER_PIXEL

Definition at line 28 of file ossimTiling.h.

   {
      ossimTilingDeltaType_TOTAL_PIXELS,
      ossimTilingDeltaType_PER_PIXEL
   };

Constructor & Destructor Documentation

ossimTiling()

ossimTiling::ossimTiling

(

)

Definition at line 27 of file ossimTiling.cpp.

      :theTilingDistance(0,0),
       theTilingDistanceUnitType(OSSIM_UNIT_UNKNOWN),
       theDelta(0,0),
       theDeltaType(ossimTilingDeltaType_TOTAL_PIXELS),
       theOutputSizeInBytes(0),
       theNumberOfBands(1),
       theNumberOfBytesPerPixelPerBand(1),
       thePaddingSizeInPixels(0.0, 0.0),
       theMapProjection(),
       theImageRect(),
       theTilingRect(),
       theTileId(-1),
       theTotalHorizontalTiles(0),
       theTotalVerticalTiles(0),
       theTotalTiles(0),
       theTileNameMask(),
       theEdgeToEdgeFlag(false)
{
}

Member Function Documentation

clampGeographic()

void ossimTiling::clampGeographic ( ossimDrect &  rect ) const

protected

Definition at line 669 of file ossimTiling.cpp.

References ossimDpt::lat, ossimDpt::lon, ossimDrect::lr(), ossimDrect::orientMode(), and ossimDrect::ul().

{
   ossimDpt ul = rect.ul();
   ossimDpt lr = rect.lr();

   if(ul.lat > 90) ul.lat = 90.0;
   if(lr.lat < -90.0) lr.lat = -90.0;

   if(ul.lon < -180) ul.lon = -180;
   if(lr.lon > 180)  lr.lon = 180;

   rect = ossimDrect(ul, lr, rect.orientMode());
}

getConvertedTilingDistance()

void ossimTiling::getConvertedTilingDistance ( ossimDpt &  pt ) const

protected

Returns

The tiling distance converted to either degrees or meters.

Definition at line 947 of file ossimTiling.cpp.

References ossimMapProjection::isGeographic(), ossimMapProjection::origin(), OSSIM_DEGREES, OSSIM_METERS, OSSIM_PIXEL, ossimNotify(), ossimNotifyLevel_WARN, ossimUnitConversionTool::setValue(), theMapProjection, theTilingDistance, theTilingDistanceUnitType, ossimDpt::x, and ossimDpt::y.

Referenced by getOrigin().

{
   if(theTilingDistanceUnitType == OSSIM_PIXEL)
   {
      pt = theTilingDistance;
      return;
   }
   if (!theMapProjection)
   {
      // This should not happen...
      ossimNotify(ossimNotifyLevel_WARN)
         << "ossimTiling::getConvertedTilingDistance WARNING"
         << " projection not set!" << endl;
      pt = theTilingDistance;
      return;
   }
   ossimUnitConversionTool unitConverter(theMapProjection->origin(),
                                         1.0,
                                         theTilingDistanceUnitType);

   if(theMapProjection->isGeographic())
   {
      unitConverter.setValue(theTilingDistance.x,
                             theTilingDistanceUnitType);
      pt.x = unitConverter.getValue(OSSIM_DEGREES);
      
      unitConverter.setValue(theTilingDistance.y,
                             theTilingDistanceUnitType);
      pt.y = unitConverter.getValue(OSSIM_DEGREES);
   }
   else
   {
      unitConverter.setValue(theTilingDistance.x,
                             theTilingDistanceUnitType);
      pt.x = unitConverter.getValue(OSSIM_METERS);
      
      unitConverter.setValue(theTilingDistance.y,
                             theTilingDistanceUnitType);
      pt.y = unitConverter.getValue(OSSIM_METERS);
   }
}

getDeltaPerPixel()

ossimDpt ossimTiling::getDeltaPerPixel

(

)

const

Definition at line 544 of file ossimTiling.cpp.

References ossimMapProjection::isGeographic(), ossimMapProjection::origin(), OSSIM_DEGREES, OSSIM_METERS, ossimTilingDeltaType_TOTAL_PIXELS, ossimUnitConversionTool::setValue(), theDelta, theDeltaType, theMapProjection, theTilingDistance, theTilingDistanceUnitType, ossimDpt::x, and ossimDpt::y.

Referenced by next().

{
   
   ossimDpt result = theDelta;

   if (!theMapProjection)
   {
      return result;
   }

   if(theDeltaType == ossimTilingDeltaType_TOTAL_PIXELS)
   {
      result = ossimDpt(theTilingDistance.x/theDelta.x,
                        theTilingDistance.y/theDelta.y);
   }

   ossimUnitConversionTool unitConverter(theMapProjection->origin(),
                                         1.0,
                                         theTilingDistanceUnitType);
   if(theMapProjection->isGeographic())
   {
      unitConverter.setValue(result.x, theTilingDistanceUnitType);
      result.x = unitConverter.getValue(OSSIM_DEGREES);
      
      unitConverter.setValue(result.y,
                             theTilingDistanceUnitType);
      result.y = unitConverter.getValue(OSSIM_DEGREES);
   }
   else
   {
      unitConverter.setValue(result.x,
                             theTilingDistanceUnitType);
      result.x = unitConverter.getValue(OSSIM_METERS);
      
      unitConverter.setValue(result.y,
                             theTilingDistanceUnitType);
      result.y = unitConverter.getValue(OSSIM_METERS);
   }

   return result;
}

getOrigin() [1/2]

bool ossimTiling::getOrigin	(	ossimDpt &	origin,
		ossim_int64	tileId
	)		const

Definition at line 501 of file ossimTiling.cpp.

References getRowCol().

Referenced by getTileName(), ossimTilingRect::next(), and next().

{
   ossim_int64 row=0;
   ossim_int64 col=0;
   
   bool result = getRowCol(row, col, tileId);
   if(result)
   {
      result = getOrigin(origin, row, col);
   }

   return result;
}

getOrigin() [2/2]

bool ossimTiling::getOrigin	(	ossimDpt &	origin,
		ossim_int64	row,
		ossim_int64	col
	)		const

Definition at line 516 of file ossimTiling.cpp.

References getConvertedTilingDistance(), ossimDrect::orientMode(), OSSIM_RIGHT_HANDED, theTilingRect, theTotalHorizontalTiles, theTotalVerticalTiles, ossimDrect::ul(), ossimDpt::x, and ossimDpt::y.

{
   bool result = false;

   if((col < static_cast<ossim_int64>(theTotalHorizontalTiles)) &&
      (row < static_cast<ossim_int64>(theTotalVerticalTiles)))
   {
      ossimDpt convertedTilingDistance;
      getConvertedTilingDistance(convertedTilingDistance);

      result = true;
      if(theTilingRect.orientMode() == OSSIM_RIGHT_HANDED)
      {
         origin.x = theTilingRect.ul().x + col*convertedTilingDistance.x;
         origin.y = theTilingRect.ul().y - row*convertedTilingDistance.y;
      }
      else
      {
         origin.x = theTilingRect.ul().x + col*convertedTilingDistance.x;
         origin.y = theTilingRect.ul().y + row*convertedTilingDistance.y;
      }
   }

   return result;
}

getRowCol()

bool ossimTiling::getRowCol	(	ossim_int64 &	row,
		ossim_int64 &	col,
		ossim_int64	tileId
	)		const

Definition at line 481 of file ossimTiling.cpp.

References theTotalHorizontalTiles, theTotalTiles, and theTotalVerticalTiles.

Referenced by getOrigin(), ossimTilingRect::next(), and next().

{
   bool result = true;
   
   if((theTotalHorizontalTiles > 0)&&
      (tileId < theTotalTiles))
   {
      row = tileId/static_cast<ossim_int64>(theTotalHorizontalTiles);
      col = tileId%static_cast<ossim_int64>(theTotalHorizontalTiles);
      if((col >= static_cast<ossim_int32>(theTotalHorizontalTiles)) &&
         (row >= static_cast<ossim_int32>(theTotalVerticalTiles)))
      {           
         result = false;
      }
   }
   return result;
}

getTileName()

void ossimTiling::getTileName ( ossimString &  resultingName, ossim_int64  row, ossim_int64  col, ossim_int64  id  ) const

protected

Definition at line 586 of file ossimTiling.cpp.

References ossimString::c_str(), ossimString::contains(), getOrigin(), ossimDpt::lat, ossimDpt::lon, OSSIM_DEGREES, ossimString::substitute(), theTileNameMask, theTilingDistance, theTilingDistanceUnitType, and ossimDpt::x.

Referenced by ossimTilingRect::next(), and next().

{
   if(theTileNameMask == "")
   {
      ostringstream idString;
      idString << id;
      resultingName = ossimString("tile") + idString.str().c_str();
   }
   else if(theTileNameMask.contains("%SRTM%"))
   {
      // must be a 1x1 degree tiling distance
      //
      if((theTilingDistanceUnitType == OSSIM_DEGREES)&&
         (theTilingDistance.x == 1.0)&&
         (theTilingDistance.x == 1.0))
      {
         ostringstream latString;
         ostringstream lonString;
         
         resultingName = "";
         ossimDpt origin;
         getOrigin(origin, row, col);
         // the name is lower left and not upper left 
         // subtract one degree
         //
         origin.lat -=1;
         latString << setfill('0') << setw(2) << fabs(origin.lat);
         lonString << setfill('0') << setw(3) << fabs(origin.lon);
         
         if(origin.lat < 0.0)
         {
            resultingName += "S";
         }
         else 
         {
            resultingName += "N";
         }
         resultingName += latString.str().c_str();
         if(origin.lon < 0.0)
         {
            resultingName += "W";
         }
         else
         {
            resultingName += "E";
         }
         resultingName += lonString.str().c_str();
         resultingName += ".hgt";
      }
   }
   else
   {
      ostringstream rowString;
      ostringstream colString;
      ostringstream idString;
      ostringstream oRowString;
      ostringstream oColString;
      ossimDpt      origin;
      getOrigin(origin, row, col);
      
      rowString << row;
      colString << col;
      idString  << id;
      oRowString << row;
      oColString << col;
      
      resultingName = theTileNameMask;
      resultingName = resultingName.substitute("%r%",
                                               rowString.str().c_str());
      resultingName = resultingName.substitute("%c%",
                                               colString.str().c_str());
      resultingName = resultingName.substitute("%i%",
                                               idString.str().c_str());
      resultingName = resultingName.substitute("%oc",
                                               oColString.str().c_str());
      resultingName = resultingName.substitute("%or",
                                               oRowString.str().c_str());
   }
}

getTileNameMask()

ossimString ossimTiling::getTileNameMask

(

)

const

Definition at line 476 of file ossimTiling.cpp.

References theTileNameMask.

{
   return theTileNameMask;
}

initialize()

bool ossimTiling::initialize	(	const ossimMapProjection &	proj,
		const ossimIrect &	boundingRect
	)

Definition at line 48 of file ossimTiling.cpp.

Referenced by ossimIgen::outputProduct().

{
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "ossimTiling::initialize DEBUG: Entered..."
         << "\nBounding rect === " << boundingRect
         << std::endl;
   }
   
   bool result = true;
   theMapProjection = (ossimMapProjection*)proj.dup();
   theImageRect     = boundingRect;

   result = validate();

   ossimDpt convertedTilingDistance = theTilingDistance;

   if(result)
   {
      // Let's setup the bounding tile rect.
      if(theTilingDistanceUnitType != OSSIM_PIXEL)
      {
         getConvertedTilingDistance(convertedTilingDistance);
         
         if(theMapProjection->isGeographic())
         {
            ossimGpt ul;
            ossimGpt ur;
            ossimGpt lr;
            ossimGpt ll;

            theMapProjection->lineSampleToWorld(theImageRect.ul(),
                                                ul);
            theMapProjection->lineSampleToWorld(theImageRect.ur(),
                                                ur);
            theMapProjection->lineSampleToWorld(theImageRect.lr(),
                                                lr);
            theMapProjection->lineSampleToWorld(theImageRect.ll(),
                                                ll);

            theTilingRect = ossimDrect(ossimDpt(ul),
                                       ossimDpt(ur),
                                       ossimDpt(lr),
                                       ossimDpt(ll),
                                       OSSIM_RIGHT_HANDED);

            if(traceDebug())
            {
               ossimNotify(ossimNotifyLevel_DEBUG)
                  << "DEBUG: Geographic input bounds =  "
                  << theTilingRect
                  << std::endl;
            }
            
            theTilingRect.stretchToTileBoundary(convertedTilingDistance);
            
            if(traceDebug())
            {
               ossimNotify(ossimNotifyLevel_DEBUG)
                  << "DEBUG: Geographic input bounds stretched =  "
                  << theTilingRect << std::endl;
            }
            
            clampGeographic(theTilingRect);

            if(traceDebug())
            {
               ossimNotify(ossimNotifyLevel_DEBUG)
                  << "DEBUG: Geographic input bounds clamped =  "
                  << theTilingRect << std::endl;
            }

         }  // End "if(theMapProjection->isGeographic())"
         
         else // meters
         {
            ossimDpt ul;
            ossimDpt ur;
            ossimDpt lr;
            ossimDpt ll;
            
            theMapProjection->lineSampleToEastingNorthing(theImageRect.ul(),
                                                          ul);
            theMapProjection->lineSampleToEastingNorthing(theImageRect.ur(),
                                                          ur);
            theMapProjection->lineSampleToEastingNorthing(theImageRect.lr(),
                                                          lr);
            theMapProjection->lineSampleToEastingNorthing(theImageRect.ll(),
                                                          ll);
            theTilingRect = ossimDrect(ul,
                                       ur,
                                       lr,
                                       ll,
                                       OSSIM_RIGHT_HANDED);
            
            theTilingRect.stretchToTileBoundary(convertedTilingDistance);
         }
      }
      else
      {
         ossim_int32 remainderX = (ossim_int32)((theImageRect.width()%((ossim_int32)theDelta.x)) != 0);
         ossim_int32 remainderY = (ossim_int32)((theImageRect.height()%((ossim_int32)theDelta.y)) != 0);
         
         ossim_int32 w = (ossim_int32)((theImageRect.width()/(ossim_int32)theDelta.x)*theDelta.x +
                                       (remainderX*theDelta.x));
         ossim_int32 h = (ossim_int32)((theImageRect.height()/(ossim_int32)theDelta.y)*theDelta.y +
                                       (remainderY*theDelta.y));
         theTilingRect = ossimDrect(theImageRect.ul().x,
                                    theImageRect.ul().y,
                                    theImageRect.ul().x + (w-1),
                                    theImageRect.ul().y + (h-1));

         // since we are pixel space we force delta to be 1 pixel unit
         //
         theDelta.x   = 1.0;
         theDelta.y   = 1.0;
         theDeltaType = ossimTilingDeltaType_PER_PIXEL;
      }
   }
   
   theTotalHorizontalTiles = ossim::round<int>(fabs(theTilingRect.ur().x - theTilingRect.ul().x)/convertedTilingDistance.x);
   theTotalVerticalTiles   = ossim::round<int>(fabs(theTilingRect.ur().y - theTilingRect.lr().y)/convertedTilingDistance.y);
   theTotalTiles           = theTotalHorizontalTiles*theTotalVerticalTiles;

   // reset the tile id to the beginning
   //
   reset();
   
   if(traceDebug())
   {
      print(ossimNotify(ossimNotifyLevel_DEBUG));
      
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "\nossimTiling::initialize DEBUG: Leaving..." << std::endl;
   }
   return result;
}

isAngularUnit()

bool ossimTiling::isAngularUnit ( ossimUnitType  unitType ) const

protected

Definition at line 408 of file ossimTiling.cpp.

References OSSIM_DEGREES, OSSIM_MINUTES, OSSIM_RADIANS, and OSSIM_SECONDS.

{
   bool result = false;
   
   switch(unitType)
   {
      case OSSIM_DEGREES:
      case OSSIM_RADIANS:
      case OSSIM_SECONDS:
      case OSSIM_MINUTES:
      {
         result = true;
         break;
      }
      default:
      {
         break;
      }
   }
   return result;
}

isLinearUnit()

bool ossimTiling::isLinearUnit ( ossimUnitType  unitType ) const

protected

Definition at line 430 of file ossimTiling.cpp.

References OSSIM_FEET, OSSIM_METERS, OSSIM_MILES, OSSIM_MILLIMETERS, OSSIM_NAUTICAL_MILES, and OSSIM_US_SURVEY_FEET.

{
   bool result = false;
   
   switch(unitType)
   {
      case OSSIM_METERS:
      case OSSIM_FEET:
      case OSSIM_US_SURVEY_FEET:
      case OSSIM_NAUTICAL_MILES:
      case OSSIM_MILES:
      case OSSIM_MILLIMETERS:
      {
         result = true;
         break;
      }
      default:
      {
         break;
      }
   }
   return result;
   
}

loadState()

bool ossimTiling::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.

Reimplemented in ossimTilingRect, and ossimTilingPoly.

Definition at line 760 of file ossimTiling.cpp.

References distance(), ossimKeywordlist::find(), ossimUnitTypeLut::getEntryNumber(), ossimUnitTypeLut::instance(), ossimKeywordlist::numberOf(), OSSIM_PIXEL, ossimTilingDeltaType_PER_PIXEL, ossimTilingDeltaType_TOTAL_PIXELS, setTileNameMask(), theDelta, theDeltaType, theEdgeToEdgeFlag, theNumberOfBands, theNumberOfBytesPerPixelPerBand, theOutputSizeInBytes, thePaddingSizeInPixels, theTileNameMask, theTilingDistance, theTilingDistanceUnitType, ossimString::toBool(), ossimString::toInt32(), ossimString::toInt64(), ossimDpt::x, x, ossimDpt::y, and y.

{
   bool result = false;
   
   // Get the mask if any.
   theTileNameMask = kwl.find(prefix, "tile_name_mask");
   setTileNameMask(theTileNameMask);

   const char* paddingSizeInPixels = kwl.find(prefix,
                                              "padding_size_in_pixels");
   if (paddingSizeInPixels)
   {
      ossimString x,y;
      std::istringstream padding(ossimString(paddingSizeInPixels).c_str());
      padding >> x >> y;
      thePaddingSizeInPixels.x = x.toFloat64();
      thePaddingSizeInPixels.y = y.toFloat64();
   }
   
   // Check to tile by size in bytes.
   const char* lookup;
   if (kwl.numberOf(prefix, "output_size_in_"))
   {
      lookup = kwl.find(prefix, "output_size_in_bytes");
      if (lookup)
      {
         theOutputSizeInBytes = ossimString(lookup).toInt64();
      }
      lookup = kwl.find(prefix, "output_size_in_kilo_bytes");
      if (lookup)
      {
         theOutputSizeInBytes = ossimString(lookup).toInt64() * 1024;
      }
      lookup = kwl.find(prefix, "output_size_in_mega_bytes");
      if (lookup)
      {
         theOutputSizeInBytes = ossimString(lookup).toInt64() * 1024 * 1024;
      }
   }

   if (theOutputSizeInBytes)
   {
      
      lookup = kwl.find(prefix, "output_bands");
      if (lookup)
      {
         theNumberOfBands = ossimString(lookup).toInt32();
      }
      lookup = kwl.find(prefix, "output_bytes_per_pixel_per_band");
      if (lookup)
      {
         theNumberOfBytesPerPixelPerBand = ossimString(lookup).toInt32();
      }
      
      ossim_int64 pixelsPerBand = theOutputSizeInBytes /
         (theNumberOfBands * theNumberOfBytesPerPixelPerBand);
      
      ossim_int32 oneDimension =
         static_cast<ossim_int32>(floor(sqrt((double)pixelsPerBand)));

      //---
      // TODO: Clamp to power of two option. (drb)
      //---
      // theDelta.x = oneDimension;
      // theDelta.y = oneDimension;
      // theTilingDistance.x = 1;
      // theTilingDistance.y = 1;
      
      theDelta.x = 1;
      theDelta.y = 1;
      theTilingDistance.x = oneDimension;
      theTilingDistance.y = oneDimension;
      theDeltaType = ossimTilingDeltaType_TOTAL_PIXELS;
      theTilingDistanceUnitType = OSSIM_PIXEL;
      result = true;
   }
   else
   {
      const char* tilingDistance = kwl.find(prefix,
                                            "tiling_distance");
      const char* tilingDistanceType = kwl.find(prefix,
                                                "tiling_distance_type");
      const char* delta = kwl.find(prefix,
                                   "delta");
      
      const char* deltaType = kwl.find(prefix,
                                       "delta_type");
      
      result = tilingDistance&&tilingDistanceType&&delta&&deltaType&&paddingSizeInPixels;
      ossimString x,y;
      std::istringstream distance(ossimString(tilingDistance).c_str());
      distance >> x >> y;
      theTilingDistance.x = x.toFloat64();
      theTilingDistance.y = y.toFloat64();
      if(theTilingDistance.x <= 0.0)
      {
         theTilingDistance.x = 1.0;
      }
      if(theTilingDistance.y<=0.0)
      {
         theTilingDistance.y = theTilingDistance.x;
      }
      
      // unitLut.getTableIndexString(theTilingDistanceUnitType), ?????
      
      theTilingDistanceUnitType = (ossimUnitType)
         ossimUnitTypeLut::instance()->getEntryNumber(
            ossimString(tilingDistanceType).c_str());
      
      theDelta = ossimDpt(0,0);
      x="";
      y="";
      std::istringstream deltaValues(ossimString(delta).c_str());
      deltaValues >> x >> y;
      theDelta.x = x.toFloat64();
      theDelta.y = y.toFloat64();
      
      if(theDelta.x <= 0.0)
      {
         theDelta.x = 1.0;
      }
      
      if(theDelta.y <= 0.0)
      {
         theDelta.y = theDelta.x;
      }
      
      if(ossimString(deltaType).downcase().contains("total"))
      {
         theDeltaType = ossimTilingDeltaType_TOTAL_PIXELS;
      }
      else
      {
         theDeltaType = ossimTilingDeltaType_PER_PIXEL;
      }
   }
   
   lookup = kwl.find(prefix, "edge_to_edge");
   if ( lookup )
   {
      theEdgeToEdgeFlag = ossimString::toBool(lookup);
   }
      
   if (traceDebug())
   {
      print(ossimNotify(ossimNotifyLevel_DEBUG));
   }

   return result;
}

next()

bool ossimTiling::next	(	ossimRefPtr< ossimMapProjection > &	resultProjection,
		ossimIrect &	resultingBounds,
		ossimString &	resultingName
	)		const

Definition at line 188 of file ossimTiling.cpp.

References ossimGpt::datum(), getDeltaPerPixel(), getOrigin(), getRowCol(), getTileName(), ossimMapProjection::isGeographic(), ossimDpt::lat, ossimDpt::lon, ossimMapProjection::origin(), OSSIM_PIXEL, ossimTilingDeltaType_TOTAL_PIXELS, ossimMapProjection::setDecimalDegreesPerPixel(), ossimMapProjection::setMetersPerPixel(), ossimMapProjection::setUlTiePoints(), theDelta, theDeltaType, theEdgeToEdgeFlag, theMapProjection, thePaddingSizeInPixels, theTileId, theTilingDistance, theTilingDistanceUnitType, theTotalTiles, ossimIpt::x, ossimDpt::x, ossimIpt::y, and ossimDpt::y.

Referenced by ossimIgen::outputProduct().

{
   bool result = true;
   
   if(theTileId < theTotalTiles)
   {
      ossimDpt origin;
      ossim_int64 row=0;
      ossim_int64 col=0;

      getRowCol(row, col, theTileId);

      getTileName(resultingName,
                  row, col, theTileId);
      
      getOrigin(origin, row, col);

      if(theTilingDistanceUnitType == OSSIM_PIXEL)
      {
         ossimIpt ul = origin;

         resultingBounds =
            ossimIrect(ul.x - (ossim_int32)thePaddingSizeInPixels.x,
                       ul.y - (ossim_int32)thePaddingSizeInPixels.y,
                       ul.x + ((ossim_int32)theTilingDistance.x-1) +
                       (ossim_int32)thePaddingSizeInPixels.x,
                       ul.y + ((ossim_int32)theTilingDistance.y-1) +
                       (ossim_int32)thePaddingSizeInPixels.y);
      }
      else
      {
         
         ossimDpt deltaPerPixel = getDeltaPerPixel();
         ossimIpt pixels;

         if(theDeltaType == ossimTilingDeltaType_TOTAL_PIXELS)
         {
            pixels =   theDelta;
         }
         else
         {
            pixels =   ossimDpt(theTilingDistance.x/theDelta.x,
                                theTilingDistance.y/theDelta.y);
         }

         if(theMapProjection->isGeographic())
         {
            if ( theEdgeToEdgeFlag )
            {
               theMapProjection->setUlTiePoints(
                  ossimGpt( origin.lat - (deltaPerPixel.y/2.0),
                            origin.lon + (deltaPerPixel.x/2.0),
                            0.0,
                            theMapProjection->origin().datum()) );
            }
            else
            {
               theMapProjection->setUlTiePoints(
                  ossimGpt(origin.lat,
                           origin.lon,
                           0.0,
                           theMapProjection->origin().datum()));
               
            }
            theMapProjection->setDecimalDegreesPerPixel(deltaPerPixel);
         }
         else
         {
            if ( theEdgeToEdgeFlag )
            {
               theMapProjection->setUlTiePoints(
                  ossimDpt( origin.x + (deltaPerPixel.x/2.0),
                            origin.y - (deltaPerPixel.y/2.0) ) );
            }
            else
            {
               theMapProjection->setUlTiePoints(ossimDpt(origin.x, origin.y));
            }
            theMapProjection->setMetersPerPixel(deltaPerPixel);
         }
         resultingBounds = ossimIrect(-(ossim_int32)thePaddingSizeInPixels.x,
                                      -(ossim_int32)thePaddingSizeInPixels.y,
                                      (pixels.x-1) + (ossim_int32)thePaddingSizeInPixels.x,
                                      (pixels.y-1) + (ossim_int32)thePaddingSizeInPixels.y);
      }
      resultProjection = theMapProjection;

      ++theTileId;
      if(traceDebug()&&resultProjection.valid())
      {
         ossimKeywordlist projKwl;
         
         resultProjection->saveState(projKwl);
         ossimNotify(ossimNotifyLevel_DEBUG)
            << "ossimTiling::next DEBUG: rect = " << resultingBounds
            << "\nproj                          = " << projKwl
            << "\ntileName                      = " << resultingName
            << "\norigin                        = " << origin << std::endl;
      }
   }
   else
   {
      result = false;
   }

   
   return result;
}

print()

std::ostream & ossimTiling::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 912 of file ossimTiling.cpp.

References ossimMapProjection::print(), theDelta, theDeltaType, theEdgeToEdgeFlag, theImageRect, theMapProjection, theNumberOfBands, theNumberOfBytesPerPixelPerBand, theOutputSizeInBytes, thePaddingSizeInPixels, theTileId, theTileNameMask, theTilingDistance, theTilingDistanceUnitType, theTilingRect, theTotalHorizontalTiles, theTotalTiles, theTotalVerticalTiles, and ossimRefPtr< T >::valid().

{
   out << "theTilingDistance:                 " << theTilingDistance
       << "\ntheTilingDistanceUnitType:       " << theTilingDistanceUnitType
       << "\ntheDelta:                        " << theDelta
       << "\ntheDeltaType:                    " << theDeltaType
       << "\nthePaddingSizeInPixels:          " << thePaddingSizeInPixels
       << "\ntheImageRect:                    " << theImageRect
       << "\ntheTilingRect:                   " << theTilingRect
       << "\ntheTileId:                       " << theTileId
       << "\ntheTotalHorizontalTiles:         " << theTotalHorizontalTiles
       << "\ntheTotalVerticalTiles:           " << theTotalVerticalTiles
       << "\ntheTotalTiles:                   " << theTotalTiles
       << "\ntheTileNameMask:                 " << theTileNameMask
       << "\ntheOutputSizeInBytes:            " << theOutputSizeInBytes
       << "\ntheNumberOfBands:                " << theNumberOfBands
       << "\ntheNumberOfBytesPerPixelPerBand: " <<
      theNumberOfBytesPerPixelPerBand
       << "\ntheEdgeToEdgeFlag:               " << theEdgeToEdgeFlag
       << "\n";

   if (theMapProjection.valid())
   {
      out << "\ntheMapProjection:\n";
      theMapProjection->print(out);
   }
   else
   {
      out << "theMapProjection is not set.";
   }
   out << endl;

   return out;
}

reset()

void ossimTiling::reset

(

void

)

Definition at line 300 of file ossimTiling.cpp.

References theTileId.

{
   theTileId = 0;
}

saveState()

bool ossimTiling::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.

Reimplemented in ossimTilingRect, and ossimTilingPoly.

Definition at line 683 of file ossimTiling.cpp.

References ossimKeywordlist::add(), ossimString::c_str(), ossimUnitTypeLut::instance(), ossimTilingDeltaType_TOTAL_PIXELS, theDelta, theDeltaType, theEdgeToEdgeFlag, theNumberOfBands, theNumberOfBytesPerPixelPerBand, theOutputSizeInBytes, thePaddingSizeInPixels, theTileNameMask, theTilingDistance, theTilingDistanceUnitType, ossimString::toString(), ossimDpt::x, and ossimDpt::y.

{
   std::stringstream tilingDistance;

   tilingDistance << theTilingDistance.x << " " << theTilingDistance.y << std::endl;
   
   kwl.add(prefix,
           "tiling_distance",
           tilingDistance.str().c_str(),
           true);

   
   kwl.add(prefix,
           "tiling_distance_type",
           ossimUnitTypeLut::instance()->
           getTableIndexString(theTilingDistanceUnitType),
           true);
   std::ostringstream delta;
   delta << theDelta.x << " " << theDelta.y;
   kwl.add(prefix,
           "delta",
           delta.str().c_str(),
           true);
   
   if(theDeltaType == ossimTilingDeltaType_TOTAL_PIXELS)
   {
      kwl.add(prefix,
              "delta_type",
              "total_pixels",
              true);
   }
   else
   {
      kwl.add(prefix,
              "delta_type",
              "delta_per_pixels",
              true);
   }
   std::ostringstream padding;

   padding << thePaddingSizeInPixels.x << " " << thePaddingSizeInPixels.y;
   kwl.add(prefix,
           "padding_size_in_pixels",
           padding.str().c_str(),
           true);

   kwl.add(prefix,
           "tile_name_mask",
           theTileNameMask.c_str(),
           true);

   if (theOutputSizeInBytes)
   {
      kwl.add(prefix,
              "output_size_in_bytes",
              ossimString::toString(theOutputSizeInBytes).c_str(),
              true);
      kwl.add(prefix,
              "output_bands",
              theNumberOfBands,
              true);
      kwl.add(prefix,
              "output_bytes_per_pixel_per_band",
              theNumberOfBytesPerPixelPerBand,
              true);
   }

   kwl.add(prefix,
           "edge_to_edge",
           ossimString::toString(theEdgeToEdgeFlag),
           true);
   
   
   return true;
}

setDelta()

void ossimTiling::setDelta	(	const ossimDpt &	delta,
		ossimTilingDeltaType	deltaType
	)

This sets the pixel delta.

The delta can either be TOTAL_PIXELS or UNIT_PER_PIXEL.

If the delta type is TOTAL_PIXELS then the unit per pixel is calculated from the theTilingDistance. This is very useful when wanting to be on even geographic boundaries and would like to have a fixed width and height for the pixels. Flight simulators use this tiling scheme for power of 2 outputs.

if the delta type is unit per pixel then the total pixels is computed form the theTilingDistance. This is useful when you might want whole number GSD's and whole numbered tile boundaries.

Definition at line 312 of file ossimTiling.cpp.

References theDelta, and theDeltaType.

{
   theDelta     = delta;
   theDeltaType = deltaType;
}

setPaddingSizeInPixels()

void ossimTiling::setPaddingSizeInPixels

(

const ossimIpt &

pizelOverlap

)

setTileNameMask()

void ossimTiling::setTileNameMask

(

const ossimString &

mask

)

This sets the tilename mask.

The key tokens that are supported are.

r% Replaces with the row number of the current tile c% Replaces with the column number of the current tile i% Replaces with the current tile id. or% Replaces with the origin of the row oc% Replaces with the origin of the col SRTM% Replaces all filenames with the SRTM file name convention

Examples: tiler_c% assume r = 0 and c = 100 then this is replaced with tile0_100

Definition at line 455 of file ossimTiling.cpp.

References ossimString::contains(), and theTileNameMask.

Referenced by ossimTilingRect::loadState(), and loadState().

{
   if(theTileNameMask == "")
   {
      theTileNameMask = "tile%i%";
   }
   if(mask.contains("%i%")||
      mask.contains("%oc%")||
      mask.contains("%or%")||
      mask.contains("%r%")||
      mask.contains("%c%")||
      mask.contains("%SRTM%"))
   {
      theTileNameMask = mask;
   }
   else
   {
      theTileNameMask += "%i%";
   }
}

setTilingDistance()

void ossimTiling::setTilingDistance	(	const ossimDpt &	tilingDistance,
		ossimUnitType	unitType
	)

Parameters

tilingDistance	Distance in the specified units.
unitType	Currently only angular unit degrees, and linear unit meters are supported. If unitType is pixel unit then the delta per unit will be set to 1.

Definition at line 305 of file ossimTiling.cpp.

References theTilingDistance, and theTilingDistanceUnitType.

{
   theTilingDistance         = tilingDistance;
   theTilingDistanceUnitType = unitType;
}

validate()

bool ossimTiling::validate ( ) const

protected

Definition at line 319 of file ossimTiling.cpp.

References FLT_EPSILON, ossimIrect::hasNans(), ossimMapProjection::isGeographic(), OSSIM_DEGREES, OSSIM_FEET, OSSIM_METERS, OSSIM_MILES, OSSIM_MILLIMETERS, OSSIM_MINUTES, OSSIM_NAUTICAL_MILES, OSSIM_PIXEL, OSSIM_RADIANS, OSSIM_SECONDS, OSSIM_US_SURVEY_FEET, ossimNotify(), ossimNotifyLevel_WARN, theDelta, theImageRect, theMapProjection, theTilingDistance, theTilingDistanceUnitType, ossimRefPtr< T >::valid(), ossimDpt::x, and ossimDpt::y.

{
   bool result = true;

   if(theMapProjection.valid())
   {
      if(theMapProjection->isGeographic())
      {
         switch(theTilingDistanceUnitType)
         {
            case OSSIM_DEGREES:
            case OSSIM_RADIANS:
            case OSSIM_SECONDS:
            case OSSIM_MINUTES:
            case OSSIM_PIXEL:
            {
               break;
            }
            default:
            {
               ossimNotify(ossimNotifyLevel_WARN)
                  << "ossimTiling::validate()\n"
                  << "Map projeciton requires tiling in angular units but the"
                  << "\nspacing is in non angular" << std::endl;
               result = false;
            }
         }
      }
      else
      {
         switch(theTilingDistanceUnitType)
         {
            case OSSIM_METERS:
            case OSSIM_FEET:
            case OSSIM_US_SURVEY_FEET:
            case OSSIM_NAUTICAL_MILES:
            case OSSIM_PIXEL:
            case OSSIM_MILES:
            case OSSIM_MILLIMETERS:
            {
               break;
            }
            default:
            {
               ossimNotify(ossimNotifyLevel_WARN)
                  << "ossimTiling::validate()"
                  << "\nMap projeciton requires tiling using linear spacing"
                  << " but the spacing is in non linear" << std::endl;
               result = false;
            }
         }
      }
   }
   else
   {
      result = false;
      ossimNotify(ossimNotifyLevel_WARN)
         << "ossimTiling::validate()"
         << "\nthe image projection is null and so not valid"
         << std::endl;
   }
   if((theDelta.x <= FLT_EPSILON) ||
      (theDelta.y <= FLT_EPSILON))
   {
      ossimNotify(ossimNotifyLevel_WARN)
         << "ossimTiling::validate() the delta is too small or is negative"
         << "value = " << theDelta << std::endl;
      result = false;
   }
   if((theTilingDistance.x <= FLT_EPSILON)||
      (theTilingDistance.y <= FLT_EPSILON))
   {
      ossimNotify(ossimNotifyLevel_WARN)
         << "ossimTiling::validate()"
         << "\nthe tiling distance is too small or is negative"
         << "Value = " << theTilingDistance << std::endl;
   }
   
   if(theImageRect.hasNans())
   {
      ossimNotify(ossimNotifyLevel_WARN)
         << "ossimTiling::validate() the image rect has nans"
         << std::endl;
      result = false;
   }
   
   return result;
}

Member Data Documentation

theDelta

ossimDpt ossimTiling::theDelta

protected

If (theDeltaType == ossimTilingDeltaType_TOTAL_PIXELS) then this is the size of the tile in pixels like 1024 x 1024.

If (theDeltaType == ossimTilingDeltaType_PER_PIXEL) then this is the size of a single pixel like 1.0 meter.

Definition at line 134 of file ossimTiling.h.

Referenced by getDeltaPerPixel(), ossimTilingRect::loadState(), loadState(), next(), print(), saveState(), setDelta(), and validate().

theDeltaType

ossimTilingDeltaType ossimTiling::theDeltaType

protected

See also

theDelta

Definition at line 137 of file ossimTiling.h.

Referenced by getDeltaPerPixel(), loadState(), next(), print(), saveState(), and setDelta().

theEdgeToEdgeFlag

bool ossimTiling::theEdgeToEdgeFlag

protected

This flags the code to shift the tie point so that the edge of the pixel falls on the tile boundary.

default=false

Definition at line 186 of file ossimTiling.h.

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

theImageRect

ossimIrect ossimTiling::theImageRect

protected

Definition at line 174 of file ossimTiling.h.

Referenced by ossimTilingRect::initializeBase(), print(), ossimTilingPoly::setRect(), and validate().

theMapProjection

ossimRefPtr<ossimMapProjection> ossimTiling::theMapProjection

mutableprotected

Definition at line 173 of file ossimTiling.h.

Referenced by ossimTilingRect::getConvertedDistance(), getConvertedTilingDistance(), getDeltaPerPixel(), ossimTilingRect::getPaddingSize(), ossimTilingRect::initializeBase(), ossimTilingPoly::next(), ossimTilingRect::next(), next(), ossimTilingPoly::nextFeature(), ossimTilingPoly::parseShpFile(), print(), and validate().

theNumberOfBands

ossim_uint32 ossimTiling::theNumberOfBands

protected

Output number of bands.

Needed to tile by output size in bytes.

default = 1

See also

theOutputSizeInBytes

Definition at line 158 of file ossimTiling.h.

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

theNumberOfBytesPerPixelPerBand

ossim_uint32 ossimTiling::theNumberOfBytesPerPixelPerBand

protected

Output number of bytes per pixel.

Needed to tile by output size in bytes.

default = 1

See also

theOutputSizeInBytes

Note

This bytes per single pixel, not all bands.

Definition at line 170 of file ossimTiling.h.

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

theOutputSizeInBytes

ossim_int64 ossimTiling::theOutputSizeInBytes

protected

If set tiling size is controlled by the desired output size in bytes.

Set by one of output_size_in_bytes, output_size_in_kilo_bytes, or output_size_in_mega_bytes. Always stored in bytes.

Note

kilo_byte = 1024 X 1024, mega_byte = 1024 X 1024 X 1024.

If set this relys on theNumberOfBands and theNumberOfBytesPerPixel need to alse be set correctly.

Definition at line 149 of file ossimTiling.h.

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

thePaddingSizeInPixels

ossimDpt ossimTiling::thePaddingSizeInPixels

protected

Definition at line 172 of file ossimTiling.h.

Referenced by ossimTilingRect::getPaddingSize(), ossimTilingRect::initializeBase(), ossimTilingPoly::loadState(), ossimTilingRect::loadState(), loadState(), ossimTilingRect::next(), next(), ossimTilingPoly::parseShpFile(), print(), ossimTilingRect::saveState(), saveState(), and ossimTilingPoly::setRect().

theTileId

ossim_int64 ossimTiling::theTileId

mutableprotected

Definition at line 176 of file ossimTiling.h.

Referenced by ossimTilingPoly::next(), ossimTilingRect::next(), next(), ossimTilingPoly::nextFeature(), print(), and reset().

theTileNameMask

ossimString ossimTiling::theTileNameMask

protected

Definition at line 180 of file ossimTiling.h.

Referenced by getTileName(), getTileNameMask(), ossimTilingPoly::loadState(), ossimTilingRect::loadState(), loadState(), ossimTilingPoly::next(), print(), ossimTilingRect::saveState(), saveState(), and setTileNameMask().

theTilingDistance

ossimDpt ossimTiling::theTilingDistance

protected

The size of a tile in theTilingDistanceUnitType.

Definition at line 122 of file ossimTiling.h.

Referenced by getConvertedTilingDistance(), getDeltaPerPixel(), getTileName(), ossimTilingRect::initializeBase(), ossimTilingRect::loadState(), loadState(), next(), print(), ossimTilingRect::saveState(), saveState(), setTilingDistance(), and validate().

theTilingDistanceUnitType

ossimUnitType ossimTiling::theTilingDistanceUnitType

protected

The unit type for "theDelta", and "theTilingDistance".

Definition at line 125 of file ossimTiling.h.

Referenced by ossimTilingRect::getConvertedDistance(), getConvertedTilingDistance(), getDeltaPerPixel(), ossimTilingRect::getPaddingSize(), getTileName(), ossimTilingRect::initializeBase(), ossimTilingRect::loadState(), loadState(), next(), print(), ossimTilingRect::saveState(), saveState(), setTilingDistance(), and validate().

theTilingRect

ossimDrect ossimTiling::theTilingRect

protected

Definition at line 175 of file ossimTiling.h.

Referenced by getOrigin(), and print().

theTotalHorizontalTiles

ossim_int64 ossimTiling::theTotalHorizontalTiles

protected

Definition at line 177 of file ossimTiling.h.

Referenced by getOrigin(), getRowCol(), ossimTilingRect::next(), and print().

theTotalTiles

ossim_int64 ossimTiling::theTotalTiles

protected

Definition at line 179 of file ossimTiling.h.

Referenced by getRowCol(), ossimTilingPoly::next(), ossimTilingRect::next(), next(), ossimTilingPoly::parseShpFile(), and print().

theTotalVerticalTiles

ossim_int64 ossimTiling::theTotalVerticalTiles

protected

Definition at line 178 of file ossimTiling.h.

Referenced by getOrigin(), getRowCol(), ossimTilingRect::next(), and print().

---

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

• ossimTiling.h
• ossimTiling.cpp