ossimGdalOverviewBuilder.h

Go to the documentation of this file.

//----------------------------------------------------------------------------
//
// License:  See top level LICENSE.txt file.
//
// Author:  David Burken
//
// Description:  OSSIM wrapper for building gdal overviews (tiff or hfa) from
// an ossim image source.
//
//----------------------------------------------------------------------------
// $Id: ossimGdalOverviewBuilder.h 15833 2009-10-29 01:41:53Z eshirschorn $

#ifndef ossimGdalOverviewBuilder_HEADER
#define ossimGdalOverviewBuilder_HEADER

#include <vector>

#include <ossim/base/ossimConstants.h>
#include <ossim/base/ossimFilename.h>
#include <ossim/base/ossimRefPtr.h>
#include <ossim/base/ossimProperty.h>
#include <ossim/imaging/ossimOverviewBuilderBase.h>

class ossimImageSource;
class ossimGdalDataset;

class ossimGdalOverviewBuilder
   :
   public ossimOverviewBuilderBase
{
public:

   enum ossimGdalOverviewType
   {
      ossimGdalOverviewType_UNKNOWN = 0,
      ossimGdalOverviewTiffNearest  = 1,
      ossimGdalOverviewTiffAverage  = 2,
      ossimGdalOverviewHfaNearest   = 3,
      ossimGdalOverviewHfaAverage   = 4
   };

   ossimGdalOverviewBuilder();

   virtual ~ossimGdalOverviewBuilder();

   bool open(const ossimFilename& file);

   virtual bool execute();

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

   virtual ossimFilename getOutputFile() const;

   virtual bool setOverviewType(const ossimString& type);

   virtual ossimString getOverviewType() const;

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

   virtual ossimObject* getObject();

   virtual const ossimObject* getObject() const;

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

   virtual void setProperty(ossimRefPtr<ossimProperty> property);

   virtual void getPropertyNames(std::vector<ossimString>& propertyNames)const;
   
   virtual std::ostream& print(std::ostream& out) const;

private:

   bool generateHfaStats() const;

   ossimString getGdalResamplingType() const;

   ossimString getExtensionFromType() const;
   
   ossimGdalDataset*               theDataset;
   ossimFilename                   theOutputFile;
   ossimGdalOverviewType           theOverviewType;
   std::vector<ossim_int32>        theLevels; // like 2, 4, 8, 16, 32
   bool                            theGenerateHfaStatsFlag;

   TYPE_DATA
};

#endif /* End if "#ifndef ossimGdalOverviewBuilder_HEADER" */