ossimRectangleCutFilter.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: ossimRectangleCutFilter.cpp 22953 2014-11-05 19:19:28Z dburken $
#include <ossim/imaging/ossimRectangleCutFilter.h>
#include <ossim/base/ossimTrace.h>
#include <ossim/base/ossimNotifyContext.h>
#include <ossim/base/ossimCommon.h>
#include <ossim/imaging/ossimImageData.h>
#include <ossim/imaging/ossimImageGeometry.h>

static ossimTrace traceDebug("ossimRectangleCutFilter:debug");

RTTI_DEF1(ossimRectangleCutFilter,
          "ossimRectangleCutFilter",
          ossimImageSourceFilter);

ossimRectangleCutFilter::ossimRectangleCutFilter(ossimObject* owner,
                                     ossimImageSource* inputSource)
   :ossimImageSourceFilter(owner, inputSource),
    theCutType(OSSIM_RECTANGLE_NULL_OUTSIDE)
{
   theRectangle.makeNan();
}

ossimRectangleCutFilter::ossimRectangleCutFilter(ossimImageSource* inputSource)
   :ossimImageSourceFilter(NULL, inputSource),
    theCutType(OSSIM_RECTANGLE_NULL_OUTSIDE)
{
   theRectangle.makeNan();
}


ossimRefPtr<ossimImageData> ossimRectangleCutFilter::getTile(
   const ossimIrect& rect,
   ossim_uint32 resLevel)
{
   ossimRefPtr<ossimImageData> tile = 0;

   if ( theInputConnection && isSourceEnabled() && ( theRectangle.hasNans() == false ) )
   {
      ossim_int32 decimationIndex = min((ossim_int32)resLevel,
                                        (ossim_int32)theDecimationList.size()-1);

      // Compute cut rect for resLevel:
      ossimIrect cutRect = theRectangle*theDecimationList[decimationIndex];

      // Check intersection of our cut rect:
      bool requestIntersects = rect.intersects( cutRect );
      bool requestCompletelyWithin = rect.completely_within(cutRect);
      
      if ( ( ( theCutType == OSSIM_RECTANGLE_NULL_OUTSIDE ) && requestIntersects ) ||
           ( ( theCutType == OSSIM_RECTANGLE_NULL_INSIDE ) && !requestCompletelyWithin ) )
      {
         // Grab tile from the input.
         tile = theInputConnection->getTile(rect, resLevel);

         if ( tile.valid() )
         {
            if ( tile->getDataObjectStatus() != OSSIM_NULL &&
                 tile->getDataObjectStatus() != OSSIM_EMPTY )
            {
               ossimIrect inputRectangle = tile->getImageRectangle();
               
               if( theCutType == OSSIM_RECTANGLE_NULL_OUTSIDE ) // Typical case...
               {
                  if ( !requestCompletelyWithin )
                  {
                     // Clip the tile:
                     ossim_int32 ulx = inputRectangle.ul().x;
                     ossim_int32 uly = inputRectangle.ul().y;
                     ossim_int32 w   = tile->getWidth();
                     ossim_int32 h   = tile->getHeight();
                     ossim_int32 offset = 0;
                     ossimIpt tempPoint(ulx, uly);
                     
                     for(ossim_int32 y = 0;  y < h; ++tempPoint.y,++y)
                     {
                        tempPoint.x = ulx;
                        for(ossim_int32 x = 0; x < w; ++tempPoint.x,++x)
                        {
                           if(!cutRect.pointWithin(tempPoint))
                           {
                              tile->setNull(offset);
                           }
                           ++offset;
                        }
                     }
                     tile->validate();
                  }
               }
               else // Null inside...
               {
                  // Note if complete within requested rect this block was bypassed entirely.
                  ossim_int32 ulx = inputRectangle.ul().x;
                  ossim_int32 uly = inputRectangle.ul().y;
                  ossim_int32 w   = tile->getWidth();
                  ossim_int32 h   = tile->getHeight();
                  ossim_int32 offset = 0;
                  ossimIpt tempPoint(ulx, uly);
                  
                  for(ossim_int32 y = 0;  y < h; ++tempPoint.y,++y)
                  {
                     tempPoint.x = ulx;
                     for(ossim_int32 x = 0; x < w; ++tempPoint.x,++x)
                     {
                        if(cutRect.pointWithin(tempPoint))
                        {
                           tile->setNull(offset);
                        }
                        ++offset;
                     }
                  }
                  tile->validate();
               }
               
            } // Matches: if ( tile->getDataObjectStatus() ... 
            
         } // Matches: if ( tile.valid() )
         
      } // Matches: if ( ( ( theCutType == OSSI ...
      
   } // Matches: if ( theInputConnection && enabled && ... 

   return tile;
} // End: ossimRectangleCutFilter::getTile( ... )

void ossimRectangleCutFilter::setRectangle(const ossimIrect& rect)
{
   theRectangle = rect;

   if(theRectangle.hasNans())
   {
      if(theInputConnection)
      {
         theRectangle = theInputConnection->getBoundingRect();
      }
   }
}

void ossimRectangleCutFilter::getValidImageVertices(
   vector<ossimIpt>& validVertices,
   ossimVertexOrdering ordering,
   ossim_uint32 /* resLevel */)const
{
   ossimIrect rect = getBoundingRect();

   if(ordering == OSSIM_CLOCKWISE_ORDER)
   {
      validVertices.push_back(rect.ul());
      validVertices.push_back(rect.ur());
      validVertices.push_back(rect.lr());
      validVertices.push_back(rect.ll());
   }
   else
   {
      validVertices.push_back(rect.ul());
      validVertices.push_back(rect.ll());
      validVertices.push_back(rect.lr());
      validVertices.push_back(rect.ur());
   }
}

ossimIrect ossimRectangleCutFilter::getBoundingRect(ossim_uint32 resLevel)const
{
   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG) << "ossimRectangleCutFilter::getBoundingRect DEBUG: entered..." << std::endl;
   }
   ossimIrect result;

   result.makeNan();
   if(!theInputConnection)
   {
      if(traceDebug())
      {
         ossimNotify(ossimNotifyLevel_DEBUG) << "ossimRectangleCutFilter::getBoundingRect DEBUG: Input connection was not valid so leaving" << std::endl;
      }
      return result;
   }

   result = theInputConnection->getBoundingRect(resLevel);
   if(isSourceEnabled())
   {
      if(theCutType == OSSIM_RECTANGLE_NULL_OUTSIDE)
      {
         ossimDpt decimation;
         getDecimationFactor(resLevel, decimation);
         ossimIrect cutRect = theRectangle;
         if(!decimation.hasNans())
         {
            cutRect = theRectangle*decimation;
         }
         result = cutRect;
      }
   }

   if(traceDebug())
   {
      ossimNotify(ossimNotifyLevel_DEBUG) << "ossimRectangleCutFilter::getBoundingRect DEBUG: cut rect = " << result  << std::endl;
   }
   return result;
}

void ossimRectangleCutFilter::initialize()
{
   theDecimationList.clear();
   if(theInputConnection)
   {
      getDecimationFactors(theDecimationList);
   }
   if(theDecimationList.empty())
   {
      theDecimationList.push_back(ossimDpt(1,1));
   }
   if(theRectangle.hasNans())
   {
      setRectangle(theRectangle);
   }
}

bool ossimRectangleCutFilter::saveState(ossimKeywordlist& kwl,
                                        const char* prefix)const
{
   ossimString newPrefix = prefix;
   newPrefix+="clip_rect.";
   
   theRectangle.saveState(kwl, newPrefix);

   if(theCutType == OSSIM_RECTANGLE_NULL_INSIDE)
   {
      kwl.add(prefix,
              "cut_type",
              "null_inside",
              true);
   }
   else if(theCutType == OSSIM_RECTANGLE_NULL_OUTSIDE)
   {
      kwl.add(prefix,
              "cut_type",
              "null_outside",
              true);      
   }
   
   return ossimImageSourceFilter::saveState(kwl, prefix);
}

bool ossimRectangleCutFilter::loadState(const ossimKeywordlist& kwl,
                                        const char* prefix)
{
   ossimString newPrefix = prefix;
   
   ossimString rect = kwl.find(prefix, "rect");
   if(!rect.empty())
   {
      theRectangle.toRect(rect);
   }
   else 
   {
      newPrefix+="clip_rect.";
      
      theRectangle.loadState(kwl, newPrefix.c_str());
   }

   const char* cutType = kwl.find(prefix, "cut_type");
   if(cutType)
   {
      ossimString c = cutType;
      if(c == "null_inside")
      {
         theCutType = OSSIM_RECTANGLE_NULL_INSIDE;
      }
      else if(c == "null_outside")
      {
         theCutType = OSSIM_RECTANGLE_NULL_OUTSIDE;         
      }
      else
      {
         theCutType = static_cast<ossimRectangleCutType>(ossimString(cutType).toLong());
      }
   }

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

const ossimIrect& ossimRectangleCutFilter::getRectangle()const
{
   return theRectangle;
}

ossimRectangleCutFilter::ossimRectangleCutType ossimRectangleCutFilter::getCutType()const
{
   return theCutType;
}

void ossimRectangleCutFilter::setCutType(ossimRectangleCutType cutType)
{
   theCutType = cutType;
}