ossimDilationFilter.cpp

Go to the documentation of this file.

//*******************************************************************
// Copyright (C) 2000 ImageLinks Inc.
//
// License:  LGPL
// 
// See LICENSE.txt file in the top level directory for more details.
//
// Author:  Garrett Potts
//
//*******************************************************************
//  $Id: ossimDilationFilter.cpp 21631 2012-09-06 18:10:55Z dburken $

#include <ossim/imaging/ossimDilationFilter.h>
#include <ossim/base/ossimNumericProperty.h>
#include <ossim/base/ossimBooleanProperty.h>
#include <ossim/base/ossimStringProperty.h>
#include <ossim/imaging/ossimImageData.h>
#include <vector>
#include <numeric>

using namespace std;

RTTI_DEF1(ossimDilationFilter, "ossimDilationFilter", ossimImageSourceFilter);

// Keywords used throughout.
static const ossimString WINDOW_SIZE_KW = "window_size";
static const ossimString RECURSIVE_DILATION_KW = "recursive_dilation";

ossimDilationFilter::ossimDilationFilter(ossimObject* owner)
   :ossimImageSourceFilter(owner),
    theTile(0),
    theTempTile(0),
    theWindowSize(15),
    theRecursiveFlag(false),
    theNullFoundFlag(false)
{
   setDescription(ossimString("Dilation Filter"));
}

ossimDilationFilter::~ossimDilationFilter()
{
}

void ossimDilationFilter::initialize()
{
   ossimImageSourceFilter::initialize();
   theTile = NULL;
}

ossimRefPtr<ossimImageData> ossimDilationFilter::getTile(const ossimIrect& rect,
                                                         ossim_uint32 resLevel)
{
   if(!isSourceEnabled())
      return ossimImageSourceFilter::getTile(rect, resLevel);

   ossimRefPtr<ossimImageData> inputData;
   if (theRecursiveFlag)
      inputData =  ossimImageSourceFilter::getTile(rect, resLevel);
   else
   {
      ossim_uint32 halfSize = getWindowSize()>>1;
      ossimIrect requestRect(rect.ul().x - halfSize,
                             rect.ul().y - halfSize,
                             rect.lr().x + halfSize,
                             rect.lr().y + halfSize);

      inputData =  ossimImageSourceFilter::getTile(requestRect, resLevel);
   }

   if(!inputData.valid() || !inputData->getBuf())
      return inputData;

   vector<ossimIpt> viv;
   ossimImageSourceFilter::getValidImageVertices(viv, OSSIM_CLOCKWISE_ORDER, resLevel);
   theValidImagePoly = ossimPolygon(viv);

   if(!theTile.valid())
   {
      theTile = (ossimImageData*)inputData->dup();
      theTile->setImageRectangle(rect);
   }
   else
   {
      theTile->setImageRectangleAndBands(rect, inputData->getNumberOfBands());
   }

   theNullFoundFlag = false;
   switch(inputData->getScalarType())
   {
      case OSSIM_UINT8:
         doDilation(ossim_uint8(0), inputData);
         break;
      case OSSIM_USHORT11:
      case OSSIM_USHORT12:
      case OSSIM_USHORT13:
      case OSSIM_USHORT14:
      case OSSIM_USHORT15:
      case OSSIM_UINT16:
         doDilation(ossim_uint16(0), inputData);
         break;
      case OSSIM_SINT16:
         doDilation(ossim_sint16(0), inputData);
         break;
      case OSSIM_UINT32:
         doDilation(ossim_uint32(0), inputData);
         break;
      case OSSIM_FLOAT32:
      case OSSIM_NORMALIZED_FLOAT:
         doDilation(ossim_float32(0), inputData);
         break;
      case OSSIM_FLOAT64:
      case OSSIM_NORMALIZED_DOUBLE:
         doDilation(ossim_float64(0), inputData);
         break;
      default:
      {
         ossimNotify(ossimNotifyLevel_WARN)
            << "ossimDilationFilter::applyFilter WARNING:\n"
            << "Unhandled scalar type!" << endl;
      }
   }
   return theTile;
}

template <class T>
void ossimDilationFilter::doDilation(T scalarType , ossimRefPtr<ossimImageData>& inputData)
{
   ossimDataObjectStatus status = inputData->getDataObjectStatus();

   if ((status == OSSIM_FULL) || (status == OSSIM_EMPTY))
   {
      // Nothing to do just copy the tile.
      theTile->loadTile(inputData.get());
      return;
   }

   ossim_int32 halfWindow = (ossim_int32)(theWindowSize >> 1);
   ossim_int32 x, y, kernelX, kernelY;   
   ossim_int32 iw = (ossim_int32)inputData->getWidth();
   ossim_int32 ih = (ossim_int32)inputData->getHeight();
   ossim_int32 ow = (ossim_int32)theTile->getWidth();
   ossim_int32 oh = (ossim_int32)theTile->getHeight();
   ossim_uint32 numBands = ossim::min(theTile->getNumberOfBands(), inputData->getNumberOfBands());

   // It may be that the input rect is the same size as the output (i.e., the tile bounds aren't
   // expanded in the input's request to permit full kernels for output edge pixels:
   ossim_uint32 i_offset = 0;
   ossim_int32 delta = (ossim_int32)((iw - ow) >> 1);
   ossim_int32 xi, yi;
   if (delta > 0)
      i_offset = (ossim_uint32) halfWindow*(iw + 1);

   ossimIpt tile_ul (theTile->getImageRectangle().ul());
   vector<double> values;
   for(ossim_uint32 bandIdx = 0; bandIdx < numBands; ++bandIdx)
   {
      T* inputBuf     = (T*)inputData->getBuf(bandIdx);
      T* outputBuf    = (T*)theTile->getBuf(bandIdx);
      if (!inputBuf || !outputBuf)
      {
         return; // Shouldn't happen...
      }

      const T NP = (T)inputData->getNullPix(bandIdx);

      for(y = 0; y < oh; ++y)
      {
         for(x = 0; x < ow; ++x)
         {
            // Get the center input pixel. Only process those points inside the valid image
            // (to avoid dilation beyond valid image)
            const T CP = *(inputBuf+i_offset);
            ossimDpt ipt (tile_ul.x+x, tile_ul.y+y);
            if ((CP == NP) && theValidImagePoly.isPointWithin(ipt))
            {
               theNullFoundFlag = true; // Needed for recursion
               values.clear();
               for(kernelY = -halfWindow; kernelY <= halfWindow; ++kernelY)
               {
                  yi = y + kernelY + delta;
                  if ((yi < 0) || (y > ih))
                     continue;

                  for(kernelX = -halfWindow; kernelX <= halfWindow; ++kernelX)
                  {
                     xi = x + kernelX + delta;
                     if ((xi < 0) || (x > iw))
                        continue;

                     T tempValue = *(inputBuf+kernelX+delta + (kernelY+delta)*iw);
                     if(tempValue != NP)
                        values.push_back((double)tempValue);
                  }
               }

               if(values.size() > 0)
               {
                  double accum = accumulate(values.begin(), values.end(), 0.0);
                  double average = accum/(double)values.size();
                  (*outputBuf) = (T)average;
               }
               else
               {
                  (*outputBuf) = NP;
               }

            }
            else // Center pixel (CP) not null.
            {
               (*outputBuf) = CP;
            }

            // Move over...
            ++inputBuf;
            ++outputBuf;

         } // End of loop in x direction.

         // Move down...
         inputBuf += iw - ow;

      }  // End of loop in y direction.

   }  // End of band loop.

   theTile->validate();

   // Set up recursion for "dilation fill mode", we'll keep calling this getTile until all pixels
   // are filled with non-null values:
   if (theRecursiveFlag)
   {
      //cout << "Percent Full: "<<theTile->percentFull()<<endl; //###
      //theTile->write("filtered.ras"); //###

      status = theTile->getDataObjectStatus();
      if (theNullFoundFlag)
      {
         theNullFoundFlag = false; // assume will fill, set true in next recursion if null found
         theTempTile = new ossimImageData(*theTile.get());
         doDilation(scalarType, theTempTile);
      }
   }
}

void ossimDilationFilter::setProperty(ossimRefPtr<ossimProperty> property)
{
   if (!property.valid())
      return;

   ossimString name = property->getName();

   if (name == WINDOW_SIZE_KW)
   {
      theWindowSize = property->valueToString().toUInt32();
   }
   else if (name == RECURSIVE_DILATION_KW)
   {
      ossimString value;
      property->valueToString(value);
      setRecursiveFlag(value.toBool());
   }
   else
   {
      ossimImageSourceFilter::setProperty(property);
   }
}

ossimRefPtr<ossimProperty> ossimDilationFilter::getProperty(const ossimString& name)const
{
   ossimRefPtr<ossimProperty> prop = 0;
   if (name == WINDOW_SIZE_KW)
   {
      prop = new ossimNumericProperty(WINDOW_SIZE_KW, ossimString::toString(theWindowSize), 3, 25);
      prop->setCacheRefreshBit();
      return prop;
   }
   else if (name == RECURSIVE_DILATION_KW)
   {
      prop = new ossimBooleanProperty(RECURSIVE_DILATION_KW, getRecursiveFlag());
      prop->setFullRefreshBit();
      return prop;
   }
   return ossimImageSourceFilter::getProperty(name);
}

void ossimDilationFilter::getPropertyNames(vector<ossimString>& propertyNames) const
{
   propertyNames.push_back(WINDOW_SIZE_KW);
   propertyNames.push_back(RECURSIVE_DILATION_KW);
   ossimImageSourceFilter::getPropertyNames(propertyNames);
}

bool ossimDilationFilter::saveState(ossimKeywordlist& kwl, const char* prefix)const
{
   kwl.add(prefix, WINDOW_SIZE_KW.c_str(), theWindowSize, true);
   kwl.add(prefix, RECURSIVE_DILATION_KW.c_str(), (theRecursiveFlag?"true":"false"), true);
   return ossimImageSourceFilter::saveState(kwl, prefix);
}

bool ossimDilationFilter::loadState(const ossimKeywordlist& kwl, const char* prefix)
{
   const char* lookup = kwl.find(prefix, WINDOW_SIZE_KW.c_str());
   if (lookup)
      theWindowSize = ossimString(lookup).toUInt32();
   
   lookup = kwl.find(prefix, RECURSIVE_DILATION_KW.c_str());
   if (lookup)
      setRecursiveFlag(ossimString(lookup).toBool());

   return ossimImageSourceFilter::loadState(kwl, prefix);
}