ossimGridRemapSource.h

Go to the documentation of this file.

//*****************************************************************************
// FILE: ossimGridRemapSource.h
//
// Copyright (C) 2001 ImageLinks, Inc.
//
// License:  MIT
// 
// See LICENSE.txt file in the top level directory for more details.
//
// AUTHOR: Oscar Kramer
//
// DESCRIPTION: Contains declaration of class ossimGridRemapSource. This is
//   a spacially variant remapper that utilizes a grid for interpolating the
//   remap value given an image x, y. 
//
// LIMITATIONS: None.
//
//*****************************************************************************
//  $Id: ossimGridRemapSource.h 15766 2009-10-20 12:37:09Z gpotts $

#ifndef ossimGridRemapSource_HEADER
#define ossimGridRemapSource_HEADER

#include <ossim/imaging/ossimImageSourceFilter.h>
#include <vector>
#include <ossim/imaging/ossimGridRemapEngine.h>
#include <ossim/base/ossimFilename.h>

class ossimDblGrid;
class ossimDrect;
class ossimDpt;
class ossimImageData;

/*!****************************************************************************
 *
 * CLASS:  ossimGridRemapSource
 *
 *****************************************************************************/
class ossimGridRemapSource : public ossimImageSourceFilter
{
public:
   ossimGridRemapSource();
   ossimGridRemapSource(ossimImageSource* inputSource,
                        ossimGridRemapEngine* engine);

   void setRemapEngine(ossimGridRemapEngine* engine);
   
   ossimGridRemapEngine* getRemapEngine() { return theRemapEngine; }
   
   virtual void initialize(const ossimDrect& uv_rect,
               const ossimDpt&   grid_spacing);

  void setGridNode(const ossimDpt& view_pt,
           const double*    value);
  
   virtual ossimRefPtr<ossimImageData> getTile(const  ossimIrect& origin,
                                   ossim_uint32 resLevel=0);

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

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

   void lock() { theRemapIsLockedFlag = true; }

   void unlock() { theRemapIsLockedFlag = false; }
   
   bool isLocked() const { return theRemapIsLockedFlag; }

   ossimDblGrid* getGrid(unsigned int index);

   const ossimFilename& getGridFilename() const { return theGridFilename; }

   void setGridFilename(const ossimFilename& grid_filename);
   
protected:
   virtual ~ossimGridRemapSource();

   void deallocateGrids();
   
   vector<ossimDblGrid*> theGrids;
   ossimFilename         theGridFilename;
   ossimGridRemapEngine* theRemapEngine;
   bool                  theRemapIsLockedFlag;
   bool                  theGridIsFilled;
   
TYPE_DATA
};

#endif