ossimWatermarkFilter.h

Go to the documentation of this file.

//----------------------------------------------------------------------------
// Copyright (c) 2005, David Burken, all rights reserved.
//
// License:  MIT
// 
// See LICENSE.txt file in the top level directory for more details.
//
// Author:  David Burken
//
// Description: Class declaration of ossimWatermarkFilter.
// Applies an image or watermark to image.  Positioning is based on mode.
// Density is base on alpha weight.
//
//----------------------------------------------------------------------------
// $Id: ossimWatermarkFilter.h 16276 2010-01-06 01:54:47Z gpotts $
#ifndef ossimWatermarkFilter_HEADER
#define ossimWatermarkFilter_HEADER

#include <ossim/base/ossimConstants.h>
#include <ossim/base/ossimString.h>
#include <ossim/base/ossimFilename.h>
#include <ossim/base/ossimIrect.h>
#include <ossim/imaging/ossimImageSourceFilter.h>

class OSSIMDLLEXPORT ossimWatermarkFilter : public ossimImageSourceFilter
{
public:

   enum WatermarkMode
   {
      UPPER_LEFT     = 0,
      UPPER_CENTER   = 1,
      UPPER_RIGHT    = 2,
      CENTER         = 3,
      LOWER_LEFT     = 4,
      LOWER_CENTER   = 5,
      LOWER_RIGHT    = 6,
      UNIFORM_DENSE  = 7,
      UNIFORM_SPARSE = 8,
      END            = 9 //< Number of modes.
   };
      
   ossimWatermarkFilter();

   virtual ossimString getShortName()   const;

   virtual ossimString getLongName()    const;

   virtual ossimString getDescription() const;

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

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

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

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

   virtual void setProperty(ossimRefPtr<ossimProperty> property);

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

   void getModeList(vector<ossimString>& list) const;

   ossimWatermarkFilter::WatermarkMode getMode() const;

   ossimString getModeString() const;

   void setFilename(const ossimFilename& file);

   void setMode(const ossimString& mode);

   void setWeight(ossim_float64 weight);
   
   virtual std::ostream& print(std::ostream& out) const;

protected:
   virtual ~ossimWatermarkFilter();

   bool allocate();

   bool openWatermarkFile();
   
   // void verifyEnable();

   template <class T> void fill(T dummy);

   void getIntersectingRects(vector<ossimIrect>& rects);

   void getUpperLeftRect(vector<ossimIrect>& rects);
   
   void getUpperCenterRect(vector<ossimIrect>& rects);
   
   void getUpperRightRect(vector<ossimIrect>& rects);

   void getCenterRect(vector<ossimIrect>& rects);

   void getLowerLeftRect(vector<ossimIrect>& rects);

   void getLowerCenterRect(vector<ossimIrect>& rects);
   
   void getLowerRightRect(vector<ossimIrect>& rects);
   
   void getUniformDenseRects(vector<ossimIrect>& rects);
   
   void getUniformSparceRects(vector<ossimIrect>& rects);
   
   ossimFilename      theFilename;

   ossim_float64      theWatermarkWeight;

   ossimRefPtr<ossimImageData> theTile;

   ossimRefPtr<ossimImageData> theWatermark;

   ossim_uint32 theWatermarkNumberOfBands;

   WatermarkMode      theMode;

   ossimIrect theInputBoundingRect;

   ossim_uint32 theInputNumberOfBands;

   ossimScalarType theInputScalarType;

   bool theDirtyFlag;


TYPE_DATA
      
}; // End of class ossimWatermarkFilter.

#endif /* #ifndef ossimWatermarkFilter_HEADER */