ossimRpfTocEntry Class Reference

#include <ossimRpfTocEntry.h>

Public Member Functions
	ossimRpfTocEntry ()
ossimErrorCode	parseStream (std::istream &in, ossimByteOrder byteOrder)
std::ostream &	print (std::ostream &out, const std::string &prefix=std::string()) const
	print method that outputs a key/value type format adding prefix to keys. More...
void	setEntry (const ossimRpfFrameEntry &entry, long row, long col)
bool	getEntry (long row, long col, ossimRpfFrameEntry &result) const
ossimString	getProductType () const
ossim_uint32	getNumberOfFramesHorizontal () const
ossim_uint32	getNumberOfFramesVertical () const
ossim_uint32	getNumberOfLines () const
ossim_uint32	getNumberOfSamples () const
ossim_uint32	getNumberOfBands () const
void	getBoundingRect (ossimIrect &rect) const
	Get the bounding rect of entry. More...
const ossimRpfBoundaryRectRecord &	getBoundaryInformation () const
bool	isEmpty () const
ossimRefPtr< ossimImageGeometry >	getImageGeometry () const
	Returns the image geometry object associated with this tile source or NULL if non defined. More...
void	getDecimalDegreesPerPixel (ossimDpt &scale) const
	Get the scale in decimal degrees per pixel. More...
void	getMetersPerPixel (ossimDpt &scale) const
	Get the scale in meters per pixel. More...

Private Member Functions
void	allocateFrameEntryArray ()

Private Attributes
ossimRpfBoundaryRectRecord	theBoundaryInformation
ossim_uint32	theNumSamples
std::vector< std::vector< ossimRpfFrameEntry > >	theFrameEntryArray
	May be less than actual image width in case of > 360 deg wrap condition. (OLK 10/10) More...

Friends
std::ostream &	operator<< (std::ostream &out, const ossimRpfTocEntry &data)

Detailed Description

Definition at line 27 of file ossimRpfTocEntry.h.

Constructor & Destructor Documentation

ossimRpfTocEntry()

ossimRpfTocEntry::ossimRpfTocEntry

(

)

Definition at line 32 of file ossimRpfTocEntry.cpp.

{
   
}

Member Function Documentation

allocateFrameEntryArray()

void ossimRpfTocEntry::allocateFrameEntryArray ( )

private

Definition at line 270 of file ossimRpfTocEntry.cpp.

References ossimRpfBoundaryRectRecord::getNumberOfFramesHorizontal(), ossimRpfBoundaryRectRecord::getNumberOfFramesVertical(), theBoundaryInformation, and theFrameEntryArray.

Referenced by parseStream().

{
   theFrameEntryArray.resize(theBoundaryInformation.getNumberOfFramesVertical());
   ossim_uint32 horizontalSize = theBoundaryInformation.getNumberOfFramesHorizontal();

   for(ossim_uint32 index = 0; index < theFrameEntryArray.size(); index++)
   {
      theFrameEntryArray[index].resize(horizontalSize);
   }
}

getBoundaryInformation()

const ossimRpfBoundaryRectRecord & ossimRpfTocEntry::getBoundaryInformation

(

)

const

Definition at line 122 of file ossimRpfTocEntry.cpp.

References theBoundaryInformation.

Referenced by ossimCibCadrgTileSource::getProductEntryList(), ossimCibCadrgTileSource::getProductScale(), ossimCibCadrgTileSource::getProductScaleList(), and ossimCibCadrgTileSource::setEntryToRender().

{
   return theBoundaryInformation;
}

getBoundingRect()

void ossimRpfTocEntry::getBoundingRect

(

ossimIrect &

rect

)

const

Get the bounding rect of entry.

Parameters

rect	Gets initialized with rect.

Definition at line 117 of file ossimRpfTocEntry.cpp.

References getNumberOfLines(), and getNumberOfSamples().

{
   rect = ossimIrect(0, 0, getNumberOfSamples()-1, getNumberOfLines()-1); 
}

getDecimalDegreesPerPixel()

void ossimRpfTocEntry::getDecimalDegreesPerPixel

(

ossimDpt &

scale

)

const

Get the scale in decimal degrees per pixel.

Definition at line 247 of file ossimRpfTocEntry.cpp.

References ossimRpfBoundaryRectRecord::getCoverage(), ossimRpfCoverageSection::getHorizontalInterval(), ossimRpfCoverageSection::getLrLat(), getNumberOfLines(), getNumberOfSamples(), ossimRpfCoverageSection::getUlLat(), ossimRpfCoverageSection::getUlLon(), ossimRpfCoverageSection::getUrLon(), ossimRpfCoverageSection::getVerticalInterval(), theBoundaryInformation, ossimDpt::x, and ossimDpt::y.

Referenced by getImageGeometry(), and parseStream().

{
#if 1
   scale.x = theBoundaryInformation.getCoverage().getHorizontalInterval();
   scale.y = theBoundaryInformation.getCoverage().getVerticalInterval();
#else
   ossim_float64 ulLat = theBoundaryInformation.getCoverage().getUlLat();
   ossim_float64 ulLon = theBoundaryInformation.getCoverage().getUlLon();
   ossim_float64 urLon = theBoundaryInformation.getCoverage().getUrLon();
   ossim_float64 llLat = theBoundaryInformation.getCoverage().getLrLat();
   ossim_float64 lines = getNumberOfLines();
   ossim_float64 samps = getNumberOfSamples();
   scale.x = (urLon - ulLon) / samps;
   scale.y = (ulLat - llLat) / lines;
#endif
}

getEntry()

bool ossimRpfTocEntry::getEntry	(	long	row,
		long	col,
		ossimRpfFrameEntry &	result
	)		const

Definition at line 140 of file ossimRpfTocEntry.cpp.

References theFrameEntryArray.

Referenced by ossimRpfToc::getFirstEntry(), ossimCibCadrgTileSource::getIntersectingEntries(), ossimRpfToc::getRpfFrameEntry(), ossimCibCadrgTileSource::populateLut(), and ossimCibCadrgTileSource::updatePropertiesToFirstValidFrame().

{
   if(row < (long)theFrameEntryArray.size() && row >= 0)
   {
      if(col < (long)theFrameEntryArray[row].size() && col >= 0)
      {
         result = theFrameEntryArray[row][col];
      }
      else
      {
         return false;
      }
   }
   else
   {
      return false;
   }
   
   return true;
}

getImageGeometry()

ossimRefPtr< ossimImageGeometry > ossimRpfTocEntry::getImageGeometry

(

)

const

Returns the image geometry object associated with this tile source or NULL if non defined.

The geometry contains full-to-local image transform as well as projection (image-to-world).

Definition at line 194 of file ossimRpfTocEntry.cpp.

References ossimRefPtr< T >::get(), ossimRpfBoundaryRectRecord::getCoverage(), getDecimalDegreesPerPixel(), ossimRpfCoverageSection::getLlLat(), ossimRpfCoverageSection::getUlLat(), ossimRpfCoverageSection::getUlLon(), ossimRpfBoundaryRectRecord::getZone(), ossimGpt::lon, ossimMapProjection::setDecimalDegreesPerPixel(), ossimMapProjection::setOrigin(), ossimImageGeometry::setProjection(), ossimMapProjection::setUlTiePoints(), and theBoundaryInformation.

Referenced by ossimCibCadrgTileSource::getImageGeometry().

{

   ossimGpt ul(theBoundaryInformation.getCoverage().getUlLat(), 
               theBoundaryInformation.getCoverage().getUlLon());

   // Decimal degrees per pixel:
   ossimDpt ddpp;
   getDecimalDegreesPerPixel(ddpp);
   
   // Tie point - Shifted to pixel-is-point:
   ossimGpt tie( (ul.latd() - (ddpp.y/2.0)), (ul.lond() + (ddpp.x/2.0)), 0.0 );
   
   // Origin - Use the center latitude for horizontal scale, and the left edge as origin longitude
   // (OLK 10/10)
   ossimGpt origin ((ul.lat + theBoundaryInformation.getCoverage().getLlLat())/2.0, tie.lon);

#if 0 /* Please leave for debug. (drb) */
   std::cout << "boundaryInfo:\n" << boundaryInfo << std::endl;
#endif

   int z = theBoundaryInformation.getZone();
   
   if (z == 74) z--; // Fix J to a zone.
   if (z > 64) z -= 64; // Below the equator
   else z -= 48; // Above the equator

   ossimRefPtr<ossimMapProjection> mapProj = 0;
   if ( z != 9 )
   {
      mapProj = new ossimEquDistCylProjection;
   }
   else
   {
      mapProj = new ossimAzimEquDistProjection;
   }

   // Set the origin:
   mapProj->setOrigin(origin);
   
   // Set the scale:
   mapProj->setDecimalDegreesPerPixel(ddpp);

   // Set the tie:
   mapProj->setUlTiePoints(tie);

   // Give projection to the geometry object.
   ossimRefPtr<ossimImageGeometry> geom =  new ossimImageGeometry;
   geom->setProjection( mapProj.get() );

   return geom;
}

getMetersPerPixel()

void ossimRpfTocEntry::getMetersPerPixel

(

ossimDpt &

scale

)

const

Get the scale in meters per pixel.

Definition at line 264 of file ossimRpfTocEntry.cpp.

References ossimRpfBoundaryRectRecord::getCoverage(), ossimRpfCoverageSection::getHorizontalResolution(), ossimRpfCoverageSection::getVerticalResolution(), theBoundaryInformation, ossimDpt::x, and ossimDpt::y.

{
   scale.x = theBoundaryInformation.getCoverage().getVerticalResolution();
   scale.y = theBoundaryInformation.getCoverage().getHorizontalResolution();
}

getNumberOfBands()

ossim_uint32 ossimRpfTocEntry::getNumberOfBands

(

)

const

Returns

Number of bands.

Definition at line 102 of file ossimRpfTocEntry.cpp.

References getProductType(), ossimString::trim(), and ossimString::upcase().

{
   ossim_uint32 result = 0;
   ossimString productType = getProductType().trim().upcase();
   if( productType == "CIB" )
   {
      result = 1;
   }
   else if ( productType == "CADRG" )
   {
      result = 3;
   }
   return result;
}

getNumberOfFramesHorizontal()

ossim_uint32 ossimRpfTocEntry::getNumberOfFramesHorizontal

(

)

const

returns how many subimges or frames exist in the horizontal direction.

Definition at line 82 of file ossimRpfTocEntry.cpp.

References ossimRpfBoundaryRectRecord::getNumberOfFramesHorizontal(), and theBoundaryInformation.

Referenced by ossimRpfToc::getFirstEntry(), ossimRpfToc::getNumberOfFramesHorizontal(), ossimCibCadrgTileSource::populateLut(), and ossimCibCadrgTileSource::updatePropertiesToFirstValidFrame().

{
   return theBoundaryInformation.getNumberOfFramesHorizontal();
}

getNumberOfFramesVertical()

ossim_uint32 ossimRpfTocEntry::getNumberOfFramesVertical

(

)

const

returns how many subimges or frames exist in the vertical direction.

Definition at line 87 of file ossimRpfTocEntry.cpp.

References ossimRpfBoundaryRectRecord::getNumberOfFramesVertical(), and theBoundaryInformation.

Referenced by ossimRpfToc::getFirstEntry(), ossimCibCadrgTileSource::getIntersectingEntries(), ossimRpfToc::getNumberOfFramesVertical(), ossimCibCadrgTileSource::populateLut(), and ossimCibCadrgTileSource::updatePropertiesToFirstValidFrame().

{
   return theBoundaryInformation.getNumberOfFramesVertical();
}

getNumberOfLines()

ossim_uint32 ossimRpfTocEntry::getNumberOfLines

(

)

const

Returns

The number of lines (frames vertical * 1536).

Definition at line 92 of file ossimRpfTocEntry.cpp.

References ossimRpfBoundaryRectRecord::getNumberOfFramesVertical(), and theBoundaryInformation.

Referenced by getBoundingRect(), getDecimalDegreesPerPixel(), and ossimCibCadrgTileSource::setTocEntryToRender().

{
   return  theBoundaryInformation.getNumberOfFramesVertical() * 1536;
}

getNumberOfSamples()

ossim_uint32 ossimRpfTocEntry::getNumberOfSamples

(

)

const

Returns

The number of samples (frames horizontal * 1536).

Definition at line 97 of file ossimRpfTocEntry.cpp.

References theNumSamples.

Referenced by getBoundingRect(), getDecimalDegreesPerPixel(), and ossimCibCadrgTileSource::setTocEntryToRender().

{
   return theNumSamples;
}

getProductType()

ossimString ossimRpfTocEntry::getProductType

(

)

const

Definition at line 163 of file ossimRpfTocEntry.cpp.

References ossimRpfBoundaryRectRecord::getProductType(), and theBoundaryInformation.

Referenced by getNumberOfBands(), and ossimCibCadrgTileSource::setEntryToRender().

{
   return theBoundaryInformation.getProductType();
}

isEmpty()

bool ossimRpfTocEntry::isEmpty

(

)

const

If there is an entry and all the files don't exist we will return true.

Definition at line 172 of file ossimRpfTocEntry.cpp.

References size, and theFrameEntryArray.

Referenced by ossimCibCadrgTileSource::getProductEntryList().

{
   long rows = (long)theFrameEntryArray.size();
   long cols = 0;
   if(rows > 0)
   {
      cols = (long)theFrameEntryArray[0].size();
      for(long rowIndex = 0; rowIndex < rows; ++ rowIndex)
      {
         for(long colIndex = 0; colIndex < cols; ++colIndex)
         {
            if(theFrameEntryArray[rowIndex][colIndex].exists())
            {
               return false;
            }
         }
      }
   }

   return true;
}

parseStream()

ossimErrorCode ossimRpfTocEntry::parseStream	(	std::istream &	in,
		ossimByteOrder	byteOrder
	)

Definition at line 37 of file ossimRpfTocEntry.cpp.

References allocateFrameEntryArray(), ossim::byteOrder(), getDecimalDegreesPerPixel(), ossimRpfBoundaryRectRecord::getNumberOfFramesHorizontal(), ossimErrorCodes::OSSIM_OK, ossimRpfBoundaryRectRecord::parseStream(), theBoundaryInformation, theNumSamples, and ossimDpt::x.

{
   ossimErrorCode result = ossimErrorCodes::OSSIM_OK;
   
   result = theBoundaryInformation.parseStream(in, byteOrder);
   if(result == ossimErrorCodes::OSSIM_OK)
   {
      allocateFrameEntryArray();
   }

   // Fetch the number of samples as data member since it may need to be adjusted due to 
   // wrap (OLK 10/10):
   theNumSamples =  theBoundaryInformation.getNumberOfFramesHorizontal() * 1536;
   ossimDpt ddpp;
   getDecimalDegreesPerPixel(ddpp);
   ossim_float64 width_in_deg = theNumSamples*ddpp.x;
   if (width_in_deg >= 360.0)
      theNumSamples -= (width_in_deg - 360.0)/ddpp.x;

   return result;
}

print()

std::ostream & ossimRpfTocEntry::print	(	std::ostream &	out,
		const std::string &	prefix = std::string()
	)		const

print method that outputs a key/value type format adding prefix to keys.

Parameters

out	String to output to.
prefix	This will be prepended to key. e.g. Where prefix = "nitf." and key is "file_name" key becomes: "nitf.file_name:"

Returns

output stream.

Definition at line 60 of file ossimRpfTocEntry.cpp.

References ossimRpfBoundaryRectRecord::print(), theBoundaryInformation, and theFrameEntryArray.

Referenced by operator<<().

{
   theBoundaryInformation.print(out, prefix);

   std::vector< std::vector<ossimRpfFrameEntry> >::const_iterator frameEntry =
      theFrameEntryArray.begin();

   while( frameEntry != theFrameEntryArray.end() )
   {
      std::vector<ossimRpfFrameEntry>::const_iterator i =
         (*frameEntry).begin();
      while ( i != (*frameEntry).end() ) 
      {
         (*i).print(out, prefix);
         ++i;
      }
      ++frameEntry;
   }
   return out;
}

setEntry()

void ossimRpfTocEntry::setEntry	(	const ossimRpfFrameEntry &	entry,
		long	row,
		long	col
	)

Definition at line 127 of file ossimRpfTocEntry.cpp.

References theFrameEntryArray.

{
   if(row < (long)theFrameEntryArray.size() && row >= 0)
   {
      if(col < (long)theFrameEntryArray[row].size() && col >= 0)
      {
         theFrameEntryArray[row][col] = entry;
      }
   }
}

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  out, const ossimRpfTocEntry &  data  )

friend

Definition at line 25 of file ossimRpfTocEntry.cpp.

{
   data.print(out);
   return out;
}

Member Data Documentation

theBoundaryInformation

ossimRpfBoundaryRectRecord ossimRpfTocEntry::theBoundaryInformation

private

Definition at line 108 of file ossimRpfTocEntry.h.

Referenced by allocateFrameEntryArray(), getBoundaryInformation(), getDecimalDegreesPerPixel(), getImageGeometry(), getMetersPerPixel(), getNumberOfFramesHorizontal(), getNumberOfFramesVertical(), getNumberOfLines(), getProductType(), parseStream(), and print().

theFrameEntryArray

std::vector< std::vector<ossimRpfFrameEntry> > ossimRpfTocEntry::theFrameEntryArray

private

May be less than actual image width in case of > 360 deg wrap condition. (OLK 10/10)

Definition at line 110 of file ossimRpfTocEntry.h.

Referenced by allocateFrameEntryArray(), getEntry(), isEmpty(), print(), and setEntry().

theNumSamples

ossim_uint32 ossimRpfTocEntry::theNumSamples

private

Definition at line 109 of file ossimRpfTocEntry.h.

Referenced by getNumberOfSamples(), and parseStream().

---

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

• ossimRpfTocEntry.h
• ossimRpfTocEntry.cpp