ossimOverviewBuilderBase.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:  Base class for overview builders.
//
//----------------------------------------------------------------------------
// $Id: ossimOverviewBuilderBase.h 21653 2012-09-07 15:03:08Z dburken $
#ifndef ossimOverviewBuilderBase_HEADER
#define ossimOverviewBuilderBase_HEADER 1

#include <ossim/base/ossimSource.h>
#include <ossim/base/ossimProcessInterface.h>
#include <ossim/base/ossimConnectableObjectListener.h>
#include <ossim/imaging/ossimImageHandler.h>
#include <ossim/base/ossimRtti.h>
#include <ossim/base/ossimConstants.h>
#include <ossim/base/ossimString.h>
#include <ossim/imaging/ossimBitMaskWriter.h>
#include <ossim/imaging/ossimMaskFilter.h>
#include <vector>

class ossimImageFileWriter;
class ossimFilename;

class OSSIM_DLL ossimOverviewBuilderBase
   :
      public ossimSource,
      public ossimProcessInterface,
      public ossimConnectableObjectListener
{
public:

   ossimOverviewBuilderBase();

   virtual bool setOutputWriter(ossimImageFileWriter* outputWriter);

   virtual bool setInputSource(ossimImageHandler* imageSource);

   virtual void setOutputFile(const ossimFilename& file)=0;

   virtual ossimFilename getOutputFile() const=0;

   virtual bool setOverviewType(const ossimString& type)=0;

   virtual ossimString getOverviewType() const=0;

   virtual bool hasOverviewType(const ossimString& type) const;

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

   virtual ossim_uint32 getOverviewStopDimension() const;

   virtual void setOverviewStopDimension(ossim_uint32 dim);

   ossimHistogramMode getHistogramMode() const;

   void setHistogramMode(ossimHistogramMode mode);
 
   virtual bool execute()=0;

   virtual void finalize();

   void setBitMaskSpec(const ossimKeywordlist& bit_mask_spec);

   void setScanForMinMax(bool flag);

   bool getScanForMinMax() const;

   void setScanForMinMaxNull(bool flag);

   bool getScanForMinMaxNull() const;

protected:
   virtual ~ossimOverviewBuilderBase();

   ossim_uint32 getRequiredResLevels(const ossimImageHandler* ih) const;
  
   void initializePreferenceSettings();

   void initializeScanOptions();
   
   ossim_uint32 m_overviewStopDimension;
   ossimHistogramMode m_histoMode; 
   ossimKeywordlist m_bitMaskSpec;
   ossimRefPtr<ossimImageHandler>  m_imageHandler;
   std::vector<ossim_uint32>       m_originalBandList;
   ossimRefPtr<ossimBitMaskWriter> m_maskWriter;
   ossimRefPtr<ossimMaskFilter>    m_maskFilter;
   ossimFilename                   m_outputFile;
   bool                            m_scanForMinMax;
   bool                            m_scanForMinMaxNull;
   bool                            m_scanFloatData;

   TYPE_DATA
};

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