ossimEnviHeader.h

Go to the documentation of this file.

//----------------------------------------------------------------------------
//
// License:  See top level LICENSE.txt file.
//
// Author:  David Burken
//
// Description:
// 
// Class for reading and writing an ENVI (The Environment for Visualizing
// Images) header file.  This parses envi header and places in a keyword
// list.
//
//----------------------------------------------------------------------------
// $Id: ossimEnviHeader.h 22349 2013-08-01 21:38:29Z dburken $

#ifndef ossimEnviHeader_HEADER
#define ossimEnviHeader_HEADER 1

#include <ossim/base/ossimConstants.h>
#include <ossim/base/ossimFilename.h>
#include <ossim/base/ossimKeywordlist.h>
#include <ossim/base/ossimString.h>
#include <ossim/base/ossimReferenced.h>
#include <iosfwd>

class OSSIM_DLL ossimEnviHeader : public ossimReferenced
{
public:
   ossimEnviHeader();

   virtual ~ossimEnviHeader();

   virtual void reset();

   const ossimKeywordlist& getMap() const;
   
   ossimKeywordlist& getMap();

   bool getValue( const ossimString& key, ossimString& value ) const;

   bool findCaseInsensitive( const ossimString& key,
                             ossimString& value ) const;

   bool findSubStringCaseInsensitive( const ossimString& key,
                                      ossimString& value) const;

   bool open(const ossimFilename& file);

   bool writeFile(const ossimFilename& file);
   
   std::ostream& print(std::ostream& out) const;

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

   ossimString getDescription() const;

   void setDescription(const ossimString& description);

   ossim_uint32 getSamples() const;

   void setSamples(ossim_uint32 samples);

   ossim_uint32 getLines() const;

   void setLines(ossim_uint32 lines);

   ossim_uint32 getBands() const;

   void setBands(ossim_uint32 bands);

   bool getDefaultBands( std::vector<ossim_uint32>& bands ) const;

   bool getRgbBandsFromWaveLength( std::vector<ossim_uint32>& bands ) const;

   ossim_uint32 getHeaderOffset() const;

   void setHeaderOffset(ossim_uint32 headerOffset);

   ossimString getFileType() const;

   void setFileType(const ossimString& fileType);

   ossim_uint32 getDataType() const;

   ossimScalarType getOssimScalarType() const;

   void setDataType(ossimScalarType scalar);

   ossimString getInterleaveType() const;

   ossimInterleaveType getOssimInterleaveType() const;

   void setInterleaveType(ossimInterleaveType interleave);

   ossimString getSensorType() const;

   void setSensorType(const ossimString& sensorType);

   ossimByteOrder getByteOrder() const;
   
   void setByteorder(ossimByteOrder byteOrder);
   
   ossim_int32 getXStart() const;
   
   void setXStart(ossim_int32 xstart);
   
   ossim_int32 getYStart() const;
   
   void setYStart(ossim_int32 ystart);

   ossimString getMapInfo() const;

   void setMapInfo(const ossimString& mapInfo);

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

   ossimString getWavelengthUnits() const;

   void setWavelengthUnits(const ossimString& wavelenghtUnits);

   void getBandNames(std::vector<ossimString>& bandNames) const;

   void setBandNames(const std::vector<ossimString>& bandNames);

   void getWavelengths(std::vector<ossimString>& wavelengths) const;

   void setWavelengths(const std::vector<ossimString>& wavelengths);

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

   static bool isEnviHeader( const ossimFilename& file );

   static bool isEnviHeader( std::istream& in );

   const ossimFilename& getFile() const;
   
private:

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

   bool readStream(std::istream& in);
   
   ossimFilename       m_file; // Name of header file.
   ossimKeywordlist    m_keywords;
};
#endif /* #ifndef ossimEnviHeader_HEADER */