ossimMaskFilter.h

Go to the documentation of this file.

//*******************************************************************
  // Copyright (C) 2000 ImageLinks Inc. 
  //
  // License:  MIT
  // 
  // See LICENSE.txt file in the top level directory for more details.
  //
  // Author: Garrett Potts
  // Modified by: Elan Sharghi (1/20/2009)
  // Description: Class declaration for ossimMaskFilter.
  //
  //*************************************************************************
    // $Id: ossimMaskFilter.h 20409 2011-12-22 16:57:05Z dburken $
#ifndef  ossimMaskFilter_HEADER
#define  ossimMaskFilter_HEADER 1
#include <ossim/imaging/ossimImageSource.h>

class OSSIMDLLEXPORT ossimMaskFilter : public ossimImageSource
{
public:
  enum ossimFileSelectionMaskType
  {
     OSSIM_MASK_TYPE_SELECT         = 1,
     OSSIM_MASK_TYPE_INVERT         = 2,
     OSSIM_MASK_TYPE_WEIGHTED       = 3,
     OSSIM_MASK_TYPE_BINARY         = 4,
     OSSIM_MASK_TYPE_BINARY_INVERSE = 5,
     OSSIM_MASK_TYPE_SELECT_CLAMP_MIN = 6,
  };

   ossimMaskFilter(ossimObject* owner=NULL);

   void setMaskSource(ossimImageSource* maskSource);

   virtual void setMaskType(ossimFileSelectionMaskType type);
   
   virtual void setMaskType(const ossimString& type);

   virtual ossimFileSelectionMaskType getMaskType() const;

   virtual ossimString getMaskTypeString() const;

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

   virtual void initialize();
   virtual bool loadState(const ossimKeywordlist& kwl,
                          const char* prefix=0);
   
   virtual bool saveState(ossimKeywordlist& kwl,
                          const char* prefix=0)const;
   
   virtual bool canConnectMyInputTo(ossim_int32 index, const ossimConnectableObject* object)const;
   
   virtual ossim_uint32 getNumberOfInputBands() const;
   

   virtual ossimRefPtr<ossimImageData> executeMaskFilter(
      ossimRefPtr<ossimImageData> imageSourceData,
      ossimRefPtr<ossimImageData> maskSourceData);

   virtual void setProperty(ossimRefPtr<ossimProperty> property);

   virtual ossimRefPtr<ossimProperty> getProperty(
      const ossimString& name)const;

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

protected:
   virtual ~ossimMaskFilter();
   
   void allocate();
   
   ossimRefPtr<ossimImageData> executeMaskFilterSelect(
      ossimRefPtr<ossimImageData> imageSourceData,
      ossimRefPtr<ossimImageData> maskSourceData);

   ossimRefPtr<ossimImageData> executeMaskFilterInvertSelect(
      ossimRefPtr<ossimImageData> imageSourceData,
      ossimRefPtr<ossimImageData> maskSourceData);

   ossimRefPtr<ossimImageData> executeMaskFilterWeighted(
      ossimRefPtr<ossimImageData> imageSourceData,
      ossimRefPtr<ossimImageData> maskSourceData);

   ossimRefPtr<ossimImageData> executeMaskFilterBinary(
      ossimRefPtr<ossimImageData> imageSourceData,
      ossimRefPtr<ossimImageData> maskSourceData);
   
   template <class inputT, class maskT>
      ossimRefPtr<ossimImageData> executeMaskFilterSelection(
         inputT dummyInput,
         maskT  dummyMask,
         ossimRefPtr<ossimImageData> imageSourceData,
         ossimRefPtr<ossimImageData> maskSourceData);
   
   template <class inputT, class maskT>
      ossimRefPtr<ossimImageData> executeMaskFilterInvertSelection(
         inputT dummyInput,
         maskT  dummyMask,
         ossimRefPtr<ossimImageData> imageSourceData,
         ossimRefPtr<ossimImageData> maskSourceData);
   
   template <class inputT, class maskT>
      ossimRefPtr<ossimImageData> executeMaskFilterWeighted(
         inputT dummyInput,
         maskT  dummyMask,
         ossimRefPtr<ossimImageData> imageSourceData,
         ossimRefPtr<ossimImageData> maskSourceData);

   template <class inputT, class maskT>
   ossimRefPtr<ossimImageData> executeMaskFilterBinarySelection(
      inputT dummyInput,
      maskT  dummyMask,
      ossimRefPtr<ossimImageData> imageSourceData,
      ossimRefPtr<ossimImageData> maskSourceData);

   ossimFileSelectionMaskType  theMaskType;

   ossimRefPtr<ossimImageData> theTile;
   ossimRefPtr<ossimImageSource> theMaskSource;

   TYPE_DATA
};

#endif /* #ifndef ossimMaskFilter_HEADER */