ossimHistogramRemapper.h

Go to the documentation of this file.

//*******************************************************************
//
// License:  See top level LICENSE.txt file.
//
// Author:  David Burken
//
// Description:
//
// Histogram remapper class declaration.  Derived from ossimTableRemapper.
//
// Remaps a tile based on mode and histogram clip points.  This object uses
// a precomputed remap table for speed; hence, derived from the
// ossimTableRemapper
//
// NOTE on bands:
// 
// - All methods take zero based bands.  In other words the first
//   band is band "0".  
//
// - This objects band 0 is the same band 0 as it's input connection.  If
//   the band order was changed by a ossimBandSelector then this band 0 will
//   not map to the histogram files band 0.  To handle this,
//   the "getOutputBandList()" method is used to get the correct histogram for
//   the input band.
//   
// - The "get" methods that do not take a band, simply return the average of
//   all bands.  This really only makes sense if all bands are the same
//   but is provided for convenience.
//   
//*************************************************************************
// $Id: ossimHistogramRemapper.h 22746 2014-04-23 16:16:28Z gpotts $
#ifndef ossimHistogramRemapper_HEADER
#define ossimHistogramRemapper_HEADER 1

#include <ossim/imaging/ossimTableRemapper.h>
#include <ossim/base/ossimMultiResLevelHistogram.h>


class OSSIMDLLEXPORT ossimHistogramRemapper : public ossimTableRemapper
{
public:
   enum StretchMode
   {
      LINEAR_ONE_PIECE       = 0,
      LINEAR_1STD_FROM_MEAN  = 1,
      LINEAR_2STD_FROM_MEAN  = 2,
      LINEAR_3STD_FROM_MEAN  = 3,
      LINEAR_AUTO_MIN_MAX    = 4,
      LINEAR_AUTO_PERCENTILE = 5,
      STRETCH_UNKNOWN = 6 // Alway last as used for number of modes method.
   };

   ossimHistogramRemapper();


   virtual ossimString getLongName()  const;
   virtual ossimString getShortName() const;

   virtual ossimRefPtr<ossimImageData> getTile(const ossimIrect& tile_rect,
                                               ossim_uint32 resLevel=0);

   virtual void initialize();
   void reset();
   
   void setStretchMode(StretchMode mode, bool rebuildTableFlag=false);

   void setStretchModeAsString(const ossimString& mode,
                               bool rebuildTableFlag=false);
   
   StretchMode   getStretchMode() const;

   ossimString getStretchModeString() const;

   ossim_uint32 getNumberOfStretchModes() const;

   ossimString getStretchModeString(ossim_uint32 index) const;
   
   void setLowNormalizedClipPoint(const ossim_float64& clip);

   void setLowNormalizedClipPoint(const ossim_float64& clip,
                                  ossim_uint32 zero_based_band);

   void setHighNormalizedClipPoint(const ossim_float64& clip);

   void setHighNormalizedClipPoint(const ossim_float64& clip,
                                   ossim_uint32 zero_based_band);

   void setLowClipPoint(const ossim_float64& clip);

   void setLowClipPoint(const ossim_float64& clip,
                        ossim_uint32 zero_based_band);

   void setHighClipPoint(const ossim_float64& clip);

   void setHighClipPoint(const ossim_float64& clip,
                         ossim_uint32 zero_based_band);

   void setMidPoint(const ossim_float64& value);

   void setMidPoint(const ossim_float64& value,
                    ossim_uint32 zero_based_band);

   void setMinOutputValue(const ossim_float64& value);

   void setMinOutputValue(const ossim_float64& value,
                          ossim_uint32 zero_based_band);

   void setMaxOutputValue(const ossim_float64& value);

   void setMaxOutputValue(const ossim_float64& value,
                          ossim_uint32 zero_based_band);
   
   ossim_float64 getLowNormalizedClipPoint(ossim_uint32 zero_based_band) const;

   ossim_float64 getLowNormalizedClipPoint() const;

   ossim_float64 getHighNormalizedClipPoint(ossim_uint32 zero_based_band) const;
   ossim_float64 getHighNormalizedClipPoint() const;

   ossim_float64 getLowClipPoint(ossim_uint32 zero_based_band) const;

   ossim_float64 getLowClipPoint() const;

   ossim_float64 getHighClipPoint(ossim_uint32 zero_based_band) const;

   ossim_float64 getHighClipPoint() const;

   
   ossim_float64 getMidPoint(ossim_uint32 zero_based_band) const;
   
   ossim_float64 getMidPoint() const;
   
   ossim_float64 getMinOutputValue(ossim_uint32 zero_based_band) const;

   ossim_float64 getMinOutputValue() const;

   ossim_float64 getMaxOutputValue(ossim_uint32 zero_based_band) const;

   ossim_float64 getMaxOutputValue() const;
   
   void setHistogram(ossimRefPtr<ossimMultiResLevelHistogram> histogram);
   
   ossimRefPtr<ossimMultiResLevelHistogram> getHistogram();
   ossimRefPtr<const ossimMultiResLevelHistogram> getHistogram()const;
   
   ossimRefPtr<ossimHistogram> getHistogram(ossim_uint32 zero_based_band,
                                ossim_uint32 res_level=0) const;

   bool openHistogram(const ossimFilename& histogram_file);

   bool computeHistogram(const ossimIrect& roi);

   ossimFilename getHistogramFile() const;
   
   virtual bool saveState(ossimKeywordlist& kwl,
                          const char* prefix=0)const;


   virtual bool loadState(const ossimKeywordlist& kwl,
                          const char* prefix=0);
   
   
   virtual ostream& print(ostream& os) const;

   virtual double getMinPixelValue(ossim_uint32 band=0)const;
   
   virtual double getMaxPixelValue(ossim_uint32 band=0)const;

   bool canConnectMyInputTo(ossim_int32 inputIndex,
                            const ossimConnectableObject* object)const;

protected:
   virtual ~ossimHistogramRemapper();

private:
   // Do not allow copy constructor, operator=.
   ossimHistogramRemapper(const ossimHistogramRemapper& hr);
   ossimHistogramRemapper& operator=(const ossimHistogramRemapper& hr);

   void buildTable();
   void buildLinearTable();
   void buildAutoLinearMinMaxTable();
   void buildAutoLinearPercentileTable();
   template <class T> void buildLinearTable(T dummy);
   template <class T> void buildAutoLinearMinMaxTableTemplate(T dummy);
   template <class T> void buildAutoLinearPercentileTableTemplate(T dummy);

   void buildLinearTableStdFromMean();
   
   void initializeClips();

   void initializeClips(ossim_uint32 bands);

   /*
    * Sets the count of the null bin to 0 so that clips from the low end
    * ignore the null bin.
    */
   void setNullCount();

   void initializeMinMaxOutput();
   
   void setupTable();

   void verifyEnabled();

   ossim_uint32 getHistogramBand(ossim_uint32 input_band) const;

   void setBypassFlag(bool flag);

   void makeClean();

   template <class T> void applyLinearStretch(
      T dummy,
      ossimRefPtr<ossimImageData>& inputTile);


   StretchMode                   theStretchMode;
   bool                          theDirtyFlag;
   mutable ossimRefPtr<ossimMultiResLevelHistogram>  theHistogram;
   vector<ossim_float64>         theNormalizedLowClipPoint;
   vector<ossim_float64>         theNormalizedHighClipPoint;
   vector<ossim_float64>         theMidPoint;
   vector<ossim_float64>         theMinOutputValue;
   vector<ossim_float64>         theMaxOutputValue;

   // Maps zero based band to histogram band.
   vector<ossim_uint32>          theBandList;

   // Internally bypassed flag.
   bool theBypassFlag;
   bool theResetBandIndicesFlag;

   TYPE_DATA
};

#endif  /* #ifndef ossimHistogramRemapper_HEADER */