spatmod/imagefilter.h

Go to the documentation of this file.

#ifndef  INC_SPATMOD_IMAGEFILTER_H
#define  INC_SPATMOD_IMAGEFILTER_H

#ifndef  INC_SPATMOD_IMAGESTAGE_H
#include <spatmod/imagestage.h>
#endif

#ifndef  INC_SPATMOD_IMAGESTAGEARRAY_H
#include <spatmod/imagestagearray.h>
#endif

#ifndef  INC_SPATMOD_IMAGESTAGEAUTOPTR_H
#include <spatmod/imagestageautoptr.h>
#endif

namespace SPATMOD {
namespace IMAGE {

//=====================================================================================================================

class FILTER : public STAGE {
   public:

      // Destructor.
      virtual ~FILTER ();

   protected:

      FILTER (
         STAGE *pPreviousStage,              
         bool TakeOwnership                  
         );

      FILTER (
         STAGE_ARRAY& PreviousStages,        
         bool TakeOwnership                  
         );

      FILTER (
         unsigned NumPreviousStages
         );

      ERRVALUE CreateWorkBuffer (
         UINT32 NumColumns,                  
         UINT32 NumRows,                     
         unsigned index = 0                  
         );

      ERRVALUE CreateWorkBuffers (
         UINT32 NumColumns,                  
         UINT32 NumRows                      
         );

      void DestroyWorkBuffer (
         unsigned index = 0                  
         );

      void DestroyWorkBuffers (
         );

      unsigned GetNumPreviousStages (
         ) const { return (m_PrevStagePtrs.GetNumItems()); }

      STAGE* GetPreviousStage (
         unsigned index = 0                  
         ) const { return (m_PrevStagePtrs[index]); }

      bool GetPreviousStageOwnership (
         unsigned index = 0                  
         ) const { return (m_PrevStagePtrs[index].IsOwner()); }

      BUFFER& GetWorkBuffer (
         unsigned index = 0                  
         ) const { return (*m_pWorkBuffers[index]); }

      bool IsAutoCreateWorkBuffers (
         ) const { return (m_AutoCreateWorkBuffers); }

      void SetAutoCreateWorkBuffers (
         bool AutoCreateWorkBuffers = true
         ) { m_AutoCreateWorkBuffers = AutoCreateWorkBuffers; }

      void SetAutoDestroyWorkBuffers (
         bool AutoDestroyWorkBuffers
         ) { m_AutoDestroyWorkBuffers = AutoDestroyWorkBuffers; }

      void SetPreviousStage (
         unsigned index,                     
         STAGE *pPreviousStage,              
         bool TakeOwnership                  
         );

      // BASE overrides.

      virtual ERRVALUE v_GetDimensions (
         DIMENSIONS& dimensions,             
         double zoom                         
         ) const;

      virtual ERRVALUE v_GetGeoreference (
         GEOREFERENCE& georeference,
         double zoom
         ) const;

      virtual const PIXELTABLE* v_GetPixelLookupTable (
         ) const;

      virtual ZOOMABILITY v_GetZoomAbility (
         SIMPLE_ARRAY<double>& ZoomsAllowed  
         ) const;

      virtual float v_QueryIterator (
         const SECTION_ITERATOR& iterator    
         ) const;

      // STAGE overrides.

      virtual ERRVALUE v_PullBegin (
         const SECTION_ITERATOR& iterator    
         );

      virtual ERRVALUE v_PullEnd (
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      STAGE_ARRAY m_PrevStagePtrs;
      BUFFER **m_pWorkBuffers;
      bool m_AutoCreateWorkBuffers;
      bool m_AutoDestroyWorkBuffers;

      void v_GetMetadata (MISTRING& result, METADATACONTENT content, METADATAFORMAT format) const;
      virtual const char* v_GetTypeName () const;
      virtual ERRVALUE v_LogCreate (const char *label, bool OnlyEnds, MILOG::MODE mode);

      // Unimplemented
      FILTER (const FILTER&);
      FILTER& operator= (const FILTER&);
      #endif // GENERATING_DOXYGEN_OUTPUT

   };

//=====================================================================================================================

}  // End namespace IMAGE
}  // End namespace SPATMOD

#endif   // INC_SPATMOD_IMAGEFILTER_H

---