ossimEnviHeader Class Reference

Class for reading and writing an ENVI (The Environment for Visualizing Images) header file. More...

#include <ossimEnviHeader.h>

Inheritance diagram for ossimEnviHeader:

Public Member Functions
	ossimEnviHeader ()
	default construtor More...
virtual	~ossimEnviHeader ()
	virtual destructor More...
virtual void	reset ()
const ossimKeywordlist &	getMap () const
ossimKeywordlist &	getMap ()
bool	getValue (const ossimString &key, ossimString &value) const
	Gets value for key. More...
bool	findCaseInsensitive (const ossimString &key, ossimString &value) const
	Gets value for key. More...
bool	findSubStringCaseInsensitive (const ossimString &key, ossimString &value) const
	Gets value for key. More...
bool	open (const ossimFilename &file)
	Opens an envi header. More...
bool	writeFile (const ossimFilename &file)
	Writes header to file in a standard envi format. More...
std::ostream &	print (std::ostream &out) const
	Prints header to out in a standard envi format. More...
ossimString	getDescription () const
void	setDescription (const ossimString &description)
ossim_uint32	getSamples () const
void	setSamples (ossim_uint32 samples)
	Sets the number of samples. More...
ossim_uint32	getLines () const
void	setLines (ossim_uint32 lines)
	Sets the number of lines. More...
ossim_uint32	getBands () const
void	setBands (ossim_uint32 bands)
	Sets the number of bands. More...
bool	getDefaultBands (std::vector< ossim_uint32 > &bands) const
	Gets default bands if "default bands" keyword is present. More...
bool	getRgbBandsFromWaveLength (std::vector< ossim_uint32 > &bands) const
	Gets rgb bands if "wavelength" keyword is present. More...
ossim_uint32	getHeaderOffset () const
void	setHeaderOffset (ossim_uint32 headerOffset)
	Sets the header offset in bytes. More...
ossimString	getFileType () const
void	setFileType (const ossimString &fileType)
	Sets the file type. More...
ossim_uint32	getDataType () const
ossimScalarType	getOssimScalarType () const
void	setDataType (ossimScalarType scalar)
	Sets the envi data type based on the ossimScalarType. More...
ossimString	getInterleaveType () const
ossimInterleaveType	getOssimInterleaveType () const
void	setInterleaveType (ossimInterleaveType interleave)
	Sets the envi interleave type string based on the ossimInterleaveType. More...
ossimString	getSensorType () const
void	setSensorType (const ossimString &sensorType)
	Sets the envi sensor type string. More...
ossimByteOrder	getByteOrder () const
void	setByteorder (ossimByteOrder byteOrder)
	Sets the envi byte order from the ossimByteOrder. More...
ossim_int32	getXStart () const
void	setXStart (ossim_int32 xstart)
	Sets the x start. More...
ossim_int32	getYStart () const
void	setYStart (ossim_int32 ystart)
	Sets the y start. More...
ossimString	getMapInfo () const
void	setMapInfo (const ossimString &mapInfo)
	Sets the envi map info string. More...
void	setMapInfo (const ossimKeywordlist &kwl, const char *prefix=0)
	Sets the envi map info string from a keyword list containing geometry information. More...
ossimString	getWavelengthUnits () const
void	setWavelengthUnits (const ossimString &wavelenghtUnits)
	Sets the envi wavelength units string. More...
void	getBandNames (std::vector< ossimString > &bandNames) const
void	setBandNames (const std::vector< ossimString > &bandNames)
	Sets the band name string vector. More...
void	getWavelengths (std::vector< ossimString > &wavelengths) const
void	setWavelengths (const std::vector< ossimString > &wavelengths)
	Sets the envi band name string. More...
bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)
	Method to the load (recreate) the state of the object from a keyword list. More...
const ossimFilename &	getFile () const
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

Static Public Member Functions
static bool	isEnviHeader (const ossimFilename &file)
	Global method to test first line of file for "ENVI". More...
static bool	isEnviHeader (std::istream &in)
	Global method to test first line of stream for "ENVI". More...

Private Member Functions
bool	rangeCheckBands (const std::vector< ossim_uint32 > &bands) const
	Check band list to see if any are outside of range of bands. More...
bool	readStream (std::istream &in)
	Parses stream. More...

Private Attributes
ossimFilename	m_file
ossimKeywordlist	m_keywords

Friends
OSSIM_DLL std::ostream &	operator<< (std::ostream &out, const ossimEnviHeader &obj)
	friend operator<< More...

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

Detailed Description

Class for reading and writing an ENVI (The Environment for Visualizing Images) header file.

Definition at line 30 of file ossimEnviHeader.h.

Constructor & Destructor Documentation

ossimEnviHeader()

ossimEnviHeader::ossimEnviHeader

(

)

default construtor

Definition at line 66 of file ossimEnviHeader.cpp.

References m_keywords.

   :
   m_file(),
   m_keywords()
{
   // Start the byte order of with the machine byte order.
   m_keywords[FILE_TYPE_KW] = "ENVI Standard";
   setByteorder(ossim::byteOrder());   
}

~ossimEnviHeader()

ossimEnviHeader::~ossimEnviHeader ( )

virtual

virtual destructor

Definition at line 76 of file ossimEnviHeader.cpp.

{
}

Member Function Documentation

findCaseInsensitive()

bool ossimEnviHeader::findCaseInsensitive	(	const ossimString &	key,
		ossimString &	value
	)		const

Gets value for key.

Parameters

key
value

Returns

true if key is in map even if value is empty; false, if not.

findSubStringCaseInsensitive()

bool ossimEnviHeader::findSubStringCaseInsensitive	(	const ossimString &	key,
		ossimString &	value
	)		const

Gets value for key.

Parameters

key
value

Returns

true if key is in map even if value is empty; false, if not.

Definition at line 113 of file ossimEnviHeader.cpp.

References ossimKeywordlist::findValue(), and m_keywords.

{
   return m_keywords.findValue<KwlKeySubStringCaseInsensitive>(
      value, KwlKeySubStringCaseInsensitive(key));
}

getBandNames()

void ossimEnviHeader::getBandNames

(

std::vector< ossimString > &

bandNames

)

const

Parameters

bandNames

Vector of strings to initialize with band names.

Definition at line 690 of file ossimEnviHeader.cpp.

References m_keywords, and ossimString::split().

{
   bandNames.clear();
   ossimString bandNamesString = m_keywords["band names"];
   bandNamesString.split(bandNames, ",");
}

getBands()

ossim_uint32 ossimEnviHeader::getBands

(

)

const

Returns

The number of bands.

Definition at line 271 of file ossimEnviHeader.cpp.

References ossimKeywordlist::findKey(), m_keywords, ossimString::size(), and ossimString::toUInt32().

Referenced by ossimGeneralRasterInfo::initializeFromEnviHdr(), rangeCheckBands(), and ossimAlphaSensorSupportData::readHdrFile().

{
   ossim_uint32 result = 0;
   ossimString value = m_keywords.findKey( std::string("bands") );
   if( value.size() )
   {
      result = value.toUInt32();
   }
   return result;
}

getByteOrder()

ossimByteOrder ossimEnviHeader::getByteOrder

(

)

const

Returns

If key "byte order" found returns the envi byte order; else, system byte order.

Note

(Same as the ossimByteOrder enumeration): 0 = LITTLE_ENDIAN, 1 = BIG_ENDIAN

Definition at line 510 of file ossimEnviHeader.cpp.

References ossim::byteOrder(), m_keywords, OSSIM_BIG_ENDIAN, OSSIM_LITTLE_ENDIAN, and ossimString::toInt32().

Referenced by ossimGeneralRasterInfo::initializeFromEnviHdr().

{
   ossimByteOrder result = ossim::byteOrder(); // System byte order.
   std::string value = m_keywords["byte order"];
   if ( value.size() )
   {
      // 0 = LITTLE_ENDIAN
      // 1 = BIG_ENDIAN
      ossim_int32 order = ossimString(value).toInt32();
      result = order ? OSSIM_BIG_ENDIAN : OSSIM_LITTLE_ENDIAN;
   }
   return result;
}

getDataType()

ossim_uint32 ossimEnviHeader::getDataType

(

)

const

Returns

The envi data type..

Definition at line 366 of file ossimEnviHeader.cpp.

References m_keywords, and ossimString::toUInt32().

{
   return ossimString(m_keywords["data type"]).toUInt32();
}

getDefaultBands()

bool ossimEnviHeader::getDefaultBands

(

std::vector< ossim_uint32 > &

bands

)

const

Gets default bands if "default bands" keyword is present.

Parameters

bands

Initialized by this.

Returns

true on success, false if keyword not found. "bands" will be zeroed out on failure.

Definition at line 287 of file ossimEnviHeader.cpp.

References ossimKeywordlist::findKey(), m_keywords, ossimNotify(), ossimNotifyLevel_WARN, rangeCheckBands(), ossimString::size(), ossimString::split(), and true.

{
   bands.clear();

   // Note: We could do a "m_map.downcaseKeywords()". (drb)
   ossimString value = m_keywords.findKey( std::string("default bands") );
   if ( !value.size() )
   {
      value = m_keywords.findKey( std::string("Default bands") );
      if ( !value.size() )
      {
        value = m_keywords.findKey( std::string("DEFAULT BANDS") );
      }
   }

   if ( value.size() )
   {
      std::vector<ossimString> strLst;
      value.split( strLst, ossimString(","));
      if ( strLst.size() )
      {
         std::vector<ossimString>::const_iterator i = strLst.begin();
         ossim_uint32 band = 0;
         while ( i != strLst.end() )
         {
            band = (*i).toUInt32();
            if ( band )
            {
               // Assuming "default bands" are one based.  Totally a hunch... (drb)
               --band;
               bands.push_back(band);
            }
            else
            {
               ossimNotify(ossimNotifyLevel_WARN)
                  << "ossimEnviHeader::getDefaultBands WARN!"
                  << "\nDetected zero based bands in \"default bands\" from header!"
                  << std::endl;
            }
            
            ++i;
         }
      }
   }

   if ( rangeCheckBands( bands ) == false )
   {
      bands.clear();
   }
   
   return (bands.size() ? true : false);
}

getDescription()

ossimString ossimEnviHeader::getDescription

(

)

const

Returns

The description of the file.

Definition at line 229 of file ossimEnviHeader.cpp.

References ossimKeywordlist::findKey(), and m_keywords.

{
   return ossimString( m_keywords.findKey( std::string("description") ) );
}

getFile()

const ossimFilename & ossimEnviHeader::getFile

(

)

const

Returns

Path to envi header file.

Definition at line 928 of file ossimEnviHeader.cpp.

References m_file.

Referenced by ossimAlphaSensorSupportData::readHdrFile(), and ossimAlphaSensorSupportData::readSupportFiles().

{
   return m_file;
}

getFileType()

ossimString ossimEnviHeader::getFileType

(

)

const

Returns

The file type

Definition at line 356 of file ossimEnviHeader.cpp.

References m_keywords.

{
   return m_keywords[FILE_TYPE_KW];
}

getHeaderOffset()

ossim_uint32 ossimEnviHeader::getHeaderOffset

(

)

const

Returns

The number of header offset in bytes.

Definition at line 340 of file ossimEnviHeader.cpp.

References m_keywords, ossimString::size(), and ossimString::toUInt32().

Referenced by ossimGeneralRasterInfo::initializeFromEnviHdr().

{
   ossim_uint32 result = 0;
   ossimString value = m_keywords["header offset"];
   if( value.size() )
   {
      result = value.toUInt32();
   }
   return result;
}

getInterleaveType()

ossimString ossimEnviHeader::getInterleaveType

(

)

const

Returns

The envi interleave type.

Definition at line 454 of file ossimEnviHeader.cpp.

References m_keywords.

Referenced by getOssimInterleaveType().

{
   return m_keywords["interleave"];
}

getLines()

ossim_uint32 ossimEnviHeader::getLines

(

)

const

Returns

The number of lines.

Definition at line 255 of file ossimEnviHeader.cpp.

References ossimKeywordlist::findKey(), m_keywords, ossimString::size(), and ossimString::toUInt32().

Referenced by ossimGeneralRasterInfo::initializeFromEnviHdr(), and ossimAlphaSensorSupportData::readHdrFile().

{
   ossim_uint32 result = 0;
   ossimString value = m_keywords.findKey( std::string("lines") );
   if( value.size() )
   {
      result = value.toUInt32();
   }
   return result;
}

getMap() [1/2]

const ossimKeywordlist & ossimEnviHeader::getMap

(

)

const

Returns

Const reference to map.

Definition at line 88 of file ossimEnviHeader.cpp.

References m_keywords.

Referenced by ossimEnviInfo::print().

{
   return m_keywords;
}

getMap() [2/2]

ossimKeywordlist & ossimEnviHeader::getMap

(

)

Returns

Reference to map.

Definition at line 93 of file ossimEnviHeader.cpp.

References m_keywords.

{
   return m_keywords;
}

getMapInfo()

ossimString ossimEnviHeader::getMapInfo

(

)

const

Returns

The envi map info string.

Definition at line 576 of file ossimEnviHeader.cpp.

References m_keywords.

{
   return m_keywords["map info"];
}

getOssimInterleaveType()

ossimInterleaveType ossimEnviHeader::getOssimInterleaveType

(

)

const

Returns

The ossimInterleaveType from the envi interleave..

Definition at line 458 of file ossimEnviHeader.cpp.

References getInterleaveType(), OSSIM_BIL, OSSIM_BIP, OSSIM_BSQ, and OSSIM_INTERLEAVE_UNKNOWN.

Referenced by ossimGeneralRasterInfo::initializeFromEnviHdr().

{
   ossimString interleave = getInterleaveType();
   if (interleave == "bsq")
   {
      return OSSIM_BSQ;
   }
   else if  (interleave == "bil")
   {
      return OSSIM_BIL;
   }
   else if  (interleave == "bip")
   {
      return OSSIM_BIP;
   }
   else
   {
      return OSSIM_INTERLEAVE_UNKNOWN;
   }
}

getOssimScalarType()

ossimScalarType ossimEnviHeader::getOssimScalarType

(

)

const

Returns

The ossimScalarType from the envi data type..

Definition at line 371 of file ossimEnviHeader.cpp.

References m_keywords, OSSIM_CFLOAT32, OSSIM_CFLOAT64, OSSIM_FLOAT32, OSSIM_FLOAT64, OSSIM_SCALAR_UNKNOWN, OSSIM_SINT16, OSSIM_SINT32, OSSIM_UINT16, OSSIM_UINT32, OSSIM_UINT8, and ossimString::toUInt32().

Referenced by ossimGeneralRasterInfo::initializeFromEnviHdr().

{
   ossim_uint32 dataTypeInt = ossimString(m_keywords["data type"]).toUInt32();
   
   ossimScalarType result = OSSIM_SCALAR_UNKNOWN;

   switch( dataTypeInt )
   {
      case 1:
         result = OSSIM_UINT8;
         break;
      case 2:
         result = OSSIM_SINT16;
         break;
      case 3:
         result = OSSIM_SINT32;
         break;
      case 4:
         result = OSSIM_FLOAT32;
         break;
      case 5:
         result = OSSIM_FLOAT64;
         break;
      case 6:
         result = OSSIM_CFLOAT32;
         break;
      case 9:
         result = OSSIM_CFLOAT64;
         break;
      case 12:
         result = OSSIM_UINT16;
         break;
      case 13:
         result = OSSIM_UINT32;
         break;
      default:
         break;
   }

   return result;
}

getRgbBandsFromWaveLength()

bool ossimEnviHeader::getRgbBandsFromWaveLength

(

std::vector< ossim_uint32 > &

bands

)

const

Gets rgb bands if "wavelength" keyword is present.

Parameters

bands

Initialized by this.

Returns

true on success, false if keyword not found. "bands" will be zeroed out on failure.

getSamples()

ossim_uint32 ossimEnviHeader::getSamples

(

)

const

Returns

The number of samples.

Definition at line 239 of file ossimEnviHeader.cpp.

References ossimKeywordlist::findKey(), m_keywords, ossimString::size(), and ossimString::toUInt32().

Referenced by ossimGeneralRasterInfo::initializeFromEnviHdr(), and ossimAlphaSensorSupportData::readHdrFile().

{
   ossim_uint32 result = 0;
   ossimString value = m_keywords.findKey( std::string("samples") );
   if( value.size() )
   {
      result = value.toUInt32();
   }
   return result;
}

getSensorType()

ossimString ossimEnviHeader::getSensorType

(

)

const

Returns

The sensor type..

Definition at line 500 of file ossimEnviHeader.cpp.

References m_keywords.

Referenced by ossimAlphaSensorSupportData::readHdrFile().

{
   return m_keywords["sensor type"];
}

getValue()

bool ossimEnviHeader::getValue	(	const ossimString &	key,
		ossimString &	value
	)		const

Gets value for key.

Parameters

key	To search for.
value	Initialized by this.

Returns

true on success, false on error. This will return true if key is found, even if value is empty.

Definition at line 98 of file ossimEnviHeader.cpp.

References ossimKeywordlist::findKey(), ossimKeywordlist::hasKey(), m_keywords, ossimString::size(), and ossimString::string().

Referenced by ossimWavelength::initialize(), and ossimAlphaSensorSupportData::readHdrFile().

{
   bool result = false;
   value.string() = m_keywords.findKey( key.string());
   if( value.size() )
   {
      result = true;
   }
   else
   {
      result = m_keywords.hasKey( key.string() );
   }
   return result;
}

getWavelengths()

void ossimEnviHeader::getWavelengths

(

std::vector< ossimString > &

wavelengths

)

const

Parameters

wavelengths

Vector of strings to initialize with wave lengths.

Definition at line 704 of file ossimEnviHeader.cpp.

References m_keywords.

{
   waveLengths.clear();
   ossimString bandNamesString = m_keywords[WAVELENGTH_KW];
   bandNamesString.split(waveLengths, ",");
}

getWavelengthUnits()

ossimString ossimEnviHeader::getWavelengthUnits

(

)

const

Returns

The env wavelength units..

Definition at line 679 of file ossimEnviHeader.cpp.

References m_keywords.

{
   return m_keywords["wavelength units"];
}

getXStart()

ossim_int32 ossimEnviHeader::getXStart

(

)

const

Returns

The x start.

Definition at line 536 of file ossimEnviHeader.cpp.

References ossimKeywordlist::findKey(), m_keywords, and ossimString::toInt32().

Referenced by ossimGeneralRasterInfo::initializeFromEnviHdr().

{
   ossim_int32 result = 0;
   std::string s = m_keywords.findKey( std::string("x start") );
   if ( !s.size() )
   {
      s = m_keywords.findKey( std::string("sample start") );
   }
   if ( s.size() )
   {
      result = ossimString( s ).toInt32();
   }
   return result;
}

getYStart()

ossim_int32 ossimEnviHeader::getYStart

(

)

const

Returns

The x start.

Definition at line 556 of file ossimEnviHeader.cpp.

References ossimKeywordlist::findKey(), m_keywords, and ossimString::toInt32().

Referenced by ossimGeneralRasterInfo::initializeFromEnviHdr().

{
   ossim_int32 result = 0;
   std::string s = m_keywords.findKey( std::string("y start") );
   if ( !s.size() )
   {
      s = m_keywords.findKey( std::string("line start") );
   }
   if ( s.size() )
   {
      result = ossimString( s ).toInt32();
   }
   return result;
}

isEnviHeader() [1/2]

bool ossimEnviHeader::isEnviHeader ( const ossimFilename &  file )

static

Global method to test first line of file for "ENVI".

Returns

true on success, false on error.

Definition at line 900 of file ossimEnviHeader.cpp.

References ossimString::c_str().

Referenced by ossimEnviInfo::open(), and readStream().

{
   bool result = false;
   std::ifstream in;
   in.open(file.c_str(), std::ios::in | std::ios::binary);
   if ( in.is_open() )
   {
      result = isEnviHeader( in );
      in.close();
   }
   return result;
}

isEnviHeader() [2/2]

bool ossimEnviHeader::isEnviHeader ( std::istream &  in )

static

Global method to test first line of stream for "ENVI".

Returns

true on success, false on error.

Definition at line 913 of file ossimEnviHeader.cpp.

References ossim::skipws().

{
   bool result = false;
   ossim::skipws(in);
   char eh[5];
   in.read(eh, 4);
   eh[4] = '\0';
   std::string s(eh);
   if ( s == "ENVI" )
   {
      result = true;
   }
   return result;
}

loadState()

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

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

Parameters

kwl	Keyword list to initialize from.
prefix	Usually something like: "object1."

Returns

This method will alway return true as it is intended to be used in conjuction with the set methods.

Keywords picked up by loadState:

description: My_file

number_samples: 1024

number_lines: 512

number_bands: 3

header_offset: 0

file_type: ENVI Standard

data_type: 1

interleave_type: bil

sensor_type: Unknown

(little_endian or big_endian) byte_order: little_endian

map_info: Unknown

wavelength_units:

band_name0: Red band band_name1: Green band band_name2: Blue band

wavelength0: 620.25 wavelength1: 514.5 wavelength2: 470.0

Definition at line 720 of file ossimEnviHeader.cpp.

References ossimKeywordNames::DESCRIPTION_KW, ossimKeywordNames::FILENAME_KW, ossimKeywordlist::findKey(), m_file, m_keywords, ossimKeywordNames::NUMBER_BANDS_KW, ossimKeywordNames::NUMBER_LINES_KW, ossimKeywordNames::NUMBER_SAMPLES_KW, reset(), setDescription(), and ossimString::string().

Referenced by ossimEnviHeaderFileWriter::loadState().

{
   std::string lookup;
   std::string pfx = (prefix ? prefix: "" );
   ossimString s;

   reset();

   lookup = kwl.findKey(pfx, std::string(ossimKeywordNames::FILENAME_KW));
   if (lookup.size())
   {
      m_file.string() = lookup;
   }
  
   lookup = kwl.findKey(pfx, std::string(ossimKeywordNames::DESCRIPTION_KW));
   if (lookup.size())
   {
      setDescription(lookup);
   }

   lookup = kwl.findKey(pfx, std::string(ossimKeywordNames::NUMBER_SAMPLES_KW));
   if (lookup.size())
   {
      m_keywords["samples"] = lookup;
   }
   
   lookup = kwl.findKey(pfx, std::string(ossimKeywordNames::NUMBER_LINES_KW));
   if (lookup.size())
   {
      m_keywords["lines"] = lookup;
   }

   lookup = kwl.findKey(pfx, std::string(ossimKeywordNames::NUMBER_BANDS_KW));
   if (lookup.size())
   {
      m_keywords["bands"] = lookup;
   }

   lookup = kwl.findKey(pfx, std::string(HEADER_OFFSET_KW));
   if (lookup.size())
   {
      m_keywords["header offset"] = lookup;
   }

   lookup = kwl.findKey(pfx, std::string(FILE_TYPE_KW));
   if (lookup.size())
   {
       m_keywords["file_type"] = lookup;
   }

   lookup = kwl.findKey(pfx, DATA_TYPE_KW);
   if (lookup.size())
   {
      m_keywords["data type"] = lookup;
   }

   lookup = kwl.findKey(pfx, std::string(ossimKeywordNames::INTERLEAVE_TYPE_KW));
   if (lookup.size())
   {
      m_keywords["interleave"] = lookup;
   }

   lookup = kwl.findKey(pfx, std::string(SENSOR_TYPE_KW));
   if (lookup.size())
   {
      m_keywords["sensor type"] = lookup;
   }

   lookup = kwl.findKey(pfx, std::string(ossimKeywordNames::BYTE_ORDER_KW));
   if (lookup.size())
   {
      s = lookup;
      s.downcase();
      if (s == "little_endian")
      {
         m_keywords["byte order"] = "0";
      }
      else if (s == "big_endian")
      {
         m_keywords["byte order"] = "1";
      }
      else
      {
         m_keywords["byte order"] = lookup;
      }
   }
   
   lookup = kwl.findKey(pfx, std::string(X_START_KW));
   if (lookup.size())
   {
      m_keywords["x start"] = lookup;
   }
   lookup = kwl.findKey(pfx, std::string(Y_START_KW));
   if (lookup.size())
   {
      m_keywords["y start"] = lookup;
   }

   lookup = kwl.findKey(pfx, std::string(MAP_INFO_KW));
   if (lookup.size())
   {
      m_keywords["map info"] = lookup;
   }

   lookup = kwl.findKey(pfx, std::string(WAVELENGTH_UNITS_KW));
   if (lookup.size())
   {
      m_keywords["wavelength units"] = lookup;
   }

   ossim_uint32 n;
   ossim_uint32 count;
   const ossim_uint32 MAX_TRIES = 1024; // Avoid infinate loop.
   
   // Get the band names.
   n = kwl.numberOf(prefix, BAND_NAME_KW);
   if (n)
   {
      ossimString value = "";
      count = 0;
      while ( (count < n) || (count > MAX_TRIES) )
      {
         s = BAND_NAME_KW;
         s += ossimString::toString(count);
         lookup = kwl.findKey(pfx, s.string());
         if (lookup.size())
         {
            if(!value.empty())
            {
               value += ossimString(lookup);
            }
            else
            {
               value += (", " + ossimString(lookup));

            }
            
         }
         ++count;
      }
      m_keywords["band names"] = value.c_str();
   }
            
   // Get the band names.
   n = kwl.numberOf(prefix, WAVELENGTH_KW);
   if (n)
   {
      ossimString value;
      count = 0;
      while ( (count < n) || (count > MAX_TRIES) )
      {
         s = WAVELENGTH_KW;
         s += ossimString::toString(count);
         lookup = kwl.findKey(pfx, s.string());
         if (lookup.size())
         {
            if(!value.empty())
            {
               value += ossimString(lookup);
            }
            else
            {
               value += (", " + ossimString(lookup));
            }
         }
         ++count;
      }
      m_keywords["wavelength"] = value.c_str();
   }
   if (traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "ossimEnviHeader::loadState DEUG\n";
      print(ossimNotify(ossimNotifyLevel_DEBUG));
   }
   
   return true;
}

open()

bool ossimEnviHeader::open

(

const ossimFilename &

file

)

Opens an envi header.

Returns

true on success, false on error.

Definition at line 120 of file ossimEnviHeader.cpp.

References ossimString::c_str(), m_file, readStream(), and reset().

Referenced by ossimGeneralRasterInfo::initializeFromEnviHdr(), ossimEnviInfo::print(), ossimAlphaSensorSupportData::readHdrFile(), and ossimAlphaSensorSupportData::readSupportFiles().

{
   bool result = false;

   reset(); // Clear the map, file name.

   std::ifstream in;
   in.open(file.c_str(), std::ios::in | std::ios::binary);
   if( in.is_open() )
   {
      result = readStream( in );
      if ( result )
      {
         m_file = file;
      }
   }

   return result;
}

print()

std::ostream & ossimEnviHeader::print

(

std::ostream &

out

)

const

Prints header to out in a standard envi format.

Parameters

out	Stream to write to.

Returns

Reference to the stream passed.

Definition at line 218 of file ossimEnviHeader.cpp.

References m_keywords.

Referenced by operator<<(), and writeFile().

{
   out << "ENVI" << "\n" << m_keywords << std::endl;
   return out;
}

rangeCheckBands()

bool ossimEnviHeader::rangeCheckBands ( const std::vector< ossim_uint32 > &  bands ) const

private

Check band list to see if any are outside of range of bands.

Bands should be zero base.

Returns

true if all bands are less than number of bands; false, if outside range or if "bands" key is not found.

Definition at line 933 of file ossimEnviHeader.cpp.

References getBands().

Referenced by getDefaultBands().

{
   bool result = false;
   const ossim_uint32 INPUT_BANDS = getBands();
   if ( INPUT_BANDS )
   {
      result = true;
      std::vector<ossim_uint32>::const_iterator i = bands.begin();
      while ( i != bands.end() )
      {
         if ( (*i) >= INPUT_BANDS )
         {
            result = false;
            break;
         }
         ++i;
      }
   }
   return result;
}

readStream()

bool ossimEnviHeader::readStream ( std::istream &  in )

private

Parses stream.

Returns

true on success, false on error.

Definition at line 140 of file ossimEnviHeader.cpp.

References ossimKeywordlist::add(), ossimKeywordlist::clear(), ossimKeywordlist::findKey(), isEnviHeader(), m_keywords, reset(), ossim::skipws(), and ossimString::trim().

Referenced by open().

{
   reset();
   bool result = isEnviHeader( in );
   if ( result )
   {
      m_keywords.clear();
      
      while(!in.eof()&&in.good())
      {
         // read name
         ossimString name = "";
         ossimString value = "";
         ossim::skipws(in);
         int c = static_cast<char>(in.get());
         while((c != '=')&&(in.good())&&!in.eof())
         {
            name +=static_cast<char>(c);
            c = in.get();
         }
         ossim::skipws(in);
         c = in.get();
         
         if(in.good()&&!in.eof())
         {
            if(c == '{') // continue til '}'
            {
               c = in.get();
               while((c != '}')&&(in.good())&&!in.eof())
               {
                  value +=static_cast<char>(c);
                  c = in.get();
               }
            }
            else
            {
               while(((c != '\n')&&(c!='\r'))&&(in.good())&&!in.eof())
               {
                  value +=static_cast<char>(c);
                  c = (in.get());
               }
               
            }
            m_keywords.add(name.trim(), value);
         }
      }

      // Test for minimum set of keywords needed.
      if ( m_keywords.findKey( std::string("samples") ).empty() ||
           m_keywords.findKey( std::string("lines") ).empty() || 
           m_keywords.findKey( std::string("bands") ).empty())
      {
         result =  false;
      }
   }

   return result;
}

reset()

void ossimEnviHeader::reset ( void  )

virtual

Definition at line 80 of file ossimEnviHeader.cpp.

References ossimKeywordlist::clear(), m_file, m_keywords, and ossimString::string().

Referenced by loadState(), open(), and readStream().

{
   m_file.string().clear();
   m_keywords.clear();
   m_keywords[FILE_TYPE_KW] = "ENVI Standard";
   setByteorder(ossim::byteOrder());
}

setBandNames()

void ossimEnviHeader::setBandNames

(

const std::vector< ossimString > &

bandNames

)

Sets the band name string vector.

Parameters

bandNames

Vector of band name strings.

Definition at line 697 of file ossimEnviHeader.cpp.

References ossimString::c_str(), ossimString::join(), and m_keywords.

{
   ossimString value;
   value.join(bandNames, ",");
   m_keywords["band names"] = value.c_str();
}

setBands()

void ossimEnviHeader::setBands

(

ossim_uint32

bands

)

Sets the number of bands.

Parameters

bands

The number of bands.

Definition at line 282 of file ossimEnviHeader.cpp.

References ossimString::c_str(), m_keywords, and ossimString::toString().

Referenced by ossimEnviHeaderFileWriter::writeFile().

{
   m_keywords["bands"] = ossimString::toString(bands).c_str();
}

setByteorder()

void ossimEnviHeader::setByteorder

(

ossimByteOrder

byteOrder

)

Sets the envi byte order from the ossimByteOrder.

Parameters

byteorder

The ossimByteOrder of the image.

Definition at line 524 of file ossimEnviHeader.cpp.

References ossim::byteOrder(), m_keywords, and OSSIM_LITTLE_ENDIAN.

{
   if(byteOrder==OSSIM_LITTLE_ENDIAN)
   {
      m_keywords["byte order"] = "0";
   }
   else
   {
      m_keywords["byte order"] = "1";
   }
}

setDataType()

void ossimEnviHeader::setDataType

(

ossimScalarType

scalar

)

Sets the envi data type based on the ossimScalarType.

Parameters

scalar

The ossimScalarType of the image.

Definition at line 413 of file ossimEnviHeader.cpp.

References ossimString::c_str(), ossimString::empty(), m_keywords, OSSIM_CFLOAT32, OSSIM_CFLOAT64, OSSIM_FLOAT32, OSSIM_FLOAT64, OSSIM_SINT16, OSSIM_SINT32, OSSIM_UINT16, OSSIM_UINT32, and OSSIM_UINT8.

{
   ossimString dataTypeString = "";
   switch( scalar )
   {
      case OSSIM_UINT8:
         dataTypeString = "1";
         break;
      case OSSIM_SINT16:
         dataTypeString = "2";
         break;
      case OSSIM_SINT32:
         dataTypeString = "3";
         break;
      case OSSIM_FLOAT32:
         dataTypeString = "4";
         break;
      case OSSIM_FLOAT64:
         dataTypeString = "5";
         break;
      case OSSIM_CFLOAT32:
         dataTypeString = "6";
         break;
      case OSSIM_CFLOAT64:
         dataTypeString = "9";
         break;
      case OSSIM_UINT16:
         dataTypeString = "12";
         break;
      case OSSIM_UINT32:
         dataTypeString = "13";
         break;
      default:
         break;
   }
   
   if(!dataTypeString.empty())
   {
      m_keywords["data type"] = dataTypeString.c_str();
   }
}

setDescription()

void ossimEnviHeader::setDescription

(

const ossimString &

description

)

Parameters

description

The description of the file.

Definition at line 234 of file ossimEnviHeader.cpp.

References ossimString::c_str(), and m_keywords.

Referenced by loadState().

{
   m_keywords["description"] = description.c_str();
}

setFileType()

void ossimEnviHeader::setFileType

(

const ossimString &

fileType

)

Sets the file type.

Parameters

fileType

The sensor type as a string.

Definition at line 361 of file ossimEnviHeader.cpp.

References m_keywords.

{
    m_keywords[FILE_TYPE_KW] = fileType.c_str();
}

setHeaderOffset()

void ossimEnviHeader::setHeaderOffset

(

ossim_uint32

headerOffset

)

Sets the header offset in bytes.

Parameters

headerOffset

The number of header offset in bytes.

Definition at line 351 of file ossimEnviHeader.cpp.

References ossimString::c_str(), m_keywords, and ossimString::toString().

{
   m_keywords["header offset"] = ossimString::toString(headerOffset).c_str();
}

setInterleaveType()

void ossimEnviHeader::setInterleaveType

(

ossimInterleaveType

interleave

)

Sets the envi interleave type string based on the ossimInterleaveType.

Parameters

interleave

The ossimInterleaveType of the image.

Definition at line 479 of file ossimEnviHeader.cpp.

References m_keywords, OSSIM_BIL, OSSIM_BIP, and OSSIM_BSQ.

{
   std::string interleaveString = "";
   switch (interleave)
   {
      case OSSIM_BIL:
         interleaveString = "bil";
         break;
      case OSSIM_BSQ:
         interleaveString = "bsq";
         break;
      case OSSIM_BIP:
         interleaveString = "bip";
         break;
      default:
         interleaveString = "Unknown";
         break;
   }
   m_keywords["interleave"] = interleaveString;
}

setLines()

void ossimEnviHeader::setLines

(

ossim_uint32

lines

)

Sets the number of lines.

Parameters

lines

The number of lines.

Definition at line 266 of file ossimEnviHeader.cpp.

References ossimString::c_str(), m_keywords, and ossimString::toString().

Referenced by ossimEnviHeaderFileWriter::writeFile().

{
   m_keywords["lines"] = ossimString::toString(lines).c_str();
}

setMapInfo() [1/2]

void ossimEnviHeader::setMapInfo

(

const ossimString &

mapInfo

)

Sets the envi map info string.

Parameters

mapInfo

envi map info string.

Definition at line 581 of file ossimEnviHeader.cpp.

References ossimString::c_str(), and m_keywords.

Referenced by ossimEnviHeaderFileWriter::writeFile().

{
   m_keywords["map info"] = mapInfo.c_str();
}

setMapInfo() [2/2]

void ossimEnviHeader::setMapInfo	(	const ossimKeywordlist &	kwl,
		const char *	prefix = 0
	)

Sets the envi map info string from a keyword list containing geometry information.

Parameters

kwl	Keyword list containing geometry information.

Definition at line 586 of file ossimEnviHeader.cpp.

{
   if (traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "ossimEnviHeader::setMapInfo DEBUG:"
         << "\nkwl:\n"
         << kwl
         << std::endl;
   }
   ossimString mapInfoString;
   const char* lookup;
   
   // Get the projection type.
   ossimString projection;
   lookup = kwl.find(prefix, ossimKeywordNames::TYPE_KW);
   if (lookup)
   {
      projection = lookup;
   }
   else
   {
      ossimNotify(ossimNotifyLevel_WARN)
         << "ossimEnviHeader::setMapInfo WARNING:"
         << "\nNo projection type found!\nReturning..."
         << std::endl;
         
      return; // Have to have the projection type!
   }

   // Get the datum.
   ossimString datum = "WGS-84";
   lookup = kwl.find(prefix, ossimKeywordNames::DATUM_KW);
   if (lookup)
   {
      ossimString os = lookup;
      if (os == "WGE")
      {
         datum = "WGS-84";
      }
      else
      {
         ossimNotify(ossimNotifyLevel_WARN)
            << "ossimEnviHeader::setMapInfo WARNING:"
            << "\nUnhandled ossim -> envi datum:  " << datum
            << "\nAssuming WGS-84!"
            << std::endl;
      }
   }

   if ( (projection == "ossimEquDistCylProjection") ||
        (projection == "ossimLlxyProjection") )
   {
      const char* tieLat = NULL;
      const char* tieLon = NULL;
      const char* degLat = NULL;
      const char* degLon = NULL;
      tieLat = kwl.find(prefix, ossimKeywordNames::TIE_POINT_LAT_KW);
      tieLon = kwl.find(prefix, ossimKeywordNames::TIE_POINT_LON_KW);
      degLat = kwl.find(prefix,
                        ossimKeywordNames::DECIMAL_DEGREES_PER_PIXEL_LAT);
      degLon = kwl.find(prefix,
                       ossimKeywordNames::DECIMAL_DEGREES_PER_PIXEL_LON);
      
      if (!tieLat || !tieLon || !degLat || !degLon)
      {
         return;
      }
                 
      mapInfoString = "{Geographic Lat/Lon, 1.0000, 1.0000, ";
      mapInfoString += tieLon;
      mapInfoString += ", ";
      mapInfoString += tieLat;
      mapInfoString += ", ";
      mapInfoString += degLon;
      mapInfoString += ", ";
      mapInfoString += degLat;
      mapInfoString += ", ";
      mapInfoString += datum;
      mapInfoString += ", units=degrees}";
   }

   m_keywords["map info"] = mapInfoString.c_str();
   if (traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG)
         << "ossimEnviHeader::setMapInfo DEBUG:"
         << "\ntheMapInfo:  " << mapInfoString
         << std::endl;
   }
}

setSamples()

void ossimEnviHeader::setSamples

(

ossim_uint32

samples

)

Sets the number of samples.

Parameters

samples

The number of samples.

Definition at line 250 of file ossimEnviHeader.cpp.

References ossimString::c_str(), m_keywords, and ossimString::toString().

Referenced by ossimEnviHeaderFileWriter::writeFile().

{
   m_keywords[ std::string("samples") ] = ossimString::toString(samples).c_str();
}

setSensorType()

void ossimEnviHeader::setSensorType

(

const ossimString &

sensorType

)

Sets the envi sensor type string.

Parameters

sensorType

The sensor type as a string.

Definition at line 505 of file ossimEnviHeader.cpp.

References ossimString::c_str(), and m_keywords.

{
   m_keywords["sensor type"] = sensorType.c_str();
}

setWavelengths()

void ossimEnviHeader::setWavelengths

(

const std::vector< ossimString > &

wavelengths

)

Sets the envi band name string.

Parameters

wavelengths

Vector of band name strings.

Definition at line 712 of file ossimEnviHeader.cpp.

References ossimString::join(), and m_keywords.

{
   ossimString value;
   value.join(wavelengths, ",");
   m_keywords[WAVELENGTH_KW] = value.c_str();
}

setWavelengthUnits()

void ossimEnviHeader::setWavelengthUnits

(

const ossimString &

wavelenghtUnits

)

Sets the envi wavelength units string.

Parameters

wavelengthUnits

envi wavelength units string.

Definition at line 684 of file ossimEnviHeader.cpp.

References ossimString::c_str(), and m_keywords.

{
   
   m_keywords["wavelength units"] = waveLengthUnits.c_str();
}

setXStart()

void ossimEnviHeader::setXStart

(

ossim_int32

xstart

)

Sets the x start.

Parameters

xStart

Definition at line 551 of file ossimEnviHeader.cpp.

References ossimString::c_str(), m_keywords, and ossimString::toString().

{
   m_keywords["x start"] = ossimString::toString(xstart).c_str();
}

setYStart()

void ossimEnviHeader::setYStart

(

ossim_int32

ystart

)

Sets the y start.

Parameters

ystart

Definition at line 571 of file ossimEnviHeader.cpp.

References ossimString::c_str(), m_keywords, and ossimString::toString().

{
   m_keywords["y start"] = ossimString::toString(ystart).c_str();
}

writeFile()

bool ossimEnviHeader::writeFile

(

const ossimFilename &

file

)

Writes header to file in a standard envi format.

Parameters

file	File to write to.

Returns

true on success, false on error.

Definition at line 199 of file ossimEnviHeader.cpp.

References ossimString::c_str(), ossimKeywordlist::findKey(), m_keywords, and print().

Referenced by ossimEnviHeaderFileWriter::writeFile().

{
   if (m_keywords.findKey( std::string("description") ).empty())
   {
      m_keywords["description"] = file.c_str();
   }
   
   std::ofstream out(file.c_str(), std::ios_base::out);

   if (!out)
   {
      return false;
   }
   
   print(out);
   out.close();
   return true;
}

Friends And Related Function Documentation

operator<<

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

friend

friend operator<<

Definition at line 224 of file ossimEnviHeader.cpp.

{
   return obj.print( out );
}

Member Data Documentation

m_file

ossimFilename ossimEnviHeader::m_file

private

Definition at line 411 of file ossimEnviHeader.h.

Referenced by getFile(), loadState(), open(), and reset().

m_keywords

ossimKeywordlist ossimEnviHeader::m_keywords

private

Definition at line 412 of file ossimEnviHeader.h.

Referenced by findSubStringCaseInsensitive(), getBandNames(), getBands(), getByteOrder(), getDataType(), getDefaultBands(), getDescription(), getFileType(), getHeaderOffset(), getInterleaveType(), getLines(), getMap(), getMapInfo(), getOssimScalarType(), getSamples(), getSensorType(), getValue(), getWavelengths(), getWavelengthUnits(), getXStart(), getYStart(), loadState(), ossimEnviHeader(), print(), readStream(), reset(), setBandNames(), setBands(), setByteorder(), setDataType(), setDescription(), setFileType(), setHeaderOffset(), setInterleaveType(), setLines(), setMapInfo(), setSamples(), setSensorType(), setWavelengths(), setWavelengthUnits(), setXStart(), setYStart(), and writeFile().

---

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

• ossimEnviHeader.h
• ossimEnviHeader.cpp