ossimGeneralRasterInfo Class Reference

#include <ossimGeneralRasterInfo.h>

Inheritance diagram for ossimGeneralRasterInfo:

Public Types
enum	ossimFillMode { NONE, ZEROES_TO_MIN, ZEROES_TO_NULL_EDGES_ONLY }
enum	{ UNKNOWN = -1 }

Public Member Functions
	ossimGeneralRasterInfo ()
	ossimGeneralRasterInfo (const std::vector< ossimFilename > &imageFileList, ossimScalarType pixelType, ossimInterleaveType il_type, ossim_int32 numberOfBands, ossim_int32 lines, ossim_int32 samples, ossim_int32 headerSize, ossimFillMode nullsMode, ossim_int32 pixelsToChop)
	ossimGeneralRasterInfo (const ossimKeywordlist &kwl, const char *prefix=0)
	ossimGeneralRasterInfo (const ossimGeneralRasterInfo &obj)
const ossimGeneralRasterInfo &	operator= (const ossimGeneralRasterInfo &rhs)
	Assignment operator=. More...
virtual	~ossimGeneralRasterInfo ()
const ossimIrect &	imageRect () const
	Zero based rectangle of the valid image. More...
const ossimIrect &	validImageRect () const
	Returns the rectangle of where the image is within the raster file. More...
const ossimIrect &	rawImageRect () const
	Zero based rectangle of the raw image. More...
const ossimIpt &	subImageOffset () const
	Returns the offset of this image's origin to a full-image's origin, in the case where this image is a sub-image of a larger full-image. More...
ossim_int32	headerSize () const
	Returns the size of header in bytes. More...
ossim_uint32	fillToNullsMode () const
	Returns the fill mode. More...
void	setFillToNullsMode (ossim_uint32 mode)
	Sets theSetNullsMode. More...
ossim_int32	numberOfBands () const
	Number of bands. More...
ossim_int32	bytesPerPixel () const
	Bytes per pixel. More...
ossim_int32	pixelsToChop () const
	Returns the number of pixels from the edge of a line to set to the fill value. More...
ossimInterleaveType	interleaveType () const
	Enumerated in InterleaveTypeLUT. More...
ossim_int32	validLines () const
	Returns the number of lines within "theValidImageRect". More...
ossim_int32	rawLines () const
	Returns the number of lines within "theRawImageRect". More...
ossim_int32	bytesPerRawLine () const
	Returns the number of bytes in a raw line. More...
ossim_int32	bytesPerValidLine () const
	Returns the number of bytes in a valid line. More...
ossim_int32	validSamples () const
	Returns the number of samples within "theValidImageRect". More...
ossim_int32	rawSamples () const
	Returns the number of samples within "theRawImageRect". More...
std::streamoff	offsetToFirstValidSample () const
	Returns the offset in bytes to the first valid sample in the image. More...
const std::vector< ossimFilename > &	getImageFileList () const
void	setImageFileList (const std::vector< ossimFilename > &list)
void	setImageFile (const ossimFilename &file)
	Sets the image file list to file. More...
void	setHeaderSize (ossim_int32 headerSize)
void	setInterleaveType (ossimInterleaveType il_type)
virtual std::ostream &	print (std::ostream &out) const
	Generic print method. More...
void	setImageRect (const ossimIrect &imageRect)
void	setValidImageRect (const ossimIrect &imageRect)
void	setRawImageRect (const ossimIrect &imageRect)
void	setSubImageOffset (const ossimIpt &d)
ossimByteOrder	getImageDataByteOrder () const
void	setImageDataByteOrder (ossimByteOrder byteOrder)
virtual bool	saveState (ossimKeywordlist &kwl, const char *prefix=0) const
	Method to save the state of an object to a keyword list. More...
virtual bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)
	Method to the load (recreate) the state of an object from a keyword list. More...
bool	open (const ossimFilename &imageFile)
	Takes image file and attempts to derive/find header file to parse for general raster data, i.e. More...
const ossimImageMetaData &	getImageMetaData () const
ossimImageMetaData &	getImageMetaData ()
bool	initializeFromEnviHdr (const ossimEnviHeader &enviHdr)
	Initialize from envi header file. More...
Public Member Functions inherited from ossimObject
	ossimObject ()
virtual	~ossimObject ()
virtual ossimObject *	dup () const
virtual ossimString	getShortName () const
virtual ossimString	getLongName () const
virtual ossimString	getDescription () const
virtual ossimString	getClassName () const
virtual RTTItypeid	getType () const
virtual bool	canCastTo (ossimObject *obj) const
virtual bool	canCastTo (const RTTItypeid &id) const
virtual bool	canCastTo (const ossimString &parentClassName) const
virtual bool	isEqualTo (const ossimObject &obj, ossimCompareType compareType=OSSIM_COMPARE_FULL) const
virtual void	accept (ossimVisitor &visitor)
Public Member Functions inherited from ossimReferenced
	ossimReferenced ()
	ossimReferenced (const ossimReferenced &)
ossimReferenced &	operator= (const ossimReferenced &)
void	ref () const
	increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
void	unref () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
void	unref_nodelete () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...
int	referenceCount () const

Private Member Functions
bool	initializeFromHdr (const ossimFilename &imageFile, const ossimFilename &headerFile)
	Initialize from header file. More...
bool	initializeFromEnviHdr (const ossimFilename &headerFile)
	Initialize from envi header file. More...
bool	initializeFromXml (const ossimFilename &imageFile, const ossimFilename &headerFile)
	Initialize from omd file. More...
ossim_int32	getBitsPerPixel (const ossimFilename &imageFile) const
	Private method to get bits per pixel from file size, lines, samples and bands. More...
void	clear ()
	Clears data members. More...

Private Attributes
ossimImageMetaData	theMetaData
std::vector< ossimFilename >	theImageFileList
ossimInterleaveType	theInterleaveType
ossimIrect	theRawImageRect
	The zero based rectangle of the entire image not including any header. More...
ossimIrect	theValidImageRect
	The rectangle representing where the valid part of the image lies within "theRawImageRect". More...
ossimIrect	theImageRect
	The valid image rectangle normalized to be zero based. More...
ossimIpt	theSubImageOffset
	The offset from the full-image origin to this image's origin. More...
ossim_int32	theHeaderSize
	Size of header in bytes. More...
ossimFillMode	theSetNullsMode
	Mode of how to handle pixels on import. More...
ossim_int32	thePixelsToChop
	Amount of pixels to chop for each line edge. More...
ossimByteOrder	theImageDataByteOrder
	The byte order the image data is stored in. More...

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

Detailed Description

Definition at line 39 of file ossimGeneralRasterInfo.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
UNKNOWN

Definition at line 50 of file ossimGeneralRasterInfo.h.

   {
      UNKNOWN = -1
   };

ossimFillMode

enum ossimGeneralRasterInfo::ossimFillMode

Enumerator
NONE
ZEROES_TO_MIN
ZEROES_TO_NULL_EDGES_ONLY

Definition at line 43 of file ossimGeneralRasterInfo.h.

   {
      NONE,
      ZEROES_TO_MIN,
      ZEROES_TO_NULL_EDGES_ONLY
   };

Constructor & Destructor Documentation

ossimGeneralRasterInfo() [1/4]

ossimGeneralRasterInfo::ossimGeneralRasterInfo

(

)

Definition at line 81 of file ossimGeneralRasterInfo.cpp.

References ossimIrect::makeNan(), theImageRect, theRawImageRect, and theValidImageRect.

   :
   theMetaData(),
   theImageFileList(),
   theInterleaveType(OSSIM_BIL),
   theRawImageRect(),
   theValidImageRect(),
   theImageRect(),
   theSubImageOffset(0,0),
   theHeaderSize(0),
   theSetNullsMode(NONE),
   thePixelsToChop(0),
   theImageDataByteOrder(OSSIM_LITTLE_ENDIAN)
{
   theRawImageRect.makeNan();
   theValidImageRect.makeNan();
   theImageRect.makeNan();
}

ossimGeneralRasterInfo() [2/4]

ossimGeneralRasterInfo::ossimGeneralRasterInfo	(	const std::vector< ossimFilename > &	imageFileList,
		ossimScalarType	pixelType,
		ossimInterleaveType	il_type,
		ossim_int32	numberOfBands,
		ossim_int32	lines,
		ossim_int32	samples,
		ossim_int32	headerSize,
		ossimFillMode	nullsMode,
		ossim_int32	pixelsToChop
	)

Definition at line 100 of file ossimGeneralRasterInfo.cpp.

References ossimIrect::set_lrx(), ossimIrect::set_lry(), theImageRect, theRawImageRect, and theValidImageRect.

   :
   theMetaData(pixelType, numberOfBands),
   theImageFileList(imageFileList),
   theInterleaveType(il_type),
   theRawImageRect(0,0,0,0),
   theValidImageRect(0,0,0,0),
   theImageRect(0,0,0,0),
   theSubImageOffset(0,0),
   theHeaderSize(headerSize),
   theSetNullsMode(nullsMode),
   thePixelsToChop(pixelsToChop),
   theImageDataByteOrder(OSSIM_LITTLE_ENDIAN)
{
   theRawImageRect.set_lry(lines - 1);
   theRawImageRect.set_lrx(samples - 1);
   theValidImageRect = theRawImageRect;
   theImageRect = theRawImageRect;
}

ossimGeneralRasterInfo() [3/4]

ossimGeneralRasterInfo::ossimGeneralRasterInfo	(	const ossimKeywordlist &	kwl,
		const char *	prefix = 0
	)

Definition at line 128 of file ossimGeneralRasterInfo.cpp.

References loadState(), ossimIrect::makeNan(), theImageRect, theRawImageRect, and theValidImageRect.

   :
   theImageFileList(),
   theInterleaveType(OSSIM_BIL),
   theRawImageRect(0,0,0,0),
   theValidImageRect(0,0,0,0),
   theImageRect(0,0,0,0),
   theSubImageOffset(0,0),
   theHeaderSize(0),
   theSetNullsMode(NONE),
   thePixelsToChop(0),
   theImageDataByteOrder(OSSIM_LITTLE_ENDIAN)
{
   theRawImageRect.makeNan();
   theValidImageRect.makeNan();
   theImageRect.makeNan();
   
   loadState(kwl, prefix);
}

ossimGeneralRasterInfo() [4/4]

ossimGeneralRasterInfo::ossimGeneralRasterInfo

(

const ossimGeneralRasterInfo &

obj

)

Definition at line 149 of file ossimGeneralRasterInfo.cpp.

   :
   theMetaData           ( obj.theMetaData ),
   theImageFileList      ( obj.theImageFileList ),
   theInterleaveType     ( obj.theInterleaveType ),
   theRawImageRect       ( obj.theRawImageRect ),
   theValidImageRect     ( obj.theValidImageRect ),
   theImageRect          ( obj.theImageRect ),
   theSubImageOffset     ( obj.theSubImageOffset ),
   theHeaderSize         ( obj.theHeaderSize ),
   theSetNullsMode       ( obj.theSetNullsMode ),
   thePixelsToChop       ( obj.thePixelsToChop ),
   theImageDataByteOrder ( obj.theImageDataByteOrder )
{
}

~ossimGeneralRasterInfo()

ossimGeneralRasterInfo::~ossimGeneralRasterInfo ( )

virtual

Definition at line 185 of file ossimGeneralRasterInfo.cpp.

{
}

Member Function Documentation

bytesPerPixel()

ossim_int32 ossimGeneralRasterInfo::bytesPerPixel ( ) const

inline

Bytes per pixel.

Inlined below.

Returns

Bytes per pixel from theMetaData class member cast to an int32.

Definition at line 360 of file ossimGeneralRasterInfo.h.

References ossimImageMetaData::getBytesPerPixel(), and theMetaData.

Referenced by bytesPerRawLine(), bytesPerValidLine(), and offsetToFirstValidSample().

{
   return static_cast<ossim_int32>( theMetaData.getBytesPerPixel() );
}

bytesPerRawLine()

ossim_int32 ossimGeneralRasterInfo::bytesPerRawLine ( ) const

inline

Returns the number of bytes in a raw line.

Definition at line 375 of file ossimGeneralRasterInfo.h.

References bytesPerPixel(), interleaveType(), numberOfBands(), OSSIM_BIP, and rawSamples().

Referenced by offsetToFirstValidSample(), and ossimGeneralRasterElevHandler::setFilename().

{
   if (interleaveType() == OSSIM_BIP)
   {
      return rawSamples() * bytesPerPixel() * numberOfBands();
   }
   else
   {
      return rawSamples() * bytesPerPixel();
   }
}

bytesPerValidLine()

ossim_int32 ossimGeneralRasterInfo::bytesPerValidLine ( ) const

inline

Returns the number of bytes in a valid line.

Definition at line 387 of file ossimGeneralRasterInfo.h.

References bytesPerPixel(), interleaveType(), numberOfBands(), OSSIM_BIP, and validSamples().

{
   if (interleaveType() == OSSIM_BIP)
   {
      return validSamples() * bytesPerPixel() * numberOfBands();
   }
   else
   {
      return validSamples() * bytesPerPixel();
   }
}

clear()

void ossimGeneralRasterInfo::clear ( )

private

Clears data members.

Definition at line 189 of file ossimGeneralRasterInfo.cpp.

References ossimImageMetaData::clear(), ossimIrect::makeNan(), NONE, OSSIM_BIL, OSSIM_LITTLE_ENDIAN, theHeaderSize, theImageDataByteOrder, theImageFileList, theImageRect, theInterleaveType, theMetaData, thePixelsToChop, theRawImageRect, theSetNullsMode, theSubImageOffset, theValidImageRect, ossimIpt::x, and ossimIpt::y.

{
   theMetaData.clear();
   theImageFileList.clear();
   theInterleaveType = OSSIM_BIL;
   theRawImageRect.makeNan();
   theValidImageRect.makeNan();
   theImageRect.makeNan();
   theSubImageOffset.x = 0;
   theSubImageOffset.y = 0;
   theHeaderSize = 0;
   theSetNullsMode = NONE;
   thePixelsToChop = 0;
   theImageDataByteOrder = OSSIM_LITTLE_ENDIAN;
}

fillToNullsMode()

ossim_uint32 ossimGeneralRasterInfo::fillToNullsMode

(

)

const

Returns the fill mode.

This is used to flip values on ingest. Valid Mode Enumerations:

• 0 Do nothing to the pixels on ingest.
• 1 Flip all zeroes to the minimum pixel value.
• 2 Flip zeroes within the image line to minimum pixel value. This is used by edge walking code.

Definition at line 230 of file ossimGeneralRasterInfo.cpp.

References theSetNullsMode.

{
   return theSetNullsMode;
}

getBitsPerPixel()

ossim_int32 ossimGeneralRasterInfo::getBitsPerPixel ( const ossimFilename &  imageFile ) const

private

Private method to get bits per pixel from file size, lines, samples and bands.

Method created to avoid duplicate code in "initizeFrom" methods.

This assumes that "theRawImageRect" and "theNumberOfBands" has been set.

Parameters

imageFile	This image file.
Calculated	bits per pixel.

Returns

bits per pixel or 0 on error.

Definition at line 1285 of file ossimGeneralRasterInfo.cpp.

References numberOfBands(), ossimString::size(), ossimIrect::size(), theRawImageRect, ossimIpt::x, and ossimIpt::y.

Referenced by initializeFromHdr().

{
   // Note currently does not consider header size.
   ossim_int32 result = 0;
   
   ossim_int64 fileSize = imageFile.size();
   ossimIpt rectSize = theRawImageRect.size();
   if ( fileSize && rectSize.x && rectSize.y && numberOfBands() )
   {
      result = ( fileSize / rectSize.x / rectSize.y / numberOfBands() ) * 8;
   }
   return result;
}

getImageDataByteOrder()

ossimByteOrder ossimGeneralRasterInfo::getImageDataByteOrder

(

)

const

Definition at line 324 of file ossimGeneralRasterInfo.cpp.

References theImageDataByteOrder.

Referenced by ossimGeneralRasterElevHandler::setFilename().

{
   return theImageDataByteOrder;
}  

getImageFileList()

const std::vector< ossimFilename > & ossimGeneralRasterInfo::getImageFileList

(

)

const

Definition at line 273 of file ossimGeneralRasterInfo.cpp.

References theImageFileList.

{
   return theImageFileList;
}

getImageMetaData() [1/2]

const ossimImageMetaData & ossimGeneralRasterInfo::getImageMetaData ( ) const

inline

Returns

Const reference to theMetaData class member.

Definition at line 345 of file ossimGeneralRasterInfo.h.

References theMetaData.

Referenced by ossimGeneralRasterTileSource::allocateBuffer(), ossimGeneralRasterTileSource::allocateTile(), ossimGeneralRasterTileSource::getNumberOfInputBands(), ossimGeneralRasterTileSource::getNumberOfOutputBands(), ossimERSTileSource::open(), and ossimGeneralRasterElevHandler::setFilename().

{
   return theMetaData;
}

getImageMetaData() [2/2]

ossimImageMetaData & ossimGeneralRasterInfo::getImageMetaData ( )

inline

Returns

Reference to theMetaData class member.

Definition at line 350 of file ossimGeneralRasterInfo.h.

References theMetaData.

{
   return theMetaData;
}

headerSize()

ossim_int32 ossimGeneralRasterInfo::headerSize

(

)

const

Returns the size of header in bytes.

Definition at line 225 of file ossimGeneralRasterInfo.cpp.

References theHeaderSize.

Referenced by offsetToFirstValidSample(), and setHeaderSize().

{
   return theHeaderSize;
}

imageRect()

const ossimIrect & ossimGeneralRasterInfo::imageRect

(

)

const

Zero based rectangle of the valid image.

Definition at line 205 of file ossimGeneralRasterInfo.cpp.

References theImageRect.

Referenced by ossimGeneralRasterElevHandler::setFilename(), setImageRect(), setRawImageRect(), and setValidImageRect().

{
   return theImageRect;
}

initializeFromEnviHdr() [1/2]

bool ossimGeneralRasterInfo::initializeFromEnviHdr

(

const ossimEnviHeader &

enviHdr

)

Initialize from envi header file.

Parameters

enviHeader

Returns

true on success, false on error.

Definition at line 1098 of file ossimGeneralRasterInfo.cpp.

References ossimImageMetaData::clear(), ossimEnviHeader::getBands(), ossimEnviHeader::getByteOrder(), ossimEnviHeader::getHeaderOffset(), ossimEnviHeader::getLines(), ossimEnviHeader::getOssimInterleaveType(), ossimEnviHeader::getOssimScalarType(), ossimEnviHeader::getSamples(), ossimEnviHeader::getXStart(), ossimEnviHeader::getYStart(), NONE, OSSIM_INTERLEAVE_UNKNOWN, OSSIM_SCALAR_UNKNOWN, ossimImageMetaData::setNumberOfBands(), ossimImageMetaData::setScalarType(), theHeaderSize, theImageDataByteOrder, theImageFileList, theImageRect, theInterleaveType, theMetaData, thePixelsToChop, theRawImageRect, theSetNullsMode, theSubImageOffset, theValidImageRect, ossimIpt::x, and ossimIpt::y.

Referenced by initializeFromEnviHdr().

{
   bool result = false;

   while( 1 ) 
   {
      //---
      // Go through the data members in order.
      // If a required item is not found break from loop.
      //--
      theMetaData.clear();
      
      // scalar ( required ) :
      if( enviHdr.getOssimScalarType() != OSSIM_SCALAR_UNKNOWN )
      {
         theMetaData.setScalarType( enviHdr.getOssimScalarType() );
      }
      else
      {
         break;
      }
      
      theImageFileList.clear();
      
      // interleave ( required ):
      theInterleaveType = enviHdr.getOssimInterleaveType();
      if ( theInterleaveType == OSSIM_INTERLEAVE_UNKNOWN )
      {
         break;
      }
      
      // bands ( required ):
      if ( !enviHdr.getBands() )
      {
         break;
      }
      theMetaData.setNumberOfBands( enviHdr.getBands() );
      
      // lines ( required ):
      ossim_uint32 lines = enviHdr.getLines();
      if ( !lines )
      {
         break;
      }
      
      // samples ( required ):
      ossim_uint32 samples = enviHdr.getSamples();
      if ( !samples )
      {
         break;
      }
      
      // Set the rectangles:
      theRawImageRect   = ossimIrect( 0, 0, samples - 1, lines - 1 );
      theValidImageRect = theRawImageRect;
      theImageRect      = theRawImageRect;         

      // sample start ( not required ):
      theSubImageOffset.x = enviHdr.getXStart();
      
      // line start ( not required ):
      theSubImageOffset.y = enviHdr.getYStart();
      
      // header offset ( not required ):
      theHeaderSize = enviHdr.getHeaderOffset();
      
      // null mode:
      theSetNullsMode = ossimGeneralRasterInfo::NONE;
      
      // pixels to chop:
      thePixelsToChop = 0; 
      
      // Byte order, this will be system if not found.
      theImageDataByteOrder = enviHdr.getByteOrder();
      
      result = true;
      break; // Trailing break to get out.
   }
   return result;
   
} // End: ossimGeneralRasterInfo::initializeFromEnviHdr( const ossimEnviHeader& )

initializeFromEnviHdr() [2/2]

bool ossimGeneralRasterInfo::initializeFromEnviHdr ( const ossimFilename &  headerFile )

private

Initialize from envi header file.

Parameters

headerFile

Returns

true on success, false on error.

Definition at line 1087 of file ossimGeneralRasterInfo.cpp.

References initializeFromEnviHdr(), and ossimEnviHeader::open().

{
   bool result = false;
   ossimEnviHeader hdr;
   if( hdr.open( headerFile ) )
   {
      result = initializeFromEnviHdr( hdr );
   }
   return result;
}

initializeFromHdr()

bool ossimGeneralRasterInfo::initializeFromHdr ( const ossimFilename &  imageFile, const ossimFilename &  headerFile  )

private

Initialize from header file.

Parameters

headerFile

Returns

true on success, false on error.

Definition at line 882 of file ossimGeneralRasterInfo.cpp.

References ossimKeywordlist::addFile(), ossim::byteOrder(), ossimKeywordlist::change_delimiter(), ossimImageMetaData::clear(), ossimKeywordlist::downcaseKeywords(), ossimString::empty(), ossimKeywordlist::findKey(), getBitsPerPixel(), ossimLookUpTable::getEntryNumber(), ossimImageMetaData::getNumberOfBands(), NONE, ossimLookUpTable::NOT_FOUND, OSSIM_BIG_ENDIAN, OSSIM_BIL, OSSIM_FLOAT32, OSSIM_LITTLE_ENDIAN, OSSIM_SINT16, OSSIM_SINT32, OSSIM_UINT16, OSSIM_UINT32, OSSIM_UINT8, ossimImageMetaData::setNullPix(), ossimImageMetaData::setNullValuesValid(), ossimImageMetaData::setNumberOfBands(), ossimImageMetaData::setScalarType(), ossimString::size(), ossimString::string(), theHeaderSize, theImageDataByteOrder, theImageFileList, theImageRect, theInterleaveType, theMetaData, thePixelsToChop, theRawImageRect, theSetNullsMode, theSubImageOffset, theValidImageRect, ossimString::toInt32(), ossimString::toUInt32(), true, ossimIpt::x, and ossimIpt::y.

{
   bool result = false;

   ossimKeywordlist kwl;
   char delimeter = ' ';
   kwl.change_delimiter(delimeter);

   if ( kwl.addFile(headerFile) )
   {
      kwl.downcaseKeywords();
      ossimString value;
   
      while( 1 ) 
      {
         //---
         // Go through the data members in order.
         // If a required item is not found break from loop.
         //--
         theMetaData.clear();

         // scalar ( default ) - adjusted below :
         theMetaData.setScalarType( OSSIM_UINT8 );

         // Image file name:
         theImageFileList.clear();
         theImageFileList.push_back( imageFile );
         
         // interleave ( not required - default=BIL)
         theInterleaveType = OSSIM_BIL;
         value.string() = kwl.findKey( std::string("layout") );
         if ( value.size() )
         {
            ossimInterleaveTypeLut lut;
            ossim_int32 intrlv = lut.getEntryNumber( value.string().c_str(), true );
            if ( intrlv != ossimLookUpTable::NOT_FOUND )
            {
               theInterleaveType = static_cast<ossimInterleaveType>(intrlv);
            }
         }

         // bands ( required ):
         ossim_uint32 bands = 0;
         value.string() = kwl.findKey( std::string("nbands") );
         if ( value.size() )
         {
            bands = value.toUInt32();
         }
         if ( !bands )
         {
            break;
         }
         theMetaData.setNumberOfBands( bands );

         // lines ( required ):
         ossim_int32 lines = 0;
         value.string() = kwl.findKey( std::string("nrows") );
         if ( value.size() )
         {
            lines = value.toInt32();
         }
         if ( !lines )
         {
            break;
         }
         
         // samples ( required ):
         ossim_int32 samples = 0;
         value.string() = kwl.findKey( std::string("ncols") );
         if ( value.size() )
         {
            samples = value.toInt32();
         }
         if ( !samples )
         {
            break;
         }

         // nodata or null value ( not required )
         value.string() = kwl.findKey( std::string("nodata") );
         if ( value.empty() )
         {
            value.string() = kwl.findKey( std::string("nodata_value") );
         }
         if ( value.size() )
         {
            ossim_float64 nullValue = value.toUInt32();
            for ( ossim_uint32 band = 0; band < theMetaData.getNumberOfBands(); ++band )
            {
               theMetaData.setNullPix( band, nullValue );
            }
            theMetaData.setNullValuesValid(true);
         }

         // Set the rectangles:
         theRawImageRect   = ossimIrect( 0, 0, samples - 1, lines - 1 );
         theValidImageRect = theRawImageRect;
         theImageRect      = theRawImageRect;         

         // sample start ( not required ):
         theSubImageOffset.x = 0;

         // line start ( not required ):
         theSubImageOffset.y = 0;

         // header offset ( not required ):
         theHeaderSize = 0;

         // null mode:
         theSetNullsMode = ossimGeneralRasterInfo::NONE;

         // pixels to chop:
         thePixelsToChop = 0; 

         // Byte order, ( not required - defaulted to system if not found.
         theImageDataByteOrder = ossim::byteOrder();
         value.string() = kwl.findKey( std::string("byteorder") );
         if ( value.size() )
         {
            ossim_uint32 i = value.toUInt32();
            if ( i == 0 )
            {
               theImageDataByteOrder = OSSIM_LITTLE_ENDIAN;
            }
            else
            {
               theImageDataByteOrder = OSSIM_BIG_ENDIAN;
            }
         }

         // Pixel type used for scalar below:
         std::string pixelType = "N"; // not defined
         value.string() = kwl.findKey( std::string("pixeltype") );
         if ( value.size() )
         {
            pixelType = value.string();
         }
         
         ossim_int32 nbits = -1;
         value.string() = kwl.findKey( std::string("nbits") );
         if ( value.size() )
         {
            nbits = value.toInt32();
         }
         else
         {
            nbits = getBitsPerPixel( imageFile );
         }

         switch( nbits )
         {
            case 8:
            {
               theMetaData.setScalarType( OSSIM_UINT8 );
               break;
            }
            case 16:
            {
               if (pixelType == "S")
               {
                  theMetaData.setScalarType( OSSIM_SINT16 );
               }
               else
               {
                  theMetaData.setScalarType( OSSIM_UINT16 );
               }
               break;
            }
            case 32:
            {
               if( pixelType == "S")
               {
                  theMetaData.setScalarType( OSSIM_SINT32 );
               }
               else if( pixelType == "F")
               {
                  theMetaData.setScalarType( OSSIM_FLOAT32 );
               }
               else
               {
                  theMetaData.setScalarType( OSSIM_UINT32 );
               }
               break;
            }
            default:
            {
               if( (nbits < 8) && (nbits >= 1 ) )
               {
                  theMetaData.setScalarType( OSSIM_UINT8 );
               }
               break;
            }
         }

         result = true;
         break; // Trailing break to get out.
      }
   }

   return result;
   
} // End: ossimGeneralRasterInfo::initializeFromHdr

initializeFromXml()

bool ossimGeneralRasterInfo::initializeFromXml ( const ossimFilename &  imageFile, const ossimFilename &  headerFile  )

private

Initialize from omd file.

Parameters

file

Returns

true on success, false on error.

Definition at line 1180 of file ossimGeneralRasterInfo.cpp.

References ossim::byteOrder(), ossimImageMetaData::clear(), ossimString::contains(), ossimFilename::fileSize(), ossimFgdcXmlDoc::getImageSize(), ossimFgdcXmlDoc::getNumberOfBands(), ossimFgdcXmlDoc::getPath(), NONE, numberOfBands(), ossimFgdcXmlDoc::open(), OSSIM_BIL, OSSIM_FLOAT32, OSSIM_UINT16, OSSIM_UINT32, OSSIM_UINT8, ossimImageMetaData::setNumberOfBands(), ossimImageMetaData::setScalarType(), size, theHeaderSize, theImageDataByteOrder, theImageFileList, theImageRect, theInterleaveType, theMetaData, thePixelsToChop, theRawImageRect, theSetNullsMode, theSubImageOffset, theValidImageRect, ossimIpt::x, and ossimIpt::y.

{
   bool result = false;

   ossimFgdcXmlDoc file;
   if (file.open( headerFile ))
   {
      while( 1 ) 
      {
         //---
         // Go through the data members in order.
         // If a required item is not found break from loop.
         //--
         theMetaData.clear();

         // scalar ( default ) - adjusted below :
         theMetaData.setScalarType( OSSIM_UINT8 );

         // Image file name:
         theImageFileList.clear();
         theImageFileList.push_back( imageFile );

         // interleave ( defaulted ):
         theInterleaveType = OSSIM_BIL;

         // bands ( required ):
         if ( !file.getNumberOfBands() )
         {
            break;
         }
         theMetaData.setNumberOfBands( file.getNumberOfBands() );
         
         ossimIpt size;
         if ( file.getImageSize(size) ) // Lines, samples not image file size.
         {
            // lines, samples ( required ):
            if ( !size.x || !size.y )
            {
               break;
            }
         }
         else
         {
            break;
         }

         // Set the rectangles:
         theRawImageRect   = ossimIrect( 0, 0, size.x - 1, size.y - 1 );
         theValidImageRect = theRawImageRect;
         theImageRect      = theRawImageRect;         

         // sample start ( not required ):
         theSubImageOffset.x = 0;

         // line start ( not required ):
         theSubImageOffset.y = 0;

         // header offset ( not required ):
         theHeaderSize = 0;

         // null mode:
         theSetNullsMode = ossimGeneralRasterInfo::NONE;

         // pixels to chop:
         thePixelsToChop = 0; 

         // Byte order *** need this ***, defaulting to system for now:
         theImageDataByteOrder = ossim::byteOrder();

         // Adjust scalar if needed, note defaulted to 8 bit above:
         ossimString eainfo;
         file.getPath("/metadata/eainfo/detailed/enttyp/enttypd", eainfo);
         ossim_int32 numBits = 0;
         ossim_int64 fileSize = imageFile.fileSize(); // Image file size.
         ossim_int32 numBytes = fileSize / size.x / size.y / numberOfBands();
         if( numBytes > 0 && numBytes != 3 )
         {
            numBits = numBytes*8;
         }
         if( numBits == 16 )
         {
            theMetaData.setScalarType( OSSIM_UINT16 );
         }
         else if( numBits == 32 )
         {
            if(eainfo.contains("float"))
            {
               theMetaData.setScalarType( OSSIM_FLOAT32 );
            }
            else
            {
               theMetaData.setScalarType( OSSIM_UINT32 );
            }
         }

         result = true;
         break; // Trailing break to get out.
      }
   }

   return result;
   
} // End: ossimGeneralRasterInfo::initializeFromXml

interleaveType()

ossimInterleaveType ossimGeneralRasterInfo::interleaveType

(

)

const

Enumerated in InterleaveTypeLUT.

Should be either bip, bil or bsq. Defaulted to bip.

Definition at line 268 of file ossimGeneralRasterInfo.cpp.

References theInterleaveType.

Referenced by ossimGeneralRasterTileSource::allocateBuffer(), bytesPerRawLine(), bytesPerValidLine(), ossimGeneralRasterTileSource::isBandSelector(), and offsetToFirstValidSample().

{
   return theInterleaveType;
}

loadState()

bool ossimGeneralRasterInfo::loadState ( const ossimKeywordlist &  kwl, const char *  prefix = 0  )

virtual

Method to the load (recreate) the state of an object from a keyword list.

Return true if ok or false on error.

Reimplemented from ossimObject.

Definition at line 404 of file ossimGeneralRasterInfo.cpp.

Referenced by ossimGeneralRasterInfo(), and ossimGeneralRasterElevHandler::setFilename().

{
   static const char MODULE[] = "ossimGeneralRasterInfo::loadState";
   if ( traceDebug() )
   {
      CLOG << "DEBUG: entered..."
           << "\nprefix:  " << (prefix ? prefix : "")
           << "\nInput keyword list:\n"
           << kwl
           << std::endl;
   }   

   bool result = false;

   //---
   // Look for required and option keyword.  Break from loop if required
   // keyword is not found.
   //---
   while( 1 )
   {
      // Check for errors in the ossimKeywordlist.
      if(kwl.getErrorStatus() == ossimErrorCodes::OSSIM_ERROR)
      {
        if(traceDebug())
        {
          ossimNotify(ossimNotifyLevel_WARN)
            << MODULE << " ERROR:\n"
            << "Detected an error in the keywordlist:  " << kwl
            << std::endl;
        }
         break;
      }

      std::string key;
      ossimString value; // Use for keyword list lookups.
      ossim_int32 lines = 0;
      ossim_int32 samples = 0;

      // Lines (required):
      key = NUMBER_LINES;
      value.string() = kwl.findKey( key );  // Required to have this.
      if ( value.size() )
      {
         lines = value.toInt32();
         if ( !lines )
         {
            if (traceDebug())
            {
               ossimNotify(ossimNotifyLevel_WARN)
                  << " ERROR:\n"
                  << "Required number of lines is 0!" << std::endl;
            }
            break;
         } 
      }
      else
      {
         if (traceDebug())
         {
            ossimNotify(ossimNotifyLevel_WARN)
               << " ERROR:\n"
               << "Required keyword not found:  " << key << std::endl;
         }
         break;
      }

      // Samples (required):
      key = NUMBER_SAMPLES;
      value.string() = kwl.findKey( key );  // Required to have this.
      if ( value.size() )
      {
         samples = value.toInt32();
         if ( !samples )
         {
            if (traceDebug())
            {
               ossimNotify(ossimNotifyLevel_WARN)
                  << " ERROR:\n"
                  << "Required number of samples is 0!" << std::endl;
            }
            break;
         }          
      }
      else
      {
         if (traceDebug())
         {
            ossimNotify(ossimNotifyLevel_WARN)
               << " ERROR:\n"
               << "Required keyword not found:  " << key << std::endl;
         }
         break;
      }
      
      // Bands ossimImageMetaData::loadState checks for required bands:
      if(!theMetaData.loadState(kwl, prefix))
      {
         if (traceDebug())
         {
            ossimNotify(ossimNotifyLevel_WARN)
               << " Error loading meta data!\n" << std::endl;
         }
         break;
      }

      // If we get here assign the rectangles:
      theRawImageRect   = ossimIrect( 0, 0, samples - 1, lines - 1 );
      theValidImageRect = theRawImageRect;
      theImageRect      = theRawImageRect;

      int tmp = INTERLEAVE_TYPE_LUT.getEntryNumber(kwl);
      if (tmp == ossimLookUpTable::NOT_FOUND)
      {
         theInterleaveType = OSSIM_BIL;
      }
      else
      {
         theInterleaveType = static_cast<ossimInterleaveType>(tmp);
      }
      
      // Get the image files.
      if (theInterleaveType != OSSIM_BSQ_MULTI_FILE)
      {
         // Look for "filename" first, then deprecated "image_file".
         key = ossimKeywordNames::FILENAME_KW;
         value.string() = kwl.findKey( key );
         if ( value.empty() )
         {
            // deprecated keyword...
            key = ossimKeywordNames::IMAGE_FILE_KW;
            value.string() = kwl.findKey( key );
         }
         
         if ( value.size() )
         {
            //---
            // omd (ossim metadata) files can have just the base filename, e.g. image.ras,
            // in which case open will fail if not in the image dir.  So only put it in
            // the list if it doesn't exits.
            //---
            ossimFilename f = value;
            if ( f.exists() )
            {
               theImageFileList.clear();
               theImageFileList.push_back(ossimFilename(value));
            }
         }

         if ( theImageFileList.empty() )
         {
            if (traceDebug())
            {
               ossimNotify(ossimNotifyLevel_WARN)
                  << "ERROR:\n"
                  << "Required keyword not found:  "
                  << ossimKeywordNames::FILENAME_KW << std::endl;
            }
            break;
         }
      }
      else
      {
         // multiple file names.
         ossim_int32 count = 0;
         
         // look for image file key word with no number.
         // Required to have this.
         key = ossimKeywordNames::FILENAME_KW;
         value.string() = kwl.findKey( key );
         if ( value.empty() )
         {
            // deprecated keyword...
            key = ossimKeywordNames::IMAGE_FILE_KW;
            value.string() = kwl.findKey( key );
         }
         
         if ( value.size() )
         {
            theImageFileList.push_back(ossimFilename(value));
            ++count;
         }
         
         ossim_int32 i = 0;
         while ( (count < numberOfBands()) && (i < 1000) )
         {
            key = ossimKeywordNames::FILENAME_KW;
            key += ossimString::toString(i).string();
            value.string() = kwl.findKey( key );
            if ( value.empty() )
            {
               // Lookup for deprecated keyword.
               key = ossimKeywordNames::IMAGE_FILE_KW;
               key += ossimString::toString(i).string();
               value.string() = kwl.findKey( key );
            }
            
            if ( value.size() )
            {
               theImageFileList.push_back(ossimFilename(value));
               ++count;
            }
            ++i;
         }
         
         if (count != numberOfBands())  // Error, count should equal bands!
         {
            if (traceDebug())
            {
               ossimNotify(ossimNotifyLevel_WARN)
                  << " ERROR:\n"
                  << "Required keyword not found:  "
                  << ossimKeywordNames::FILENAME_KW
                  << "\nInterleave type is multi file; however,"
                  << " not enough were pick up!"  << std::endl;
            }
            break;
         }
      }

      key = VALID_START_LINE;
      value.string() = kwl.findKey( key ); // Default is zero.
      if ( value.size() )
      {
         theValidImageRect.set_uly( value.toInt32() );
      }

      key = VALID_STOP_LINE;
      value.string() = kwl.findKey( key ); // Default is last line.
      if ( value.size() )
      {
         theValidImageRect.set_lry( value.toInt32() );
      }
      
      if (theValidImageRect.lr().y < theValidImageRect.ul().y)
      {
         ossimNotify(ossimNotifyLevel_WARN)
            << " ERROR:"
            << "\nValid stop line < start line."
            << "\nValid start line:  " << theValidImageRect.ul().y
            << "\nValid stop line:   " << theValidImageRect.lr().y
            << "\nError status has been set.  Returning." << std::endl;
         break;
      }

      key = VALID_START_SAMPLE;
      value.string() = kwl.findKey( key ); // Default is zero.
      if ( value.size() )
      {
         theValidImageRect.set_ulx( value.toInt32() );
      }

      key = VALID_STOP_SAMPLE;
      value.string() = kwl.findKey( key ); // Default is last sample.
      if ( value.size() ) 
      {
         theValidImageRect.set_lrx( value.toInt32() );
      }
      
      if (theValidImageRect.lr().x < theValidImageRect.ul().x)
      {
         ossimNotify(ossimNotifyLevel_WARN)
            << " ERROR:"
            << "\nValid stop samp < start samp."
            << "\nValid start samp:  " << theValidImageRect.ul().x
            << "\nValid stop samp:   " << theValidImageRect.lr().x
            << "\nError status has been set.  Returning." << std::endl;
         break;
      }
      
      theImageRect.set_lry(theValidImageRect.lr().y -
                           theValidImageRect.ul().y);
      theImageRect.set_lrx(theValidImageRect.lr().x -
                           theValidImageRect.ul().x);
      
      key = SUB_IMAGE_OFFSET_LINE;
      value.string() = kwl.findKey( key ); // Default is zero.
      if ( value.size() )
      {
         theSubImageOffset.line = value.toInt32();
      }

      key = SUB_IMAGE_OFFSET_SAMP;
      value.string() = kwl.findKey( key ); // Default is zero.
      if ( value.size() )
      {
         theSubImageOffset.samp = atoi(value);
      }

      key = HEADER_SIZE;
      value.string() = kwl.findKey( key ); // Default is zero.
      if ( value.size() )
      {
         theHeaderSize = value.toInt32();
      }

      key = SET_NULLS;
      value.string() = kwl.findKey( key ); // Default is 2.
      if ( value.size() )
      {
         int tmp;
         tmp = atoi(value);
         if ((tmp < 3) && (tmp > -1))
         {
            theSetNullsMode = (ossimFillMode)tmp;
         }
         else
         {
            theSetNullsMode = ZEROES_TO_NULL_EDGES_ONLY;  // 2
            ossimNotify(ossimNotifyLevel_WARN)
               << " WARNING:"
               << "\nset_fill_to_nulls_mode value out of range."
               << "\nDefaulted to 2" << std::endl;
         }
      }

      key = PIXELS_TO_CHOP;
      value.string() = kwl.findKey( key ); // Default is zero.
      if ( value.size() )
      {
         thePixelsToChop = value.toInt32();
      }
      
      if (bytesPerPixel() > 1)
      {
         // get the byte order of the data.
         key = ossimKeywordNames::BYTE_ORDER_KW;
         value.string() = kwl.findKey( key );
         if ( value.size() )
         {
            ossimString s(value);
            if (s.trim() != "")  // Check for empty string.
            {
               s.downcase();
               if (s.contains("big"))
               {
                  theImageDataByteOrder = OSSIM_BIG_ENDIAN;
               }
               else if(s.contains("little"))
               {
                  theImageDataByteOrder = OSSIM_LITTLE_ENDIAN;
               }
            }
         }
      }

      // End of while forever loop.
      result = true;
      break;

   } // Matches: while (1)

   if ( traceDebug() )
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << MODULE  << " Exit status: " << (result?"true":"false") << std::endl;
   }      
   
   return result;
   
} // End: bool ossimGeneralRasterInfo::loadState

numberOfBands()

ossim_int32 ossimGeneralRasterInfo::numberOfBands ( ) const

inline

Number of bands.

Inlined below.

Returns

Number of bands from theMetaData class member cast to an int32.

Definition at line 355 of file ossimGeneralRasterInfo.h.

References ossimImageMetaData::getNumberOfBands(), and theMetaData.

Referenced by ossimGeneralRasterTileSource::allocateTile(), bytesPerRawLine(), bytesPerValidLine(), getBitsPerPixel(), initializeFromXml(), offsetToFirstValidSample(), and ossimGeneralRasterElevHandler::setFilename().

{
   return static_cast<ossim_int32>( theMetaData.getNumberOfBands() );
}

offsetToFirstValidSample()

std::streamoff ossimGeneralRasterInfo::offsetToFirstValidSample ( ) const

inline

Returns the offset in bytes to the first valid sample in the image.

Definition at line 409 of file ossimGeneralRasterInfo.h.

References bytesPerPixel(), bytesPerRawLine(), headerSize(), interleaveType(), numberOfBands(), OSSIM_BIL, OSSIM_BIP, ossimIrect::ul(), validImageRect(), ossimIpt::x, and ossimIpt::y.

{
   if (interleaveType() == OSSIM_BIP)
   {
      return headerSize() +
         ( bytesPerRawLine() * validImageRect().ul().y ) +
         ( validImageRect().ul().x * numberOfBands() * bytesPerPixel() );
   }
   else if (interleaveType() == OSSIM_BIL)
   {
      return headerSize() +
         ( bytesPerRawLine() * validImageRect().ul().y * numberOfBands() ) +
         ( validImageRect().ul().x * bytesPerPixel() );
   }
   else // BSQ
   {
      return headerSize() +
         ( bytesPerRawLine() * validImageRect().ul().y ) +
         ( validImageRect().ul().x * bytesPerPixel() );
   }
}

open()

bool ossimGeneralRasterInfo::open

(

const ossimFilename &

imageFile

)

Takes image file and attempts to derive/find header file to parse for general raster data, i.e.

lines, samples, bands and so on.

Parameters

image

file.

Returns

true on success, false on error.

Definition at line 765 of file ossimGeneralRasterInfo.cpp.

{
   static const char MODULE[] = "ossimGeneralRasterInfo::open";
   if ( traceDebug() )
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << MODULE << " entered..." << "\nimageFile: " << imageFile << std::endl;
   }

   bool result = false;

   // Wipe any previous state slick.
   clear();

   ossimFilename copyFile = imageFile;
   if ( !imageFile.exists() )
   {
      copyFile = imageFile.expand();
   }

   // Look for the headrer of omd file as they are written out by img2rr.
   ossimFilename hdr = copyFile;
   hdr.setExtension("hdr"); // image.hdr
   if ( !hdr.exists() )
   {
      hdr = imageFile;
      hdr.string() += ".hdr"; // image.ras.hdr
      if ( ! hdr.exists() )
      {
         hdr = imageFile;
         hdr.setExtension("xml"); // image.xml
      }
   }

   if ( hdr.exists() )
   {
      if ( traceDebug() )
      {
         ossimNotify(ossimNotifyLevel_DEBUG) << "header file: " << hdr << std::endl;
      }
      
      ossimString ext = hdr.ext().downcase();
      
      if ( ext == "hdr" )
      {
         if ( ossimEnviHeader::isEnviHeader( hdr ) )
         {
            result = initializeFromEnviHdr( hdr );
         }
         else
         {
            result = initializeFromHdr( imageFile, hdr );
         }

         if ( !result )
         {
            // Could be an ossim meta data file:
            ossimKeywordlist kwl( hdr );
            result = loadState( kwl, 0 );
         }
      }
      else if ( ext == "xml" )
      {
         result = initializeFromXml( imageFile, hdr );
      }
   }
   
   //---
   // Set the file name.  Needed for ossimGeneralRasterTileSource::open.
   // Note set here above loadState call to stop loadState from returning
   // false if no image file found.
   //---
   if ( theImageFileList.empty() )
   {
      setImageFile( imageFile );
   }
   
   ossimFilename omd = imageFile;
   omd.setExtension("omd"); // image.omd
   if ( !omd.exists() )
   {
      omd.setExtension("kwl"); // image.kwl
   }

   if ( omd.exists() )
   {
      if ( traceDebug() )
      {
         ossimNotify(ossimNotifyLevel_DEBUG) << "omd file: " << omd << std::endl;
      }

      ossimKeywordlist kwl( omd );

      if ( result && theMetaData.getNumberOfBands() )
      {
         //---
         // Just update the band info in case it has min/max values from
         // a compute min/max scan.
         //---
         theMetaData.updateMetaData( kwl, std::string("") );
      }
      else
      {
         // We're not initialized yet so do a loadState:
         result = loadState( kwl, 0 );
      }
   }
   
   if ( traceDebug() )
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << MODULE  << " Exit status: " << (result?"true":"false") << std::endl;
   }
   
   return result;
}

operator=()

const ossimGeneralRasterInfo & ossimGeneralRasterInfo::operator=

(

const ossimGeneralRasterInfo &

rhs

)

Assignment operator=.

Definition at line 165 of file ossimGeneralRasterInfo.cpp.

References theHeaderSize, theImageDataByteOrder, theImageFileList, theImageRect, theInterleaveType, theMetaData, thePixelsToChop, theRawImageRect, theSetNullsMode, theSubImageOffset, and theValidImageRect.

{
   if ( this != &rhs )
   {
      theMetaData           = rhs.theMetaData;
      theImageFileList      = rhs.theImageFileList;
      theInterleaveType     = rhs.theInterleaveType;
      theRawImageRect       = rhs.theRawImageRect;
      theValidImageRect     = rhs.theValidImageRect;
      theImageRect          = rhs.theImageRect;
      theSubImageOffset     = rhs.theSubImageOffset;
      theHeaderSize         = rhs.theHeaderSize;
      theSetNullsMode       = rhs.theSetNullsMode;
      thePixelsToChop       = rhs.thePixelsToChop;
      theImageDataByteOrder = rhs.theImageDataByteOrder;
   }
   return *this;
}

pixelsToChop()

ossim_int32 ossimGeneralRasterInfo::pixelsToChop

(

)

const

Returns the number of pixels from the edge of a line to set to the fill value.

This can be used to eliminate resampling error on the edge of an image and still keep the image demensions relative to the geometry file.

Definition at line 263 of file ossimGeneralRasterInfo.cpp.

References thePixelsToChop.

{
   return thePixelsToChop;
} 

print()

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

References saveState().

Referenced by ossimERSTileSource::open().

{
   //---
   // This will print in a keyword format that can be read by the constructor.
   // that takes a keyword list.
   //---
   ossimKeywordlist kwl;
   saveState( kwl, 0 );
   out << kwl << std::endl;
   return out;
}

rawImageRect()

const ossimIrect & ossimGeneralRasterInfo::rawImageRect

(

)

const

Zero based rectangle of the raw image.

Definition at line 215 of file ossimGeneralRasterInfo.cpp.

References theRawImageRect.

{
   return theRawImageRect;
}

rawLines()

ossim_int32 ossimGeneralRasterInfo::rawLines ( ) const

inline

Returns the number of lines within "theRawImageRect".

Definition at line 370 of file ossimGeneralRasterInfo.h.

References ossimIrect::height(), and theRawImageRect.

{
   return static_cast<ossim_int32>(theRawImageRect.height());
}

rawSamples()

ossim_int32 ossimGeneralRasterInfo::rawSamples ( ) const

inline

Returns the number of samples within "theRawImageRect".

Definition at line 404 of file ossimGeneralRasterInfo.h.

References theRawImageRect, and ossimIrect::width().

Referenced by bytesPerRawLine().

{
   return static_cast<ossim_int32>(theRawImageRect.width());
}

saveState()

bool ossimGeneralRasterInfo::saveState ( ossimKeywordlist &  kwl, const char *  prefix = 0  ) const

virtual

Method to save the state of an object to a keyword list.

Return true if ok or false on error.

Reimplemented from ossimObject.

Definition at line 329 of file ossimGeneralRasterInfo.cpp.

References ossimKeywordlist::add(), ossimKeywordNames::FILENAME_KW, ossimImageMetaData::saveState(), theImageFileList, theMetaData, and ossimString::toString().

Referenced by print().

{
   for (ossim_uint32 i=0; i<theImageFileList.size(); ++i)
   {
      ossimString kw = ossimKeywordNames::FILENAME_KW;
      kw += ossimString::toString(i+1);
      kwl.add(prefix, theImageFileList[i].c_str());
   }

   theMetaData.saveState(kwl, prefix);

   kwl.add(prefix,
           NUMBER_LINES,
           ossimString::toString( rawLines() ), true);
   kwl.add(prefix,
           NUMBER_SAMPLES,
           ossimString::toString( rawSamples() ),
           true);
   kwl.add(prefix,
           HEADER_SIZE,
           ossimString::toString(theHeaderSize),
           true);
   kwl.add(prefix,
           SUB_IMAGE_OFFSET_LINE,
           theSubImageOffset.line,
           true);
   kwl.add(prefix,
           SUB_IMAGE_OFFSET_SAMP,
           theSubImageOffset.samp,
           true);
   kwl.add(prefix,
           VALID_START_LINE,
           theValidImageRect.ul().y,
           true);
   kwl.add(prefix,
           VALID_STOP_LINE,
           theValidImageRect.lr().y,
           true);
   kwl.add(prefix,
           VALID_START_SAMPLE,
           theValidImageRect.ul().x,
           true);
   kwl.add(prefix,
           VALID_STOP_SAMPLE,
           theValidImageRect.ur().x,
           true);
   kwl.add(prefix,
           ossimKeywordNames::INTERLEAVE_TYPE_KW,
           INTERLEAVE_TYPE_LUT.getEntryString(theInterleaveType),
           true);

   kwl.add(prefix,
           PIXELS_TO_CHOP,
           thePixelsToChop,
           true);

   kwl.add(prefix,
           SET_NULLS,
           theSetNullsMode,
           true);


   if (bytesPerPixel() > 1)
   {
      kwl.add(prefix,
              ossimKeywordNames::BYTE_ORDER_KW,
              (theImageDataByteOrder == OSSIM_LITTLE_ENDIAN ? "little_endian" :
               "big_endian"),
              true);
   }

   return true;
}

setFillToNullsMode()

void ossimGeneralRasterInfo::setFillToNullsMode

(

ossim_uint32

mode

)

Sets theSetNullsMode.

Definition at line 247 of file ossimGeneralRasterInfo.cpp.

References ossimNotify(), ossimNotifyLevel_WARN, and theSetNullsMode.

{
   static const char MODULE[] = "ossimGeneralRasterInfo::setFillToNullMode";
   if(mode < 3)
   {
      theSetNullsMode = (ossimFillMode)mode;
   }
   else
   {
      ossimNotify(ossimNotifyLevel_WARN)
         << MODULE << " ERROR:"
         << "\nmode out of bounds(0 - 2):  " << mode << std::endl
         << "\nmode has not been changed." << std::endl;
   }
}

setHeaderSize()

void ossimGeneralRasterInfo::setHeaderSize

(

ossim_int32

headerSize

)

Definition at line 294 of file ossimGeneralRasterInfo.cpp.

References headerSize(), and theHeaderSize.

{
   theHeaderSize = headerSize;
}

setImageDataByteOrder()

void ossimGeneralRasterInfo::setImageDataByteOrder

(

ossimByteOrder

byteOrder

)

Definition at line 289 of file ossimGeneralRasterInfo.cpp.

References ossim::byteOrder(), and theImageDataByteOrder.

{
   theImageDataByteOrder = byteOrder;
}

setImageFile()

void ossimGeneralRasterInfo::setImageFile

(

const ossimFilename &

file

)

Sets the image file list to file.

Performs a clear, prior to setting.

Parameters

file	Image file.

Definition at line 283 of file ossimGeneralRasterInfo.cpp.

References theImageFileList.

{
   theImageFileList.clear();
   theImageFileList.push_back( file );
}   

setImageFileList()

void ossimGeneralRasterInfo::setImageFileList

(

const std::vector< ossimFilename > &

list

)

Definition at line 278 of file ossimGeneralRasterInfo.cpp.

References theImageFileList.

{
   theImageFileList = list;
}

setImageRect()

void ossimGeneralRasterInfo::setImageRect

(

const ossimIrect &

imageRect

)

Definition at line 304 of file ossimGeneralRasterInfo.cpp.

References imageRect(), and theImageRect.

{
   theImageRect = imageRect;
}

setInterleaveType()

void ossimGeneralRasterInfo::setInterleaveType

(

ossimInterleaveType

il_type

)

Definition at line 299 of file ossimGeneralRasterInfo.cpp.

References theInterleaveType.

{
   theInterleaveType = il_type;
}

setRawImageRect()

void ossimGeneralRasterInfo::setRawImageRect

(

const ossimIrect &

imageRect

)

Definition at line 314 of file ossimGeneralRasterInfo.cpp.

References imageRect(), and theRawImageRect.

{
   theRawImageRect = imageRect;
}

setSubImageOffset()

void ossimGeneralRasterInfo::setSubImageOffset

(

const ossimIpt &

d

)

Definition at line 319 of file ossimGeneralRasterInfo.cpp.

References theSubImageOffset.

{
   theSubImageOffset = d;
}

setValidImageRect()

void ossimGeneralRasterInfo::setValidImageRect

(

const ossimIrect &

imageRect

)

Definition at line 309 of file ossimGeneralRasterInfo.cpp.

References imageRect(), and theValidImageRect.

{
   theValidImageRect = imageRect;
}

subImageOffset()

const ossimIpt & ossimGeneralRasterInfo::subImageOffset

(

)

const

Returns the offset of this image's origin to a full-image's origin, in the case where this image is a sub-image of a larger full-image.

Definition at line 220 of file ossimGeneralRasterInfo.cpp.

References theSubImageOffset.

{
   return theSubImageOffset;
}

validImageRect()

const ossimIrect & ossimGeneralRasterInfo::validImageRect

(

)

const

Returns the rectangle of where the image is within the raster file.

In most cases this will be the same as the rawImageRect. (zero based)

Definition at line 210 of file ossimGeneralRasterInfo.cpp.

References theValidImageRect.

Referenced by offsetToFirstValidSample().

{
   return theValidImageRect;
}

validLines()

ossim_int32 ossimGeneralRasterInfo::validLines ( ) const

inline

Returns the number of lines within "theValidImageRect".

Definition at line 365 of file ossimGeneralRasterInfo.h.

References ossimIrect::height(), and theValidImageRect.

{
   return static_cast<ossim_int32>(theValidImageRect.height());
}

validSamples()

ossim_int32 ossimGeneralRasterInfo::validSamples ( ) const

inline

Returns the number of samples within "theValidImageRect".

Definition at line 399 of file ossimGeneralRasterInfo.h.

References theValidImageRect, and ossimIrect::width().

Referenced by bytesPerValidLine().

{
   return static_cast<ossim_int32>(theValidImageRect.width());
}

Member Data Documentation

theHeaderSize

ossim_int32 ossimGeneralRasterInfo::theHeaderSize

private

Size of header in bytes.

Definition at line 314 of file ossimGeneralRasterInfo.h.

Referenced by clear(), headerSize(), initializeFromEnviHdr(), initializeFromHdr(), initializeFromXml(), operator=(), and setHeaderSize().

theImageDataByteOrder

ossimByteOrder ossimGeneralRasterInfo::theImageDataByteOrder

private

The byte order the image data is stored in.

Definition at line 333 of file ossimGeneralRasterInfo.h.

Referenced by clear(), getImageDataByteOrder(), initializeFromEnviHdr(), initializeFromHdr(), initializeFromXml(), operator=(), and setImageDataByteOrder().

theImageFileList

std::vector<ossimFilename> ossimGeneralRasterInfo::theImageFileList

private

Definition at line 287 of file ossimGeneralRasterInfo.h.

Referenced by clear(), getImageFileList(), initializeFromEnviHdr(), initializeFromHdr(), initializeFromXml(), operator=(), saveState(), setImageFile(), and setImageFileList().

theImageRect

ossimIrect ossimGeneralRasterInfo::theImageRect

private

The valid image rectangle normalized to be zero based.

Definition at line 304 of file ossimGeneralRasterInfo.h.

Referenced by clear(), imageRect(), initializeFromEnviHdr(), initializeFromHdr(), initializeFromXml(), operator=(), ossimGeneralRasterInfo(), and setImageRect().

theInterleaveType

ossimInterleaveType ossimGeneralRasterInfo::theInterleaveType

private

Definition at line 288 of file ossimGeneralRasterInfo.h.

Referenced by clear(), initializeFromEnviHdr(), initializeFromHdr(), initializeFromXml(), interleaveType(), operator=(), and setInterleaveType().

theMetaData

ossimImageMetaData ossimGeneralRasterInfo::theMetaData

private

Definition at line 286 of file ossimGeneralRasterInfo.h.

Referenced by bytesPerPixel(), clear(), getImageMetaData(), initializeFromEnviHdr(), initializeFromHdr(), initializeFromXml(), numberOfBands(), operator=(), and saveState().

thePixelsToChop

ossim_int32 ossimGeneralRasterInfo::thePixelsToChop

private

Amount of pixels to chop for each line edge.

Definition at line 328 of file ossimGeneralRasterInfo.h.

Referenced by clear(), initializeFromEnviHdr(), initializeFromHdr(), initializeFromXml(), operator=(), and pixelsToChop().

theRawImageRect

ossimIrect ossimGeneralRasterInfo::theRawImageRect

private

The zero based rectangle of the entire image not including any header.

Definition at line 293 of file ossimGeneralRasterInfo.h.

Referenced by clear(), getBitsPerPixel(), initializeFromEnviHdr(), initializeFromHdr(), initializeFromXml(), operator=(), ossimGeneralRasterInfo(), rawImageRect(), rawLines(), rawSamples(), and setRawImageRect().

theSetNullsMode

ossimFillMode ossimGeneralRasterInfo::theSetNullsMode

private

Mode of how to handle pixels on import.

0 = Do nothing the pixels. 1 = Set any zeroes to min value of radiometry. 2 = Set zeroes on line edges only to nulls; any other zeroes are set to min value of radiometry.

Definition at line 323 of file ossimGeneralRasterInfo.h.

Referenced by clear(), fillToNullsMode(), initializeFromEnviHdr(), initializeFromHdr(), initializeFromXml(), operator=(), and setFillToNullsMode().

theSubImageOffset

ossimIpt ossimGeneralRasterInfo::theSubImageOffset

private

The offset from the full-image origin to this image's origin.

Definition at line 309 of file ossimGeneralRasterInfo.h.

Referenced by clear(), initializeFromEnviHdr(), initializeFromHdr(), initializeFromXml(), operator=(), setSubImageOffset(), and subImageOffset().

theValidImageRect

ossimIrect ossimGeneralRasterInfo::theValidImageRect

private

The rectangle representing where the valid part of the image lies within "theRawImageRect".

Definition at line 299 of file ossimGeneralRasterInfo.h.

Referenced by clear(), initializeFromEnviHdr(), initializeFromHdr(), initializeFromXml(), operator=(), ossimGeneralRasterInfo(), setValidImageRect(), validImageRect(), validLines(), and validSamples().

---

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

• ossimGeneralRasterInfo.h
• ossimGeneralRasterInfo.cpp