ossimBandSelector.h

Go to the documentation of this file.

//*******************************************************************
//
// License: MIT
// 
// Author:  Garrett Potts
//
// Description:  Contains class declaration for ossimBandSelector.
// 
//*******************************************************************
//  $Id$
#ifndef ossimBandSelector_HEADER
#define ossimBandSelector_HEADER 1

#include <ossim/imaging/ossimImageSourceFilter.h>
#include <vector>
 
class ossimImageData;
class ossimImageHandler;

class OSSIM_DLL ossimBandSelector : public ossimImageSourceFilter
{
   
public:
   enum ossimBandSelectorWithinRangeFlagState
   {
      ossimBandSelectorWithinRangeFlagState_NOT_SET      = 0,
      ossimBandSelectorWithinRangeFlagState_IN_RANGE     = 1,
      ossimBandSelectorWithinRangeFlagState_OUT_OF_RANGE = 2,
   };

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

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

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


   virtual void setThreeBandRgb();
    
   virtual void setOutputBandList(const vector<ossim_uint32>& outputBandList,
                                  bool disablePassThru=false);
   
   virtual ossim_uint32 getNumberOfOutputBands() const;

   virtual ossim_uint32 getNumberOfInputBands()const;   

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

   virtual bool saveState(ossimKeywordlist& kwl,
                          const char* prefix=NULL)const;
   
   virtual bool loadState(const ossimKeywordlist& kwl,
                          const char* prefix=NULL);
   //virtual void propertyEvent(ossimPropertyEvent& event);
   //virtual void refreshEvent(ossimRefreshEvent& event);   

   virtual void setProperty(ossimRefPtr<ossimProperty> property);
   virtual ossimRefPtr<ossimProperty> getProperty(const ossimString& name)const;
   virtual void getPropertyNames(std::vector<ossimString>& propertyNames)const;                       
   virtual bool isSourceEnabled()const;

protected:

   void allocate();

   void checkPassThrough();

   bool outputBandsWithinInputRange() const;

   ossimRefPtr<ossimImageHandler> getBandSelectableImageHandler() const;

   bool getRgbBandList(std::vector<ossim_uint32>& bandList) const;
   
   ossimRefPtr<ossimImageData>           m_tile;
   std::vector<ossim_uint32>             m_outputBandList;
   ossimBandSelectorWithinRangeFlagState m_withinRangeFlag;
   bool                                  m_passThroughFlag;
   bool                                  m_delayLoadRgbFlag;
   bool                                  m_inputIsSelectable;

TYPE_DATA
};

#endif /* #ifndef ossimBandSelector_HEADER */