ossimSingleImageChain.h

Go to the documentation of this file.

//---
//
// License: MIT
//
// Author:  David Burken
//
// Description: Utility class declaration for a single image chain.
// 
//---
// $Id$
#ifndef ossimSingleImageChain_HEADER
#define ossimSingleImageChain_HEADER 1

#include <ossim/base/ossimConstants.h> /* OSSIM_DLL */
#include <ossim/imaging/ossimBandSelector.h>
#include <ossim/imaging/ossimBrightnessContrastSource.h>
#include <ossim/imaging/ossimCacheTileSource.h>
#include <ossim/imaging/ossimGeoPolyCutter.h>
#include <ossim/imaging/ossimHistogramRemapper.h>
#include <ossim/imaging/ossimImageChain.h>
#include <ossim/imaging/ossimImageHandler.h>
#include <ossim/imaging/ossimImageRenderer.h>
#include <ossim/imaging/ossimImageSharpenFilter.h>
#include <ossim/imaging/ossimNullPixelFlip.h>
#include <ossim/imaging/ossimScalarRemapper.h>
#include <vector>

// Forward class declarations:
class ossimFilename;
class ossimGeoPolygon;
class ossimSrcRecord;

class OSSIM_DLL ossimSingleImageChain : public ossimImageChain
{
public:

   ossimSingleImageChain();

   ossimSingleImageChain(bool addNullPixelFlipFlag,
                         bool addHistogramFlag,
                         bool addResamplerCacheFlag,
                         bool addChainCacheFlag,
                         bool remapToEightBitFlag,
                         bool threeBandFlag,
                         bool threeBandReverseFlag,
                         bool brightnessContrastFlag=false,
                         bool sharpenFlag=false,
                         bool geoPolyCutterFlag=false);
   
   virtual ~ossimSingleImageChain();

   void reset();
   
   bool open(const ossimFilename& file, bool openOverview=true);

   bool open(const ossimSrcRecord& src);
   
   bool isOpen() const;

   void close();

   ossimFilename getFilename() const;

   void createRenderedChain();

   void createRenderedChain(const ossimSrcRecord& src);

   bool addImageHandler(const ossimFilename& file,
                        bool openOverview=true);

   bool addImageHandler(const ossimSrcRecord& src);
   
   void addBandSelector();

   void addBandSelector(const ossimSrcRecord& src);

   void addHistogramRemapper();

   void addHistogramRemapper(const ossimSrcRecord& src);

   ossimRefPtr<ossimCacheTileSource> addCache();

   void addResampler();

   void addRenderer();

   void addScalarRemapper();

   void addBrightnessContrast();

   void addSharpen();


   void addNullPixelFlip();
   void addNullPixelFlip(const ossimSrcRecord& src);
   void addGeoPolyCutter();

   void addGeoPolyCutterPolygon(const vector<ossimGpt>& polygon);
   void addGeoPolyCutterPolygon(const ossimGeoPolygon& polygon);

   ossimRefPtr<const ossimImageHandler> getImageHandler() const;

   ossimRefPtr<ossimImageHandler> getImageHandler();

   ossimRefPtr<const ossimBandSelector> getBandSelector() const;

   ossimRefPtr<const ossimNullPixelFlip> getNullPixelFlip() const;

   ossimRefPtr<ossimBandSelector> getBandSelector();

   ossimRefPtr<const ossimHistogramRemapper> getHistogramRemapper() const;

   ossimRefPtr<ossimHistogramRemapper> getHistogramRemapper();

   ossimRefPtr<const ossimCacheTileSource> getResamplerCache() const;

   ossimRefPtr<ossimCacheTileSource> getResamplerCache();

   ossimRefPtr<const ossimImageRenderer> getImageRenderer() const;

   ossimRefPtr<ossimImageRenderer> getImageRenderer();

   ossimRefPtr<const ossimScalarRemapper> getScalarRemapper() const;

   ossimRefPtr<ossimScalarRemapper> getScalarRemapper();

   ossimRefPtr<const ossimBrightnessContrastSource>
      getBrightnessContrast() const;

   ossimRefPtr<ossimBrightnessContrastSource> getBrightnessContrast();

   ossimRefPtr<const ossimImageSharpenFilter> getSharpenFilter() const;

   ossimRefPtr<ossimImageSharpenFilter> getSharpenFilter();
   
   ossimRefPtr<const ossimCacheTileSource> getChainCache() const;

   ossimRefPtr<ossimCacheTileSource> getChainCache();

   void setAddNullPixelFlipFlag(bool flag);

   bool getNullPixelFlipFlag() const;

 

   void setAddHistogramFlag(bool flag);

   bool getAddHistogramFlag() const;

   void setAddResamplerCacheFlag(bool flag);

   bool getAddResamplerCacheFlag() const;

   void setAddChainCacheFlag(bool flag);

   bool getAddChainCacheFlag() const;

   void setRemapToEightBitFlag(bool flag);

   bool getRemapToEightBitFlag() const;
   
   void setThreeBandFlag(bool flag);

   bool getThreeBandFlag() const;
   
   void setThreeBandReverseFlag(bool flag);

   bool getThreeBandReverseFlag() const;
   
   void setBrightnessContrastFlag(bool flag);

   bool getBrightnessContrastFlag() const;

   void setSharpenFlag(bool flag);

   bool getSharpenFlag() const;

   void setToThreeBands();
   
   void setToThreeBandsReverse();

   void setBandSelection(const std::vector<ossim_uint32>& bandList);

   void setDefaultBandSelection();
   
   ossimScalarType getImageHandlerScalarType() const;

   bool openHistogram( ossimHistogramRemapper::StretchMode mode );

private:

   ossimRefPtr<ossimImageHandler>             m_handler;
   ossimRefPtr<ossimBandSelector>             m_bandSelector;
   ossimRefPtr<ossimNullPixelFlip>            m_nullPixelFlip;
   ossimRefPtr<ossimHistogramRemapper>        m_histogramRemapper;
   ossimRefPtr<ossimBrightnessContrastSource> m_brightnessContrast;
   ossimRefPtr<ossimImageSharpenFilter>       m_sharpen;   
   ossimRefPtr<ossimScalarRemapper>           m_scalarRemapper;
   ossimRefPtr<ossimCacheTileSource>          m_resamplerCache;
   ossimRefPtr<ossimImageRenderer>            m_resampler;
   ossimRefPtr<ossimGeoPolyCutter>            m_geoPolyCutter;
   ossimRefPtr<ossimCacheTileSource>          m_chainCache;
   bool m_addNullPixelFlipFlag;
   bool m_addHistogramFlag;
   bool m_addResamplerCacheFlag;
   bool m_addChainCacheFlag;
   bool m_remapToEightBitFlag;
   bool m_threeBandFlag;
   bool m_threeBandReverseFlag;
   bool m_brightnessContrastFlag;
   bool m_sharpenFlag;
   bool m_geoPolyCutterFlag;

};

#endif /* #ifndef ossimSingleImageChain_HEADER */