ossimTiffOverviewBuilder.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:
//
// Contains class declaration for TiffOverviewBuilder.
//
//*******************************************************************
//  $Id: ossimTiffOverviewBuilder.h 22232 2013-04-13 20:06:19Z dburken $

#ifndef ossimTiffOverviewBuilder_HEADER
#define ossimTiffOverviewBuilder_HEADER

#include <vector>

#include <ossim/base/ossimConstants.h>
#include <ossim/base/ossimFilename.h>

#include <ossim/imaging/ossimOverviewBuilderBase.h>
#include <ossim/imaging/ossimFilterResampler.h>

#include <tiffio.h>

class ossimConnectableObject;
class ossimFilename;
class ossimImageGeometry;

class OSSIM_DLL ossimTiffOverviewBuilder
   :
      public ossimOverviewBuilderBase
{
public:

   enum
   {
      DEFAULT_COMPRESS_QUALITY=75
   };

   ossimTiffOverviewBuilder();
   
   virtual ~ossimTiffOverviewBuilder();

   void setResampleType(ossimFilterResampler::ossimFilterResamplerType resampleType);
   
   bool buildOverview(const ossimFilename& overview_file,
                      bool copy_all=false);

   virtual bool execute();

   void setCompressionType(ossim_uint16 compression_type);

   void setJpegCompressionQuality(ossim_int32 quality);

   bool getCopyAllFlag() const;

   void setInternalOverviewsFlag(bool flag);

   bool getInternalOverviewsFlag() const;

   void setCopyAllFlag(bool flag);

   virtual ossimObject* getObject();

   virtual const ossimObject* getObject() const;

   virtual bool canConnectMyInputTo(ossim_int32 index,
                                    const ossimConnectableObject* obj) const;

   virtual bool setInputSource(ossimImageHandler* imageSource);
   
   virtual void  setOutputFile(const ossimFilename& file);

   virtual ossimFilename getOutputFile() const;

   void setOutputTileSize(const ossimIpt& tileSize);

   virtual bool setOverviewType(const ossimString& type);

   virtual ossimString getOverviewType() const;

   virtual void getTypeNameList(std::vector<ossimString>& typeList)const;

   virtual void setProperty(ossimRefPtr<ossimProperty> property);

   virtual void getPropertyNames(std::vector<ossimString>& propertyNames)const;
  
private:

  bool writeR0(TIFF* tif);

   bool writeRn(ossimImageHandler* imageHandler,
                TIFF* tif,
                ossim_uint32 resLevel,
                bool firstResLevel);
   
   bool setTags(TIFF* tif,
                const ossimIrect& outputRect,
                ossim_int32 resLevel) const;

   bool setGeotiffTags(const ossimImageGeometry* geom,
                       const ossimDrect& boundingRect,
                       ossim_uint32 resLevel,
                       TIFF* tif);

   TIFF* openTiff( const ossimString& filename ) const;

   void closeTiff(TIFF* tif);

   bool buildInternalOverviews() const;

   bool copyR0() const;

   // Disallow these...
   ossimTiffOverviewBuilder(const ossimTiffOverviewBuilder& source);
   ossimTiffOverviewBuilder& operator=(const ossimTiffOverviewBuilder& rhs); 

   std::vector<ossim_uint8>                           m_nullDataBuffer;
   ossim_int32                                        m_bytesPerPixel;
   ossim_int32                                        m_bitsPerSample;
   ossim_int32                                        m_tileWidth;
   ossim_int32                                        m_tileHeight;
   ossim_int32                                        m_tileSizeInBytes;
   ossim_int32                                        m_sampleFormat;
   ossim_int32                                        m_currentTiffDir;
   ossim_uint16                                       m_tiffCompressType;
   ossim_int32                                        m_jpegCompressQuality;
   ossimFilterResampler::ossimFilterResamplerType     m_resampleType;
   std::vector<double>                                m_nullPixelValues;
   bool                                               m_copyAllFlag;
   ossimString                                        m_tempExtension;
   bool                                               m_outputTileSizeSetFlag;
   bool                                               m_internalOverviewsFlag;

TYPE_DATA   
};
   
#endif