ossimTiffInfo.h

Go to the documentation of this file.

//----------------------------------------------------------------------------
//
// License: MIT
// 
// See LICENSE.txt file in the top level directory for more details.
//
// Author:  David Burken
//
// Description: TIFF Info object.
// 
//----------------------------------------------------------------------------
// $Id$

#ifndef ossimTiffInfo_HEADER
#define ossimTiffInfo_HEADER 1

#include <ossim/base/ossimConstants.h>
#include <ossim/support_data/ossimInfoBase.h>
#include <ossim/base/ossimFilename.h>
#include <ossim/base/ossimIosFwd.h>
#include <iosfwd>
#include <string>
#include <vector>
#include <memory>

class ossimDpt;
class ossimEndian;
class ossimKeywordlist;
class ossimTieGptSet;

class OSSIM_DLL ossimTiffInfo : public ossimInfoBase
{
public:

   enum WordType
   {
      TWO_OR_EIGHT  = 0,
      FOUR_OR_EIGHT = 1
   };
   
   ossimTiffInfo();

   virtual ~ossimTiffInfo();

   virtual bool open(const ossimFilename& file);
   virtual bool open( std::shared_ptr<ossim::istream>& str,
                      const std::string& connectionString );

   virtual std::ostream& print(std::ostream& out) const;

   virtual std::ostream& print(std::istream& inStr,
                               std::ostream& outStr) const;

   bool getImageGeometry(ossimKeywordlist& geomKwl,
                         ossim_uint32 entryIndex) const;

   bool getImageGeometry(std::istream& str,
                         ossimKeywordlist& geomKwl,
                         ossim_uint32 entryIndex) const;

   bool getImageGeometry(const ossimKeywordlist& gtiffKwl,
                         ossimKeywordlist& geomKwl,
                         ossim_uint32 entryIndex) const;

   void getImageGeometry(ossim_uint64   geoKeyLength,
                         ossim_uint16*  geoKeyBlock,
                         ossim_uint64   geoDoubleLength,
                         ossim_float64* geoDoubleBlock,
                         ossim_uint64   geoAsciiLength,
                         ossim_int8*    geoAsciiBlock,
                         ossimKeywordlist& geomKwl) const;

   std::ostream& printGeoKeys(std::ostream& out,
                              const std::string& prefix,
                              ossim_uint64   geoKeyLength,
                              ossim_uint16*  geoKeyBlock,
                              ossim_uint64   geoDoubleLength,
                              ossim_float64* geoDoubleBlock,
                              ossim_uint64   geoAsciiLength,
                              ossim_int8*    geoAsciiBlock) const;

   std::ostream& printRpcs(std::ostream& out,
                           const std::string& prefix,
                           ossim_uint16 type,
                           ossim_uint64 count,
                           ossim_uint8* valueArray) const;

private:
   
   void readShort(ossim_uint16& s, std::istream& str) const;
   
   void readLong(ossim_uint32& l, std::istream& str) const;
   
   void readLongLong(ossim_uint64& l, std::istream& str) const;
   
   void parsePcsCode(int code);
   
   void parseProjGeoCode(int code);
   
   double convert2meters(double d) const;
   
   bool getOffset(std::streamoff& offset, std::istream& str,
                  ossim_uint16 version) const;
   
   bool getValue(ossim_uint64& val, std::istream& str, WordType type,
                 ossim_uint16 version) const;
   
   ossim_uint64 getArraySizeInBytes(ossim_uint64 length,
                                    ossim_uint16 type) const;
   
   ossim_uint16 getTypeByteSize(ossim_uint16 type) const;
   
   void eatValue(std::istream& str, ossim_uint16 version) const;
   
   void swapBytes(ossim_uint8* v, ossim_uint16 type, ossim_uint64 count) const;
   
   template <class T> void getArrayValue(T& v,
                                         ossim_uint8* array,
                                         ossim_uint64 position) const;
   
   std::ostream& print(std::ostream& out,
                       const std::string&  prefix,
                       ossim_uint64   tagIdx,
                       ossim_uint16   tag,
                       ossim_uint16   type,
                       ossim_uint64   count,
                       ossim_uint64   arraySizeInBytes,
                       ossim_uint8*   valueArray) const;
   
   std::ostream& printValue(std::ostream& out,
                            ossim_uint16 type,
                            ossim_uint8* valueArray) const;
   
   std::ostream& printArray(std::ostream& out,
                            ossim_uint16 type,
                            ossim_uint64 count,
                            ossim_uint8* valueArray) const;
   
   std::ostream& printGdalMetadata(std::ostream& out,
                                   const std::string& prefix,
                                   ossim_uint64 count,
                                   ossim_uint8* valueArray) const;

   std::ostream& printXmpMetadata(std::ostream& out,
                                  const std::string& prefix,
                                  ossim_uint64 count,
                                  ossim_uint8* valueArray) const;

   std::ostream& printModelType(std::ostream& out,
                                const std::string& prefix,
                                ossim_uint16 code) const;

   std::ostream& printRasterType(std::ostream& out,
                                 const std::string& prefix,
                                 ossim_uint16 code) const;

   std::ostream& printAngularUnits(std::ostream& out,
                                   const std::string& prefix,
                                   ossim_uint16 code) const;

   std::ostream& printCoordTrans(std::ostream& out,
                                  const std::string& prefix,
                                  ossim_uint16 code) const;

   std::ostream& printLinearUnits(std::ostream& out,
                                  const std::string& prefix,
                                  const std::string& key,
                                  ossim_uint16 code) const;

   std::ostream& printOrientation(std::ostream& out,
                                  const std::string& prefix,
                                  ossim_uint16 code) const;
  
   void getDirPrefix(ossim_int32 dirIndex, std::string& prefix) const;

   bool getPixelScale(const ossimString& gtiffPrefix,
                      const ossimKeywordlist& gtiffKwl,
                      ossimDpt& scale) const;
   
   bool getTiePoint(const ossimString& gtiffPrefix,
                    const ossimKeywordlist& gtiffKwl,
                    std::vector<ossim_float64>& ties) const;

   bool getModelTransform(const ossimString& gtiffPrefix,
                          const ossimKeywordlist& gtiffKwl,
                          std::vector<ossim_float64>& xfrm) const;

   bool  getFloats(const ossimString& gtiffPrefix,
                   const ossimString& key,
                   const ossimKeywordlist& gtiffKwl,
                   std::vector<ossim_float64>& floats) const;

   bool getFloats(const ossimString& line,
                  std::vector<ossim_float64>& floats) const;

   bool getDatumCode(const ossimString& gtiffPrefix,
                     const ossimKeywordlist& gtiffKwl,
                     ossimString& datumCode) const;

   bool getDatumCode(ossim_int32 code, ossimString& datumCode) const;

   bool getPcsCode(const ossimString& gtiffPrefix,
                   const ossimKeywordlist& gtiffKwl,
                   ossimString& pcsCode) const;

   bool getUnits(const ossimString& gtiffPrefix,
                 const ossimKeywordlist& gtiffKwl,
                 ossimString& units) const;
   bool getLinearUnits(const ossimString& gtiffPrefix,
                       const ossimKeywordlist& gtiffKwl,
                       ossimString& linearUnits) const;

   bool getVerticalUnits(const ossimString& gtiffPrefix,
                         const ossimKeywordlist& gtiffKwl,
                         ossimString& verticalUnits) const;

   bool getAngularUnits(const ossimString& gtiffPrefix,
                        const ossimKeywordlist& gtiffKwl,
                        ossimString& units) const;


   bool getPixelType(const ossimString& gtiffPrefix,
                     const ossimKeywordlist& gtiffKwl,
                     ossimString& pixelType) const;

   bool getModelType(const ossimString& gtiffPrefix,
                     const ossimKeywordlist& gtiffKwl,
                     ossimString& modeType) const;

   bool getOssimProjectionName(const ossimString& gtiffPrefix,
                               const ossimKeywordlist& gtiffKwl,
                               ossimString& ossimProj) const;
   
   ossim_uint32 getLines(const ossimString& gtiffPrefix,
                         const ossimKeywordlist& gtiffKwl) const;

   ossim_uint32 getSamples(const ossimString& gtiffPrefix,
                           const ossimKeywordlist& gtiffKwl) const;

   bool getStdParallelOne(const ossimString& gtiffPrefix,
                          const ossimKeywordlist& gtiffKwl,
                          ossimString& value) const;

   bool getStdParallelTwo(const ossimString& gtiffPrefix,
                          const ossimKeywordlist& gtiffKwl,
                          ossimString& value) const;
   
   bool getFalseEasting(const ossimString& gtiffPrefix,
                        const ossimKeywordlist& gtiffKwl,
                        ossimString& value) const;

   bool getFalseNorthing(const ossimString& gtiffPrefix,
                         const ossimKeywordlist& gtiffKwl,
                         ossimString& value) const;

   bool getFalseEastingNorthing(const ossimString& gtiffPrefix,
                                const ossimKeywordlist& gtiffKwl,
                                ossimDpt& eastingNorthing) const;

   bool getScaleFactor(const ossimString& gtiffPrefix,
                       const ossimKeywordlist& gtiffKwl,
                       ossim_float64& value) const;

   bool getOriginLat(const ossimString& gtiffPrefix,
                     const ossimKeywordlist& gtiffKwl,
                     ossim_float64& value) const;

   bool getCentralMeridian(const ossimString& gtiffPrefix,
                           const ossimKeywordlist& gtiffKwl,
                           ossim_float64& value) const;

   void getTieSets(const std::vector<ossim_float64>& ties,
                   ossim_uint32 width,
                   ossim_uint32 height,
                   ossimTieGptSet& tieSet) const;


   bool hasOneBasedTiePoints(const std::vector<ossim_float64>& ties,
                             ossim_uint32 width,
                             ossim_uint32 height) const;
   
   std::string m_connectionString;
   mutable std::shared_ptr<ossim::istream> m_inputStream;
   //ossimFilename          theFile;
   mutable ossimEndian* m_endian;
};

#endif /* End of "#ifndef ossimTiffInfo_HEADER" */