ossimImageMetaData Class Reference

#include <ossimImageMetaData.h>

Public Member Functions
	ossimImageMetaData ()
	ossimImageMetaData (ossimScalarType aType, ossim_uint32 numberOfBands)
	ossimImageMetaData (const ossimImageMetaData &rhs)
const ossimImageMetaData &	operator= (const ossimImageMetaData &rhs)
	~ossimImageMetaData ()
void	clear ()
void	setDefaultsForArrays ()
void	setNumberOfBands (ossim_uint32 numberOfBands)
ossim_uint32	getNumberOfBands () const
const std::string &	getRgbBands () const
bool	getRgbBands (std::vector< ossim_uint32 > &bandList) const
	Convenience method to get the zero based rgb output band list. More...
void	setScalarType (ossimScalarType aType)
ossimScalarType	getScalarType () const
ossim_uint32	getBytesPerPixel () const
double	getMinPix (ossim_uint32 band) const
void	setMinPix (ossim_uint32 band, double pix)
void	setMaxPix (ossim_uint32 band, double pix)
void	setNullPix (ossim_uint32 band, double pix)
double	getMaxPix (ossim_uint32 band) const
double	getNullPix (ossim_uint32 band) const
const double *	getMinPixelArray () const
const double *	getMaxPixelArray () const
const double *	getNullPixelArray () const
void	setMinValuesValid (bool flag)
void	setMaxValuesValid (bool flag)
void	setNullValuesValid (bool flag)
bool	getMinValuesValidFlag () const
bool	getMaxValuesValidFlag () const
bool	getNullValuesValidFlag () const
bool	isValid () const
bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)
bool	saveState (ossimKeywordlist &kwl, const char *prefix=0) const
void	updateMetaData (const ossimKeywordlist &kwl, const std::string &prefix)
	Method to update band values. More...
std::ostream &	print (std::ostream &out) const
	Print method. More...

Private Member Functions
ossim_uint32	getBandCount (const ossimKeywordlist &kwl, const std::string &prefix) const
	Looks for ossimKeywordNames::NUMBER_BANDS_KW, if not found looks for. More...

Private Attributes
double *	theNullPixelArray
double *	theMinPixelArray
double *	theMaxPixelArray
bool	theMinValuesValidFlag
bool	theMaxValuesValidFlag
bool	theNullValuesValidFlag
ossimScalarType	theScalarType
ossim_uint32	theBytesPerPixel
ossim_uint32	theNumberOfBands
std::string	theRgbBands

Friends
OSSIM_DLL std::ostream &	operator<< (std::ostream &out, const ossimImageMetaData &obj)

Detailed Description

Definition at line 26 of file ossimImageMetaData.h.

Constructor & Destructor Documentation

ossimImageMetaData() [1/3]

ossimImageMetaData::ossimImageMetaData

(

)

Definition at line 28 of file ossimImageMetaData.cpp.

   :theNullPixelArray(0),
    theMinPixelArray(0),
    theMaxPixelArray(0),
    theMinValuesValidFlag(false),
    theMaxValuesValidFlag(false),
    theNullValuesValidFlag(false),
    theScalarType(OSSIM_SCALAR_UNKNOWN),
    theBytesPerPixel(0),
    theNumberOfBands(0),
    theRgbBands()
{
}

ossimImageMetaData() [2/3]

ossimImageMetaData::ossimImageMetaData	(	ossimScalarType	aType,
		ossim_uint32	numberOfBands
	)

Definition at line 42 of file ossimImageMetaData.cpp.

References ossim::scalarSizeInBytes(), setDefaultsForArrays(), theBytesPerPixel, theMaxPixelArray, theMinPixelArray, theNullPixelArray, and theNumberOfBands.

   :theNullPixelArray(0),
    theMinPixelArray(0),
    theMaxPixelArray(0),
    theMinValuesValidFlag(false),
    theMaxValuesValidFlag(false),
    theNullValuesValidFlag(false),
    theScalarType(aType),
    theBytesPerPixel(0),
    theNumberOfBands(numberOfBands),
    theRgbBands()
{
   if(theNumberOfBands)
   {
      theNullPixelArray = new double[theNumberOfBands];
      theMinPixelArray  = new double[theNumberOfBands];
      theMaxPixelArray  = new double[theNumberOfBands];
      
      setDefaultsForArrays();
   }
   theBytesPerPixel = ossim::scalarSizeInBytes( aType );
}

ossimImageMetaData() [3/3]

ossimImageMetaData::ossimImageMetaData

(

const ossimImageMetaData &

rhs

)

Definition at line 66 of file ossimImageMetaData.cpp.

References theMaxPixelArray, theMinPixelArray, theNullPixelArray, and theNumberOfBands.

   :
   theNullPixelArray(0),
   theMinPixelArray(0),
   theMaxPixelArray(0),
   theMinValuesValidFlag(rhs.theMinValuesValidFlag),
   theMaxValuesValidFlag(rhs.theMaxValuesValidFlag),
   theNullValuesValidFlag(rhs.theNullValuesValidFlag),
   theScalarType(rhs.theScalarType),
   theBytesPerPixel(rhs.theBytesPerPixel),
   theNumberOfBands(rhs.theNumberOfBands),
   theRgbBands(rhs.theRgbBands)
{
   if(theNumberOfBands)
   {
      theNullPixelArray = new double[theNumberOfBands];
      theMinPixelArray  = new double[theNumberOfBands];
      theMaxPixelArray  = new double[theNumberOfBands];
      
      std::copy(rhs.theNullPixelArray,
                rhs.theNullPixelArray+theNumberOfBands,
                theNullPixelArray);
      std::copy(rhs.theMinPixelArray,
                rhs.theMinPixelArray+theNumberOfBands,
                theMinPixelArray);
      std::copy(rhs.theMaxPixelArray,
                rhs.theMaxPixelArray+theNumberOfBands,
                theMaxPixelArray);
   }
}

~ossimImageMetaData()

ossimImageMetaData::~ossimImageMetaData

(

)

Definition at line 129 of file ossimImageMetaData.cpp.

References clear().

{
  clear();
}

Member Function Documentation

clear()

void ossimImageMetaData::clear

(

)

Definition at line 134 of file ossimImageMetaData.cpp.

References OSSIM_SCALAR_UNKNOWN, theBytesPerPixel, theMaxPixelArray, theMinPixelArray, theNullPixelArray, theNumberOfBands, theRgbBands, and theScalarType.

Referenced by ossimGeneralRasterInfo::clear(), ossimGeneralRasterInfo::initializeFromEnviHdr(), ossimGeneralRasterInfo::initializeFromHdr(), ossimGeneralRasterInfo::initializeFromXml(), ossimImageHandler::loadMetaData(), loadState(), operator=(), and ~ossimImageMetaData().

{
   if(theNullPixelArray)
   {
      delete [] theNullPixelArray;
      theNullPixelArray = 0;
   }
   if(theMinPixelArray)
   {
      delete [] theMinPixelArray;
      theMinPixelArray = 0;
   }
   if(theMaxPixelArray)
   {
      delete [] theMaxPixelArray;
      theMaxPixelArray = 0;
   }
   theScalarType    = OSSIM_SCALAR_UNKNOWN;
   theBytesPerPixel = 0;
   theNumberOfBands = 0;
   theRgbBands.clear();
}

getBandCount()

ossim_uint32 ossimImageMetaData::getBandCount ( const ossimKeywordlist &  kwl, const std::string &  prefix  ) const

private

Looks for ossimKeywordNames::NUMBER_BANDS_KW, if not found looks for.

Definition at line 554 of file ossimImageMetaData.cpp.

References ossimKeywordlist::findKey(), ossimKeywordlist::getSubstringKeyList(), ossimKeywordNames::NUMBER_BANDS_KW, ossimString::size(), ossimString::string(), and ossimString::toUInt32().

Referenced by loadState(), and updateMetaData().

{
   ossim_uint32 result = 0;

   ossimString value;
   value.string() = kwl.findKey( prefix, std::string(ossimKeywordNames::NUMBER_BANDS_KW) );
   if ( value.size() )
   {
      result = value.toUInt32();
   }
   else
   {
      value.string() = std::string("^(") + prefix + std::string("band[0-9]+.)");
      std::vector<ossimString> keys = kwl.getSubstringKeyList( value );
      result = static_cast<ossim_uint32>( keys.size() );
   }
   return result;   
}

getBytesPerPixel()

ossim_uint32 ossimImageMetaData::getBytesPerPixel

(

)

const

Returns

The bytes per pixel. This is for a single band.

Definition at line 334 of file ossimImageMetaData.cpp.

References theBytesPerPixel.

Referenced by ossimGeneralRasterTileSource::allocateBuffer(), and ossimGeneralRasterInfo::bytesPerPixel().

{
   return theBytesPerPixel;
}

getMaxPix()

double ossimImageMetaData::getMaxPix

(

ossim_uint32

band

)

const

Definition at line 374 of file ossimImageMetaData.cpp.

References ossim::defaultMax(), ossim::min(), theMaxPixelArray, theNumberOfBands, and theScalarType.

Referenced by ossimGeneralRasterTileSource::allocateTile(), ossimGdalTileSource::computeMinMax(), ossimUsgsDemTileSource::getMaxPixelValue(), ossimDtedTileSource::getMaxPixelValue(), ossimImageHandler::getMaxPixelValue(), and ossimERSTileSource::open().

{
   if(theNumberOfBands&&theMaxPixelArray)
   {
      ossim_uint32 i = ossim::min(band, (ossim_uint32)(theNumberOfBands-1));
      
      return theMaxPixelArray[i];
   }
   return ossim::defaultMax(theScalarType);
}

getMaxPixelArray()

const double * ossimImageMetaData::getMaxPixelArray

(

)

const

Definition at line 400 of file ossimImageMetaData.cpp.

References theMaxPixelArray.

{
   return theMaxPixelArray;
}

getMaxValuesValidFlag()

bool ossimImageMetaData::getMaxValuesValidFlag

(

)

const

Definition at line 430 of file ossimImageMetaData.cpp.

References theMaxValuesValidFlag.

Referenced by ossimERSTileSource::open().

{
   return theMaxValuesValidFlag;
}

getMinPix()

double ossimImageMetaData::getMinPix

(

ossim_uint32

band

)

const

Definition at line 363 of file ossimImageMetaData.cpp.

References ossim::defaultMin(), ossim::min(), theMinPixelArray, theNumberOfBands, and theScalarType.

Referenced by ossimGeneralRasterTileSource::allocateTile(), ossimGdalTileSource::computeMinMax(), ossimUsgsDemTileSource::getMinPixelValue(), ossimDtedTileSource::getMinPixelValue(), ossimImageHandler::getMinPixelValue(), and ossimERSTileSource::open().

{
   if(theNumberOfBands&&theMinPixelArray)
   {
      ossim_uint32 i = ossim::min(band, (ossim_uint32)(theNumberOfBands-1));
      
      return theMinPixelArray[i];
   }
   return ossim::defaultMin(theScalarType);
}

getMinPixelArray()

const double * ossimImageMetaData::getMinPixelArray

(

)

const

Definition at line 396 of file ossimImageMetaData.cpp.

References theMinPixelArray.

{
   return theMinPixelArray;
}

getMinValuesValidFlag()

bool ossimImageMetaData::getMinValuesValidFlag

(

)

const

Definition at line 425 of file ossimImageMetaData.cpp.

References theMinValuesValidFlag.

Referenced by ossimERSTileSource::open().

{
   return theMinValuesValidFlag;
}

getNullPix()

double ossimImageMetaData::getNullPix

(

ossim_uint32

band

)

const

Definition at line 385 of file ossimImageMetaData.cpp.

References ossim::defaultNull(), ossim::min(), theNullPixelArray, theNumberOfBands, and theScalarType.

Referenced by ossimGeneralRasterTileSource::allocateTile(), ossimGdalTileSource::computeMinMax(), ossimDtedTileSource::getNullPixelValue(), ossimImageHandler::getNullPixelValue(), ossimERSTileSource::open(), and ossimGeneralRasterElevHandler::setFilename().

{
   if(theNumberOfBands&&theNullPixelArray)
   {
      ossim_uint32 i = ossim::min(band, (ossim_uint32)(theNumberOfBands-1));
      
      return theNullPixelArray[i];
   }
   return ossim::defaultNull(theScalarType);
}

getNullPixelArray()

const double * ossimImageMetaData::getNullPixelArray

(

)

const

Definition at line 405 of file ossimImageMetaData.cpp.

References theNullPixelArray.

{
   return theNullPixelArray;
}

getNullValuesValidFlag()

bool ossimImageMetaData::getNullValuesValidFlag

(

)

const

Definition at line 435 of file ossimImageMetaData.cpp.

References theNullValuesValidFlag.

Referenced by ossimERSTileSource::open().

{
   return theNullValuesValidFlag;
}

getNumberOfBands()

ossim_uint32 ossimImageMetaData::getNumberOfBands

(

)

const

Definition at line 295 of file ossimImageMetaData.cpp.

References theNumberOfBands.

Referenced by ossimGeneralRasterTileSource::allocateBuffer(), ossimUsgsDemTileSource::getMaxPixelValue(), ossimDtedTileSource::getMaxPixelValue(), ossimTiffTileSource::getMaxPixelValue(), ossimGdalTileSource::getMaxPixelValue(), ossimImageHandler::getMaxPixelValue(), ossimUsgsDemTileSource::getMinPixelValue(), ossimDtedTileSource::getMinPixelValue(), ossimTiffTileSource::getMinPixelValue(), ossimGdalTileSource::getMinPixelValue(), ossimImageHandler::getMinPixelValue(), ossimDtedTileSource::getNullPixelValue(), ossimTiffTileSource::getNullPixelValue(), ossimGdalTileSource::getNullPixelValue(), ossimImageHandler::getNullPixelValue(), ossimGeneralRasterTileSource::getNumberOfInputBands(), ossimGeneralRasterTileSource::getNumberOfOutputBands(), ossimGeneralRasterInfo::initializeFromHdr(), and ossimGeneralRasterInfo::numberOfBands().

{
   return theNumberOfBands;
}

getRgbBands() [1/2]

const std::string & ossimImageMetaData::getRgbBands

(

)

const

Returns

string reference containing rgb band order, e.g. "(2,1,0)". Will be an emptry string if not set.

Definition at line 300 of file ossimImageMetaData.cpp.

References theRgbBands.

Referenced by ossimImageHandler::getRgbBandList().

{
   return theRgbBands;
}

getRgbBands() [2/2]

bool ossimImageMetaData::getRgbBands

(

std::vector< ossim_uint32 > &

bandList

)

const

Convenience method to get the zero based rgb output band list.

This method returns true on success; false, if rgb_bands key is not set in dot omd file.

Note

: Current ossimImageMetaData logic requires key "number_bands" to be set and at least 3.

Parameters

bandList

Initialized by this on success.

Returns

false

Definition at line 305 of file ossimImageMetaData.cpp.

References theNumberOfBands, theRgbBands, and ossim::toSimpleVector().

{
   bool result = false;
   if ( ( theNumberOfBands > 2) && theRgbBands.size() )
   {
      ossim::toSimpleVector( bandList, ossimString(theRgbBands) );
      if ( bandList.size() == 3 )
      {
         result = true;
      }
      else
      {
         bandList.clear();
      }
   }
   return result;
}

getScalarType()

ossimScalarType ossimImageMetaData::getScalarType

(

)

const

Definition at line 329 of file ossimImageMetaData.cpp.

References theScalarType.

Referenced by ossimGeneralRasterTileSource::allocateTile(), and ossimGeneralRasterElevHandler::setFilename().

{
   return theScalarType;
}

isValid()

bool ossimImageMetaData::isValid

(

void

)

const

Definition at line 440 of file ossimImageMetaData.cpp.

References theNumberOfBands.

Referenced by ossimImageHandler::hasMetaData().

{
   return (theNumberOfBands > 0);
//    return ((theNumberOfBands>0)&&
//            (theScalarType != OSSIM_SCALAR_UNKNOWN));
}

loadState()

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

Definition at line 199 of file ossimImageMetaData.cpp.

References clear(), ossimKeywordlist::findKey(), getBandCount(), setNumberOfBands(), theMaxValuesValidFlag, theMinValuesValidFlag, theNullValuesValidFlag, theRgbBands, and updateMetaData().

Referenced by ossimImageHandler::loadMetaData(), and ossimERSTileSource::open().

{
   bool result = false; // return status
   
   // Clear the object:
   clear();

   std::string pfx = ( prefix ? prefix : "" );
   
   theRgbBands = kwl.findKey( pfx, std::string("rgb_bands") );
   
   ossim_uint32 bands = getBandCount( kwl, pfx );
   if ( bands )
   {
      result = true;
      
      setNumberOfBands( bands );
      
      theMinValuesValidFlag  = true;
      theMaxValuesValidFlag  = true;
      theNullValuesValidFlag = true;

      updateMetaData( kwl, pfx ); // Initializes the rest of object.
   }
   else
   {
      if (traceDebug())
      {
         ossimNotify(ossimNotifyLevel_WARN)
            << " ERROR:\n"
            << "Required keyword not found:  " << ossimKeywordNames::NUMBER_BANDS_KW << std::endl;
      }
   }
   
   if (traceDebug())
   {
      print( ossimNotify(ossimNotifyLevel_DEBUG) );
   }

   return result;
}

operator=()

const ossimImageMetaData & ossimImageMetaData::operator=

(

const ossimImageMetaData &

rhs

)

Definition at line 97 of file ossimImageMetaData.cpp.

References clear(), theBytesPerPixel, theMaxPixelArray, theMaxValuesValidFlag, theMinPixelArray, theMinValuesValidFlag, theNullPixelArray, theNullValuesValidFlag, theNumberOfBands, theRgbBands, and theScalarType.

{
   if( this != &rhs )
   {
      clear();
      theMinValuesValidFlag  = rhs.theMinValuesValidFlag;
      theMaxValuesValidFlag  = rhs.theMaxValuesValidFlag;
      theNullValuesValidFlag = rhs.theNullValuesValidFlag;
      theNumberOfBands       = rhs.theNumberOfBands;
      theScalarType          = rhs.theScalarType;
      theBytesPerPixel       = rhs.theBytesPerPixel;
      if(theNumberOfBands)
      {
         theNullPixelArray = new double[theNumberOfBands];
         theMinPixelArray  = new double[theNumberOfBands];
         theMaxPixelArray  = new double[theNumberOfBands];
         
         std::copy(rhs.theNullPixelArray,
                   rhs.theNullPixelArray+theNumberOfBands,
                   theNullPixelArray);
         std::copy(rhs.theMinPixelArray,
                   rhs.theMinPixelArray+theNumberOfBands,
                   theMinPixelArray);
         std::copy(rhs.theMaxPixelArray,
                   rhs.theMaxPixelArray+theNumberOfBands,
                   theMaxPixelArray);
      }
      theRgbBands = rhs.theRgbBands;
   }
   return *this;
}

print()

std::ostream & ossimImageMetaData::print

(

std::ostream &

out

)

const

Print method.

Returns

std::ostream&

Definition at line 541 of file ossimImageMetaData.cpp.

References saveState().

Referenced by operator<<().

{
   ossimKeywordlist kwl;
   saveState( kwl, 0 );
   out << kwl << std::endl;
   return out;
}

saveState()

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

Definition at line 241 of file ossimImageMetaData.cpp.

References ossimKeywordlist::add(), ossimKeywordNames::BAND_KW, ossimString::c_str(), ossimScalarTypeLut::instance(), ossimKeywordNames::MAX_VALUE_KW, ossimKeywordNames::MIN_VALUE_KW, ossimKeywordNames::NULL_VALUE_KW, ossimKeywordNames::NUMBER_BANDS_KW, ossimKeywordNames::SCALAR_TYPE_KW, theBytesPerPixel, theMaxPixelArray, theMinPixelArray, theNullPixelArray, theNumberOfBands, theRgbBands, theScalarType, ossimString::toString(), and true.

Referenced by print(), and ossimGeneralRasterInfo::saveState().

{
   kwl.add(prefix, "type", "ossimImageMetaData", true);
   if ( theNumberOfBands )
   {
      ossim_uint32 band = 0;
      
      for (band=0; band < theNumberOfBands; ++band)
      {
         ossimString kwMin = (ossimKeywordNames::BAND_KW +
                              ossimString::toString(band+1) + "." +
                              ossimKeywordNames::MIN_VALUE_KW);
         ossimString kwMax = (ossimKeywordNames::BAND_KW +
                              ossimString::toString(band+1) + "." +
                              ossimKeywordNames::MAX_VALUE_KW);
         ossimString kwNull = (ossimKeywordNames::BAND_KW +
                               ossimString::toString(band+1) + "." +
                               ossimKeywordNames::NULL_VALUE_KW);
         
         kwl.add(prefix,
                 kwMin.c_str(),
                 theMinPixelArray[band],
                 true);
         kwl.add(prefix,
                 kwMax.c_str(),
                 theMaxPixelArray[band],
                 true);
         kwl.add(prefix,
                 kwNull.c_str(),
                 theNullPixelArray[band],
                 true);
      }
      // std::cout << "added bands ******************" << std::endl;
      kwl.add(prefix,
          ossimKeywordNames::NUMBER_BANDS_KW,
          theNumberOfBands,
          true);
      kwl.add(prefix,
          ossimKeywordNames::SCALAR_TYPE_KW,
          (ossimScalarTypeLut::instance()->getEntryString(theScalarType)),
          true);

      kwl.add( prefix, "bytes_per_pixel", theBytesPerPixel, true );
   }

   if ( theRgbBands.size() )
   {
      kwl.add( prefix, "rgb_bands", theRgbBands.c_str(), true );
   }   

   return true;
}

setDefaultsForArrays()

void ossimImageMetaData::setDefaultsForArrays

(

)

Definition at line 157 of file ossimImageMetaData.cpp.

References ossim::defaultMax(), ossim::defaultMin(), ossim::defaultNull(), theMaxPixelArray, theMinPixelArray, theNullPixelArray, theNumberOfBands, and theScalarType.

Referenced by ossimImageMetaData(), and setNumberOfBands().

{
   ossim_uint32 i=0;
   
   for(i = 0; i < theNumberOfBands; ++i)
   {
      theNullPixelArray[i] = ossim::defaultNull(theScalarType);
      theMinPixelArray[i]  = ossim::defaultMin(theScalarType);
      theMaxPixelArray[i]  = ossim::defaultMax(theScalarType);
   }
}

setMaxPix()

void ossimImageMetaData::setMaxPix	(	ossim_uint32	band,
		double	pix
	)

Definition at line 347 of file ossimImageMetaData.cpp.

References theMaxPixelArray, and theNumberOfBands.

Referenced by ossimERSTileSource::open(), and ossimImageHandler::setMaxPixelValue().

{
   if((band < theNumberOfBands) && theMaxPixelArray)
   {
      theMaxPixelArray[band] = pix;
   }
}

setMaxValuesValid()

void ossimImageMetaData::setMaxValuesValid

(

bool

flag

)

Definition at line 415 of file ossimImageMetaData.cpp.

References theMaxValuesValidFlag.

{
   theMaxValuesValidFlag = flag;
}

setMinPix()

void ossimImageMetaData::setMinPix	(	ossim_uint32	band,
		double	pix
	)

Definition at line 339 of file ossimImageMetaData.cpp.

References theMinPixelArray, and theNumberOfBands.

Referenced by ossimERSTileSource::open(), and ossimImageHandler::setMinPixelValue().

{
   if((band < theNumberOfBands)&&(theMinPixelArray))
   {
      theMinPixelArray[band] = pix;
   }
}

setMinValuesValid()

void ossimImageMetaData::setMinValuesValid

(

bool

flag

)

Definition at line 410 of file ossimImageMetaData.cpp.

References theMinValuesValidFlag.

{
   theMinValuesValidFlag = flag;
}

setNullPix()

void ossimImageMetaData::setNullPix	(	ossim_uint32	band,
		double	pix
	)

Definition at line 355 of file ossimImageMetaData.cpp.

References theNullPixelArray, and theNumberOfBands.

Referenced by ossimGeneralRasterInfo::initializeFromHdr(), ossimERSTileSource::open(), and ossimImageHandler::setNullPixelValue().

{
   if((band < theNumberOfBands)&&(theNullPixelArray))
   {
      theNullPixelArray[band] = pix;
   }
}

setNullValuesValid()

void ossimImageMetaData::setNullValuesValid

(

bool

flag

)

Definition at line 420 of file ossimImageMetaData.cpp.

References theNullValuesValidFlag.

Referenced by ossimGeneralRasterInfo::initializeFromHdr().

{
   theNullValuesValidFlag = flag;
}

setNumberOfBands()

void ossimImageMetaData::setNumberOfBands

(

ossim_uint32

numberOfBands

)

Definition at line 169 of file ossimImageMetaData.cpp.

References setDefaultsForArrays(), theMaxPixelArray, theMinPixelArray, theNullPixelArray, and theNumberOfBands.

Referenced by ossimGeneralRasterInfo::initializeFromEnviHdr(), ossimGeneralRasterInfo::initializeFromHdr(), ossimGeneralRasterInfo::initializeFromXml(), loadState(), and updateMetaData().

{
   if(theNullPixelArray)
   {
      delete [] theNullPixelArray;
      theNullPixelArray = 0;
   }
   if(theMinPixelArray)
   {
      delete [] theMinPixelArray;
      theMinPixelArray = 0;
   }
   if(theMaxPixelArray)
   {
      delete [] theMaxPixelArray;
      theMaxPixelArray = 0;
   }
   
   theNumberOfBands = numberOfBands;

   if(theNumberOfBands)
   {
      theNullPixelArray = new double[theNumberOfBands];
      theMinPixelArray  = new double[theNumberOfBands];
      theMaxPixelArray  = new double[theNumberOfBands];
   
      setDefaultsForArrays();
   }
}

setScalarType()

void ossimImageMetaData::setScalarType

(

ossimScalarType

aType

)

Definition at line 323 of file ossimImageMetaData.cpp.

References ossim::scalarSizeInBytes(), theBytesPerPixel, and theScalarType.

Referenced by ossimGeneralRasterInfo::initializeFromEnviHdr(), ossimGeneralRasterInfo::initializeFromHdr(), ossimGeneralRasterInfo::initializeFromXml(), and ossimImageHandler::loadMetaData().

{
   theScalarType    = aType;
   theBytesPerPixel = ossim::scalarSizeInBytes( aType );
}

updateMetaData()

void ossimImageMetaData::updateMetaData	(	const ossimKeywordlist &	kwl,
		const std::string &	prefix
	)

Method to update band values.

Assumes a previous initialization and does not error out if band data is not found. This does NOT clear the object prior to loading like the loadState(...) method. Can be used to update min/max values from a "compute min max".

Parameters

kwl	Keyword list to initialize from.
prefix	Prefix, e.g. "image0.".

Definition at line 447 of file ossimImageMetaData.cpp.

References ossimString::empty(), ossimKeywordlist::findKey(), getBandCount(), ossimScalarTypeLut::getScalarTypeFromString(), ossimKeywordlist::getSubstringKeyList(), ossimScalarTypeLut::instance(), ossimKeywordNames::MAX_VALUE_KW, ossimKeywordNames::MIN_VALUE_KW, ossimKeywordNames::NULL_VALUE_KW, OSSIM_SCALAR_UNKNOWN, ossimKeywordNames::SCALAR_TYPE_KW, ossim::scalarSizeInBytes(), setNumberOfBands(), ossimString::size(), ossimString::string(), theBytesPerPixel, theMaxPixelArray, theMinPixelArray, theNullPixelArray, theNumberOfBands, theScalarType, ossimString::toFloat64(), and ossimString::toString().

Referenced by loadState().

{
   ossimString value;
   std::string key;
   
   // Get the bands:
   if ( !theNumberOfBands )
   {
      ossim_uint32 bands = getBandCount( kwl, prefix );
      if ( bands )
      {
         setNumberOfBands( bands );
      }
   }

   if ( theNumberOfBands )
   {
      //---
      // See if bands are zero or one based.  Bands are ONE based in the "omd"
      // file! If band0 is present assume zero based.
      //---

      ossimString regExpression = std::string("^(") + prefix + std::string("band0+.)");
      std::vector<ossimString> keys = kwl.getSubstringKeyList( regExpression );

      ossim_uint32 startBand = (keys.size() ? 0 : 1);

      ossim_uint32 limit = theNumberOfBands+startBand; // For for loop:
      
      std::string bs = "band"; // band sting
      std::string base;
      
      for ( ossim_uint32 band = startBand; band < limit; ++band )
      {
         base = bs + ossimString::toString( band ).string() + std::string(".") ;

         // Min:
         key = base + std::string(ossimKeywordNames::MIN_VALUE_KW);
         value =  kwl.findKey( prefix, key );
         
         if ( value.size() )
         {
            theMinPixelArray[ band - startBand  ] = value.toFloat64();
         }

         // Max:
         key = base + std::string(ossimKeywordNames::MAX_VALUE_KW);
         value =  kwl.findKey( prefix, key );
         if ( value.size() )
         {
            theMaxPixelArray[ band - startBand ] = value.toFloat64();
         }

         // Null:
         key = base + std::string(ossimKeywordNames::NULL_VALUE_KW);
         value =  kwl.findKey( prefix, key );
         if ( value.size() )
         {
            theNullPixelArray[ band - startBand ] = value.toFloat64();
         }
      }
   }

   
   // Scalar, only look for if not set.
   if ( theScalarType == OSSIM_SCALAR_UNKNOWN )
   {
      key = ossimKeywordNames::SCALAR_TYPE_KW; // "scalar_type"
      value.string() = kwl.findKey( prefix, key );
      if ( value.empty() )
      {
         key = "radiometry";
         value.string() = kwl.findKey( prefix, key );
      }
      if ( value.size() )
      {
         theScalarType = ossimScalarTypeLut::instance()->getScalarTypeFromString( value );
      }
      
      if ( theScalarType != OSSIM_SCALAR_UNKNOWN )
      {
         theBytesPerPixel = ossim::scalarSizeInBytes( theScalarType );
      }
   }

   if (traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "ossimImageMetaData::updateMetaData DEBUG"
         << *this << std::endl;
   }
}

Friends And Related Function Documentation

operator<<

OSSIM_DLL std::ostream& operator<< ( std::ostream &  out, const ossimImageMetaData &  obj  )

friend

Note

Since the print method is virtual, derived classes only need to implement that, not an addition operator<<.

Definition at line 549 of file ossimImageMetaData.cpp.

{
   return obj.print( out );
}

Member Data Documentation

theBytesPerPixel

ossim_uint32 ossimImageMetaData::theBytesPerPixel

private

Definition at line 156 of file ossimImageMetaData.h.

Referenced by clear(), getBytesPerPixel(), operator=(), ossimImageMetaData(), saveState(), setScalarType(), and updateMetaData().

theMaxPixelArray

double* ossimImageMetaData::theMaxPixelArray

private

Definition at line 149 of file ossimImageMetaData.h.

Referenced by clear(), getMaxPix(), getMaxPixelArray(), operator=(), ossimImageMetaData(), saveState(), setDefaultsForArrays(), setMaxPix(), setNumberOfBands(), and updateMetaData().

theMaxValuesValidFlag

bool ossimImageMetaData::theMaxValuesValidFlag

private

Definition at line 152 of file ossimImageMetaData.h.

Referenced by getMaxValuesValidFlag(), loadState(), operator=(), and setMaxValuesValid().

theMinPixelArray

double* ossimImageMetaData::theMinPixelArray

private

Definition at line 148 of file ossimImageMetaData.h.

Referenced by clear(), getMinPix(), getMinPixelArray(), operator=(), ossimImageMetaData(), saveState(), setDefaultsForArrays(), setMinPix(), setNumberOfBands(), and updateMetaData().

theMinValuesValidFlag

bool ossimImageMetaData::theMinValuesValidFlag

private

Definition at line 151 of file ossimImageMetaData.h.

Referenced by getMinValuesValidFlag(), loadState(), operator=(), and setMinValuesValid().

theNullPixelArray

double* ossimImageMetaData::theNullPixelArray

private

Definition at line 147 of file ossimImageMetaData.h.

Referenced by clear(), getNullPix(), getNullPixelArray(), operator=(), ossimImageMetaData(), saveState(), setDefaultsForArrays(), setNullPix(), setNumberOfBands(), and updateMetaData().

theNullValuesValidFlag

bool ossimImageMetaData::theNullValuesValidFlag

private

Definition at line 153 of file ossimImageMetaData.h.

Referenced by getNullValuesValidFlag(), loadState(), operator=(), and setNullValuesValid().

theNumberOfBands

ossim_uint32 ossimImageMetaData::theNumberOfBands

private

Definition at line 157 of file ossimImageMetaData.h.

Referenced by clear(), getMaxPix(), getMinPix(), getNullPix(), getNumberOfBands(), getRgbBands(), isValid(), operator=(), ossimImageMetaData(), saveState(), setDefaultsForArrays(), setMaxPix(), setMinPix(), setNullPix(), setNumberOfBands(), and updateMetaData().

theRgbBands

std::string ossimImageMetaData::theRgbBands

private

Definition at line 164 of file ossimImageMetaData.h.

Referenced by clear(), getRgbBands(), loadState(), operator=(), and saveState().

theScalarType

ossimScalarType ossimImageMetaData::theScalarType

private

Definition at line 155 of file ossimImageMetaData.h.

Referenced by clear(), getMaxPix(), getMinPix(), getNullPix(), getScalarType(), operator=(), saveState(), setDefaultsForArrays(), setScalarType(), and updateMetaData().

---

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

• ossimImageMetaData.h
• ossimImageMetaData.cpp