spatmod/imagebase.h

Go to the documentation of this file.

#ifndef  INC_SPATMOD_IMAGEBASE_H
#define  INC_SPATMOD_IMAGEBASE_H

#ifndef  INC_SPATMOD_IMAGEDIMENSIONS_H
#include <spatmod/imagedimensions.h>
#endif

#ifndef  INC_SPATMOD_IMAGEPIXEL_H
#include <spatmod/imagepixel.h>
#endif

#ifndef  INC_MI32_SIMPLEAR_H
#include <mi32/simplear.h>
#endif

#ifndef  INC_MI32_MILOG_H
#include <mi32/milog.h>
#endif

class REGION2D;

namespace SPATMOD {
namespace IMAGE {

class PIXELTABLE;
class SECTION_ITERATOR;

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

class BASE {
   public:

      enum CAPABILITY {
         CAPABILITY_Pull,                    
         CAPABILITY_Push                     
         };

      enum ZOOMABILITY {
         ZOOMABILITY_Only1X,                 
         ZOOMABILITY_List,                   
         ZOOMABILITY_Range                   
         };

      BASE ();

      virtual ~BASE ();

      ERRVALUE ComputeGeoreferenceRegion (
         REGION2D& region                    
         ) const;

      INT32 ComputeTileColumn (
         double x,                           
         double zoom = 1                     
         ) const;

      INT32 ComputeTileRow (
         double y,                           
         double zoom = 1                     
         ) const;

      const DIMENSIONS& GetDimensions (
         ) const { return (m_Dimensions); }

      ERRVALUE GetDimensions (
         DIMENSIONS& dimensions,             
         double zoom                         
         ) const;

      const GEOREFERENCE* GetGeoreference (
         ) const { return (m_pGeoreference); }

      ERRVALUE GetGeoreference (
         GEOREFERENCE& georeference,         
         double zoom                         
         ) const;

      const MILOG& GetLog () const
         { return (m_Log); }

      MILOG& GetLog ()
         { return (m_Log); }

      INT32 GetNumColumnsOfTiles (
         ) const { return (m_Dimensions.GetNumColumnsOfTiles()); }

      double GetNumColumnsPerTile (
         TILEPOSITION tileposition           
         ) const { return (m_Dimensions.GetNumColumnsPerTile(tileposition)); }

      INT32 GetNumRowsOfTiles (
         ) const { return (m_Dimensions.GetNumRowsOfTiles()); }

      double GetNumRowsPerTile (
         TILEPOSITION tileposition           
         ) const { return (m_Dimensions.GetNumRowsPerTile(tileposition)); }

      UINT16 GetNumSamples (
         ) const { return (GetPixelProperties().GetNumSamples()); }

      const PIXELTABLE* GetPixelLookupTable (
         ) const { return (v_GetPixelLookupTable()); }

      const PIXEL& GetPixelProperties (
         ) const { return (m_PixelProperties); }

      RANGETYPE GetPixelRangeType (
         ) const { return (m_PixelRangeType); }

      PIXEL::TYPE GetPixelType (
         ) const { return (GetPixelProperties().GetPixelType()); }

      const PIXEL& GetPixelValueMax (
         ) const { return (m_PixelValueMax); }

      const PIXEL& GetPixelValueMin (
         ) const { return (m_PixelValueMin); }

      UINT32 GetTotalColumns (
         ) const { return (m_Dimensions.GetTotalColumns()); }

      UINT32 GetTotalRows (
         ) const { return (m_Dimensions.GetTotalRows()); }

      const char* GetTypeName () const
         { return (v_GetTypeName()); }

      ZOOMABILITY GetZoomAbility (
         SIMPLE_ARRAY<double>& ZoomsAllowed  
         ) const { return (v_GetZoomAbility(ZoomsAllowed)); }

      ERRVALUE LogCreate (
         const char *label = 0,                    
         bool OnlyEnds = false,                    
         MILOG::MODE mode = MILOG::MODE_OwnFile    
         );

      bool QueryCapability (
         CAPABILITY capability
         ) const { return (v_QueryCapability(capability)); }

      float QueryIterator (
         const SECTION_ITERATOR& iterator    
         ) const;

      bool QueryZoom (
         double zoom
         ) const;

      void SetGeoreference (
         const GEOREFERENCE *pGeoreference   
         );

   protected:

      PIXELTABLE *m_pPixelLookupTable;       

      void AttachPixelLookupTable (
         PIXELTABLE& PixelTable              
         );

      void SetAllDimensions (
         const BASE& image                   
         );

      void SetAllProperties (
         const BASE& image                   
         );

      void SetDimensions (
         const DIMENSIONS& Dimensions
         );

      void SetPixelLookupTable (
         const PIXELTABLE *pPixelTable       
         );

      void SetPixelProperties (
         const PIXEL& PixelProperties
         );

      void SetPixelProperties (
         const BASE& image                   
         );

      ERRVALUE SetPixelRange (
         const PIXEL& PixelValueMin,
         const PIXEL& PixelValueMax,
         RANGETYPE RangeType
         );

      void SetPixelRangeDefault (
         );

      ERRVALUE SetTileDimensions (
         double ColumnsPerTile,
         double RowsPerTile,
         double ColumnsPerTileFirst = 0,
         double RowsPerTileFirst = 0,
         double ColumnsPerTileLast = 0,
         double RowsPerTileLast = 0
         );

      ERRVALUE SetTotalDimensions (
         UINT32 TotalColumns,
         UINT32 TotalRows
         );

      // BASE overridables.

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

      virtual const PIXELTABLE* v_GetPixelLookupTable (
         ) const;

      virtual bool v_QueryCapability (
         CAPABILITY capability
         ) const;

      virtual float v_QueryIterator (
         const SECTION_ITERATOR& iterator    
         ) const;

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      DIMENSIONS m_Dimensions;
      PIXEL m_PixelProperties;
      PIXEL m_PixelValueMin;
      PIXEL m_PixelValueMax;
      RANGETYPE m_PixelRangeType;
      GEOREFERENCE *m_pGeoreference;
      MILOG m_Log;

      #endif   // GENERATING_DOXYGEN_OUTPUT

      // BASE overridables.

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

      virtual const char* v_GetTypeName () const;

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

      virtual ERRVALUE v_LogCreate (
         const char *label,
         bool OnlyEnds,
         MILOG::MODE mode
         ) = 0;


   };

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

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

#endif    // INC_SPATMOD_IMAGEBASE_H

---