rvc/raster.h

Go to the documentation of this file.

/***
 * \file rvc/raster.h
 * \brief interface for the RVC::RASTER class.
 *
 * \if NODOC
 * $Id: raster.h_v 1.109 2012/06/08 14:57:57 mju Exp $
 *
 * $Log: raster.h_v $
 * Revision 1.109  2012/06/08 14:57:57  mju
 * Add getComponentTextID.
 *
 * Revision 1.108  2011/10/11 13:51:45  mju
 * Remove unneeded hdr.
 *
 * Revision 1.107  2009/03/24 22:14:25  bcolombe
 * Added AutoLinkJP2
 *
 * Revision 1.106  2008/05/01 19:58:42  mju
 * Add getPyramidInfo to return array of tier dimensions.
 *
 * Revision 1.104  2008/01/09 17:37:49  mju
 * Remove comptype_none, add "correct" name for comptype_JPEG2000.
 *
 * Revision 1.103  2007/11/08 18:28:06  scowan
 * Added method to get the raster components univariate statistics.
 *
 * Revision 1.102  2007/08/28 16:12:27  mju
 * Add linkparms_gdal.
 *
 * Revision 1.101  2007/05/08 15:52:27  dwilliss
 * SML namespace
 *
 * Revision 1.100  2007/04/27 20:27:16  scowan
 * Added static version of getPyramidList.
 *
 * Revision 1.96  2007/03/13 15:25:02  mju
 * Change getTileSize to return current settings and make inline.
 *
 * Revision 1.95  2007/03/09 21:03:06  scowan
 * Made getPyramidList const.
 *
 * Revision 1.94  2007/02/21 17:55:42  scowan
 * Support empty tile compression type.
 *
 * Revision 1.93  2007/01/29 16:45:58  scowan
 * Prototype correct rast link data gen.
 *
 * Revision 1.92  2007/01/19 16:10:30  mju
 * Use color_array.
 *
 * Revision 1.91  2007/01/12 23:09:09  dfriberg
 * Allow access of linktype in RASTER::LINKPARMS
 *
 * Revision 1.90  2006/12/29 00:37:15  dfriberg
 * Add LINKTYPE_GDAL
 *
 * Revision 1.89  2006/10/27 22:50:04  scowan
 * Made getCellType virtual.
 *
 * Revision 1.88  2006/10/26 01:08:46  dfriberg
 * Set raster handle method added
 *
 * Revision 1.87  2006/10/19 20:39:03  mju
 * Use pyramid_default instead of pyramid_none.
 *
 * Revision 1.86  2006/10/09 14:53:56  dfriberg
 * Add method for getting embedded link info
 *
 * Revision 1.85  2006/09/07 15:25:41  dfriberg
 * Make MULTIRASTER friend of RASTER::LINKPARMS
 *
 * Revision 1.84  2006/07/28 13:31:39  mju
 * Use const in write.
 *
 * Revision 1.82  2006/06/27 15:04:45  scowan
 * Make method now fills in objitem with created object info.
 *
 * Revision 1.81  2006/05/31 15:05:57  scowan
 * Added setCacheRect virtual method.
 *
 * Revision 1.80  2006/05/05 16:51:37  dfriberg
 * Add LINKTYPE_Multi
 *
 * Revision 1.79  2006/04/19 03:38:07  dfriberg
 * Add Link method that allows settings usage
 *
 * Revision 1.78  2006/04/12 14:47:06  mju
 * Un-deprecate makePyramidSet variant which has no compression parameters.
 *
 * Revision 1.77  2006/03/23 17:37:33  dfriberg
 * Order of parameters fixed on MakePyramidSet for RVC_CREDENTIALS_MANDATORY
 *
 * Revision 1.76  2006/03/22 16:09:14  dfriberg
 * Compression parameters added to MakePyramidSet
 *
 * Revision 1.75  2006/01/26 16:28:23  dfriberg
 * Add protected methods to get raster handle
 *
 * Revision 1.74  2006/01/03 21:37:31  mju
 * Add extractTo method.
 *
 * Revision 1.73  2005/12/19 17:44:31  dwilliss
 * adjusted default credentials to account for prior default parameters
 *
 * Revision 1.72  2005/12/19 17:02:23  linux32build!dwilliss
 * Credentials can now be made mandatory by setting a #define
 *
 * Revision 1.71  2005/12/09 17:29:49  scowan
 * Updated to use credentials.
 *
 * Revision 1.70  2005/12/02 20:33:38  mju
 * Add copyRasterTo methods.
 *
 * Revision 1.69  2005/11/28 17:45:58  mju
 * Add isfirst parm to computeNextPyramidSize.
 *
 * Revision 1.68  2005/11/23 18:37:16  apple64build!build
 * Created INTERLEAVE_TYPE enum in LINKPARMS_GENERIC
 *
 * Revision 1.67  2005/10/26 15:48:49  dfriberg
 * Deprecated old LINKPARMS_GENERIC constructor
 *
 * Revision 1.66  2005/10/07 17:48:44  dfriberg
 * Added back in old constructor for LINKPARMS_GENERIC
 *
 * Revision 1.65  2005/10/07 17:36:41  dfriberg
 * Add more methods to LINKPARMS_GENERIC
 *
 * Revision 1.64  2005/10/07 17:13:38  dfriberg
 * Add ImageScale set method for LINKPARMS_GENERIC
 *
 * Revision 1.63  2005/10/07 15:33:16  dfriberg
 * Removed unneeded comments
 *
 * Revision 1.62  2005/10/07 15:28:19  dfriberg
 * Unix compile errors
 *
 * Revision 1.61  2005/10/06 23:13:09  dfriberg
 * Modify LINKPARMS_GENERIC constructor and add Set methods
 *
 * Revision 1.60  2005/09/07 23:00:49  dfriberg
 * Add optional parameter to CopySampledTo for specifying destination rectangle
 *
 * Revision 1.59  2005/09/01 22:37:18  scowan
 * Added queryStepOrder method.
 *
 * Revision 1.58  2005/08/18 20:52:40  dfriberg
 * Added CopySampledTo that takes a LRECT2D for copying rectangle
 *
 * Revision 1.57  2005/07/11 23:30:02  scowan
 * Remove legacy name desc make and link methods.
 *
 * Revision 1.56  2005/05/31 20:48:09  scowan
 * Added more usage types.
 *
 * Revision 1.55  2005/04/15 19:36:30  mju
 * Add parm to fix celltype in setCompression.
 *
 * Revision 1.54  2005/04/01 15:27:39  mju
 * Default image line/column 'scale' to 0 so indicates not set.
 *
 * Revision 1.1  2000/10/02 17:23:21  scowan
 * Initial revision
 * \endif
***/

#ifndef INC_RVC_RASTER_H
#define INC_RVC_RASTER_H

#ifndef INC_RVC_IMAGE_H
   #include <rvc/image.h>
#endif

#ifndef INC_MI32_ANYRASTV_H
   #include <mi32/anyrastv.h>
#endif

#ifndef INC_MI32_IMAGEDIMENSIONS_H
   #include <mi32/imagedimensions.h>
#endif


#ifndef GENERATING_DOXYGEN_OUTPUT
// Forward declarations.
class COLOR_ARRAY;
class STAT_UNIVARIATE;
namespace SML {
   class CONTEXT;
   }
namespace RVC {
   class RASTERHANDLE;
   struct RASTERLINKPARMS;
   struct RASTLINKDATAGEN;
   struct RASTINFO;
   }
#endif // GENERATING_DOXYGEN_OUTPUT


namespace RVC {

class RASTER : public RVC::IMAGE {
   public:

      enum COMPONENT {           
         COMPONENT_Default = 0,     
         COMPONENT_Red,             
         COMPONENT_Green,           
         COMPONENT_Blue,            
         COMPONENT_Real,            
         COMPONENT_Imaginary,       
         COMPONENT_Magnitude,       
         COMPONENT_Phase,           
         COMPONENT_Alpha,           
         COMPONENT_Cyan,            
         COMPONENT_Magenta,         
         COMPONENT_Yellow,          
         COMPONENT_Black            
         };

      enum COMPTYPE {            
         COMPTYPE_None =      0,    
         COMPTYPE_RLE =       1,    
         COMPTYPE_JPEG =      2,    
         COMPTYPE_Huffman =   3,    
         COMPTYPE_DPCM =      4,    
         COMPTYPE_JPEG2000 =  5,    
         COMPTYPE_JP2 =       COMPTYPE_JPEG2000,
         };

      enum LINKTYPE {               
         LINKTYPE_NoLink = 0,       
         LINKTYPE_TIFF = 2,         
         LINKTYPE_Generic = 3,      
         LINKTYPE_MrSID = 4,
         LINKTYPE_ECW = 5,
         LINKTYPE_JP2 = 6,
         LINKTYPE_SocetSetDT = 7,
         LINKTYPE_PNG = 8,
         LINKTYPE_JPEG = 9,
         LINKTYPE_GDAL = 10,
         LINKTYPE_Multi = 2000
         };

      enum STEPORDER {
         STEPORDER_FullSequential,     
         STEPORDER_TileSequential,     
         STEPORDER_TileRandom,         
         STEPORDER_AnyRandom           
         };

      enum USAGE {               
         USAGE_Default = 0,         
         USAGE_HyspcBand,           
         USAGE_HyspcClass,          
         USAGE_HyspcAverage,        
         USAGE_Pyramid,             
         USAGE_PrinComp,            
         USAGE_NullBand,            
         USAGE_Opacity,             
         USAGE_SurfaceElevation,    
         USAGE_SurfaceError,        
         USAGE_SurfaceRadius,       
         USAGE_MultiRasterTile      
         };

      #ifndef GENERATING_DOXYGEN_OUTPUT
      // Forward declarations
      class GETOBJFILTER_ISSELECTABLE;
      class GETOBJFILTER_ISOVERLAPPING;
      #endif // GENERATING_DOXYGEN_OUTPUT

      class IMAGESCALE {
         public:

            IMAGESCALE (
               ) :
               m_LineScale(0.0),
               m_ColumnScale(0.0),
               m_DataScale(1.0),
               m_DataOffset(0.0)
               {}

            double GetColumnScale (
               ) const {return (m_ColumnScale); }

            double GetDataOffset (
               ) const {return (m_DataOffset);}

            double GetDataScale (
               ) const {return (m_DataScale);}

            double GetLineScale (
               ) const {return (m_LineScale);}

            void SetColumnScale (
               double ColumnScale
               ) { m_ColumnScale = ColumnScale; }

            void SetDataOffset (
               double DataOffset
               ) {m_DataOffset = DataOffset; }

            void SetDataScale (
               double DataScale
               ) {
               m_DataScale = DataScale;
               if (m_DataScale == 0.0) m_DataScale = 1.0;
               }

            void SetLineScale (
               double LineScale
               ) { m_LineScale = LineScale; }

         private:
            #ifndef GENERATING_DOXYGEN_OUTPUT

            double m_LineScale;           
            double m_ColumnScale;         
            double m_DataScale;           
            double m_DataOffset;       
            #endif // GENERATING_DOXYGEN_OUTPUT
         }; // End of IMAGESCALE nested class.

      #ifndef GENERATING_DOXYGEN_OUTPUT
      // Forward declarations
      class LINKPARMS;
      class LINKPARMS_ECW;
      class LINKPARMS_GDAL;
      class LINKPARMS_GENERIC;
      class LINKPARMS_JP2;
      class LINKPARMS_JPEG;
      class LINKPARMS_MRSID;
      class LINKPARMS_PNG;
      class LINKPARMS_SOCETSETDT;
      class LINKPARMS_TIFF;
      #endif // GENERATING_DOXYGEN_OUTPUT

      class MAKEPARMS {
         public:

            MAKEPARMS (
               INT32 NumLines,
               INT32 NumColumns,
               IMAGE::CELLTYPE CellType
               ) :
               m_NumLines(NumLines),
               m_NumColumns(NumColumns),
               m_CellType(CellType),
               m_TileLines(0),
               m_TileColumns(0),
               m_Usage(USAGE_Default),
               m_Inverted(false),
               m_PackOrder(PACKORDER_MostSigBit),
               m_CompType(COMPTYPE_None),
               m_CompQuality(75),
               m_UsedBits(0),
               m_IsCompressed(false),
               m_IsLossyCompressed(false),
               m_Fill(false),
               m_NoEmbeddedPyramidTiers(false)
               { }

            MAKEPARMS (
               const RASTER& Template,          
               IMAGE::CELLTYPE CellType = CELLTYPE_Invalid  
               ) :
               m_NumLines(Template.GetNumLines()),
               m_NumColumns(Template.GetNumColumns()),
               m_CellType((CellType!=CELLTYPE_Invalid)?CellType:Template.GetCellType()),
               m_TileLines(Template.GetNumTileLines()),
               m_TileColumns(Template.GetNumTileColumns()),
               m_Usage(Template.GetUsage()),
               m_Inverted(false),
               m_PackOrder(PACKORDER_MostSigBit),
               m_CompType(COMPTYPE_None),
               m_CompQuality(75),
               m_UsedBits(Template.GetNumUsedBits()),
               m_IsCompressed(false),
               m_IsLossyCompressed(false),
               m_Fill(false),
               m_NoEmbeddedPyramidTiers(false)
               {
               Template.GetImageScale(m_ImageScale);
               }

            IMAGE::CELLTYPE GetCellType (
               ) const {return (m_CellType);}

            UINT16 GetCompressionQuality (
               ) const {return (m_CompQuality);}

            COMPTYPE GetCompressionType (
               ) const {return (m_CompType);}

            IMAGE::DATATYPE GetDataType (
               ) const {return (IMAGE::GetDataTypeFromCellType(m_CellType));}

            INT32 GetDftTileSize (
               ) const;

            const IMAGESCALE& GetImageScale (
               ) const {return (m_ImageScale);}

            bool GetInitialValue (
               ANYRASTVALUE& value
               ) const {
               value = m_InitValue;
               return (m_Fill);
               }

            UINT16 GetNumBits (
               ) const {return (IMAGE::GetNumBitsFromCellType(m_CellType));}

            INT32 GetNumColumns (
               ) const {return (m_NumColumns);}

            INT32 GetNumLines (
               ) const {return (m_NumLines);}

            UINT16 GetNumUsedBits (
               ) const { return (m_UsedBits); }

            void GetTileSize (
               INT32& TileLines,          
               INT32& TileColumns         
               ) const { TileLines = m_TileLines; TileColumns = m_TileColumns; }

            void GetValueMinMax (
               ANYRASTVALUE& min,         
               ANYRASTVALUE& max          
               ) const;

            bool IsLossyCompressed (
               ) const {return (m_IsLossyCompressed);}

            bool IsValidCompression (
               COMPTYPE CompType
               ) const;

            void SetCellType (
               CELLTYPE CellType
               ) {m_CellType = CellType;}

            ERRVALUE SetCompression (
               COMPTYPE CompType,         
               UINT16 CompQuality,        
               bool FixCellType = false   
               );

            void SetIncludeEmbeddedPyramidTiers (
               bool IncludeTiers
               ) { m_NoEmbeddedPyramidTiers = !IncludeTiers; }

            void SetImageScale (
               const IMAGESCALE& ImageScale
               ) {m_ImageScale = ImageScale; }

            void SetInitialValue (
               const ANYRASTVALUE& value
               ) { m_InitValue = value; m_Fill = true; }

            void SetInverted (
               ) {m_Inverted = true;}

            void SetNumColumns (
               INT32 NumColumns
               ) {m_NumColumns = NumColumns;}

            void SetNumLines (
               INT32 NumLines
               ) {m_NumLines = NumLines;}

            void SetNumUsedBits (
               const RASTER& SrcRastObj
               );

            void SetNumUsedBits (
               UINT16 UsedBits
               ) { m_UsedBits = UsedBits; }

            void SetPackOrder (
               PACKORDER PackOrder        
               ) {m_PackOrder = PackOrder;}

            void SetTileSize (
               INT32 TileLines,
               INT32 TileColumns
               ) { m_TileLines = TileLines; m_TileColumns = TileColumns; }

            void SetUsage (
               USAGE usage
               ) { m_Usage = usage; }

         private:
            #ifndef GENERATING_DOXYGEN_OUTPUT

            INT32 m_NumLines;             
            INT32 m_NumColumns;           
            CELLTYPE m_CellType;          
            PACKORDER m_PackOrder;        
            USAGE m_Usage;                
            INT32 m_TileLines;            
            INT32 m_TileColumns;          
            COMPTYPE m_CompType;          
            UINT16 m_CompQuality;         
            UINT16 m_UsedBits;            
            bool m_Inverted;              
            bool m_IsCompressed;          
            bool m_IsLossyCompressed;     
            bool m_Fill;
            bool m_NoEmbeddedPyramidTiers;
            ANYRASTVALUE m_InitValue;     
            IMAGESCALE m_ImageScale;

            friend class RASTER;
            #endif // GENERATING_DOXYGEN_OUTPUT
         }; // End of MAKEPARMS nested class.

      static TEXTID GetComponentTextID (
         COMPONENT component
         );

      RASTER ();

      RASTER (
         const RVC::RASTER& rhs
         );

      virtual ~RASTER ();

      RVC::RASTER& operator= (
         const RVC::RASTER& rhs
         );

      static ERRVALUE AutoLinkJP2 (
         RVC::OBJECT& ParentObj,
         const FILEPATH& LinkFile,
         RVC::GEOSPATIAL::MAKELINKFLAGS LinkFlags
         );

      static ERRVALUE AutoLinkTIFF (
         RVC::OBJECT& ParentObj,
         const FILEPATH& LinkFile,
         RVC::GEOSPATIAL::MAKELINKFLAGS LinkFlags
         );

      static bool ComputeNextPyramidSize (
         INT32& NumColumns,
         INT32& NumLines,
         bool IsFirst                        
         );

      ERRVALUE ComputeUnivariateStatistics (
         STAT_UNIVARIATE& StatUnivariate,          
         COMPONENT Component = COMPONENT_Default   
         );

      ERRVALUE CopyAverageTo (
         RASTER& DestRaster,
         INT32 ColumnSample,
         INT32 LineSample,
         COLOR_ARRAY* ColorMap = 0
         );

      ERRVALUE CopyRasterTo (
         RVC::OBJITEM& ObjItemTarget,        
         const MAKEPARMS& MakeParm,          
         const CREDENTIALS* Credentials RVC_DEFAULT_CREDENTIALS   
         );

      ERRVALUE CopyRasterTo (
         RASTER& TargetRaster                
         );

      ERRVALUE CopySampledTo (
         RASTER& DestRaster,
         INT32 ColumnSample,
         INT32 LineSample
         );

      ERRVALUE CopySampledTo (
         RASTER& DestRaster,
         INT32 ColumnSample,
         INT32 LineSample,
         const LRECT2D& ExtractRect,      
         LRECT2D* DestRect = 0            
         );

      ERRVALUE CreateSMLContext (
         SML::CONTEXT **pcontext             
         );

      ERRVALUE ExtractTo (
         RASTER& TgtRaster,               
         const LRECT2D& SrcRect,          
         LRECT2D* TgtRect = 0             
         );

      ERRVALUE GetComponents (
         SIMPLE_ARRAY<COMPONENT>& Components
         ) const;

      COMPTYPE GetCompressionType (
         ) const {return (m_MakeParms.m_CompType);}

      IMAGE::DATATYPE GetDataType (
         ) const {return (m_MakeParms.GetDataType());}

      ERRVALUE GetEmbeddedPyramidList (
         SIMPLE_ARRAY<INT32>& samplerates
         );

      const MAKEPARMS& GetMakeParms (
         ) const {return (m_MakeParms);}

      ERRVALUE GetImageScale (
         IMAGESCALE& scale                
         ) const;

      LINKTYPE GetLinkType (
         ) const {return (m_LinkType);}

      ERRVALUE GetNullValue (
         NULLVALUE& NullValue             
         ) const;

      UINT16 GetNumBits (
         ) const {return (m_MakeParms.GetNumBits());}

      INT32 GetNumTileColumns (
         ) const {return (m_MakeParms.m_TileColumns);}

      INT32 GetNumTileLines (
         ) const {return (m_MakeParms.m_TileLines);}

      UINT16 GetNumUsedBits (
         ) const { return (m_MakeParms.m_UsedBits); }

      INT32 GetNumXTiles (
         ) const {return (m_XTiles);}

      INT32 GetNumYTiles (
         ) const {return (m_YTiles);}

      PACKORDER GetPackOrder (
         ) const {return (m_MakeParms.m_PackOrder);}

      ERRVALUE GetPyramidInfo (
         SIMPLE_ARRAY<IMAGEDIMENSIONS>& TierInfo,  
         RVC::OBJITEMLIST& PyramidList             
         ) const;

      static ERRVALUE GetPyramidInfo (
         const OBJITEM& RastObjItem,
         SIMPLE_ARRAY<IMAGEDIMENSIONS>& TierInfo,                 
         RVC::OBJITEMLIST& PyramidList,                           
         const CREDENTIALS* Credentials RVC_DEFAULT_CREDENTIALS   
         );

      ERRVALUE GetPyramidList (
         SIMPLE_ARRAY<INT32>& SampleList,    
         RVC::OBJITEMLIST& PyramidList       
         ) const;

      static ERRVALUE GetPyramidList (
         const OBJITEM& RastObjItem,
         SIMPLE_ARRAY<INT32>& SampleList,                         
         RVC::OBJITEMLIST& PyramidList,                           
         const CREDENTIALS* Credentials RVC_DEFAULT_CREDENTIALS   
         );

      INT32 GetTileSizeBytes (
         ) const {return (m_TileSize);}

      USAGE GetUsage (
         ) const {return (m_MakeParms.m_Usage);}

      bool HasNullValue (
         ) const;

      bool IsCompressed (
         ) const {return (m_MakeParms.m_IsCompressed);}

      bool IsLossyCompressed (
         ) const {return (m_MakeParms.m_IsLossyCompressed);}

      bool IsInverted (
         ) const {return (m_MakeParms.m_Inverted);}

      ERRVALUE Link (
         const RVC::OBJECT& parent,             
         const RVC::DESCRIPTOR& Descriptor,
         const LINKPARMS& LinkParms,
         const CREDENTIALS* Credentials RVC_DEFAULT_CREDENTIALS            
         );

      ERRVALUE Link (
         const RVC::OBJECT& parent,             
         const RVC::DESCRIPTOR& Descriptor,
         const LINKPARMS& LinkParms,
         USAGE Usage,                                                      
         const CREDENTIALS* Credentials RVC_DEFAULT_CREDENTIALS            
         );

      ERRVALUE Make (
         const RVC::OBJECT& parent,             
         const RVC::DESCRIPTOR& Descriptor,
         MAKEPARMS& MakeParms,                     
         const CREDENTIALS* Credentials RVC_DEFAULT_CREDENTIALS            
         );

      ERRVALUE Make (
         RVC::OBJITEM& ObjItem,              
         MAKEPARMS& MakeParms,               
#ifdef RVC_CREDENTIALS_MANDATORY
         const char* Source,                 
#else
         const char* Source = 0,                
#endif
         const CREDENTIALS* Credentials RVC_DEFAULT_CREDENTIALS            
         );

      ERRVALUE MakePyramidSet (
#ifdef RVC_CREDENTIALS_MANDATORY
         IMAGE::PYRAMID flags,
#else
         IMAGE::PYRAMID flags = IMAGE::PYRAMID_Default,
#endif
         const CREDENTIALS* Credentials RVC_DEFAULT_CREDENTIALS            
         );

      ERRVALUE MakePyramidSet (
#ifdef RVC_CREDENTIALS_MANDATORY
         RASTER::COMPTYPE comptype,
         UINT16 compquality,
         IMAGE::PYRAMID flags,
#else
         RASTER::COMPTYPE comptype,
         UINT16 compquality,
         IMAGE::PYRAMID flags = IMAGE::PYRAMID_Default,
#endif
         const CREDENTIALS* Credentials RVC_DEFAULT_CREDENTIALS            
         );

      float QueryStepOrder (
         STEPORDER steporder                 
         );

      ERRVALUE Read (
         INT32 Line,                               
         INT32 StartColumn,                        
         void *data,                               
         INT32 Length = 1,                         
         CONVMODE Convert = CONVMODE_None,         
         COMPONENT Component = COMPONENT_Default   
         ) const;

      ERRVALUE Read (
         INT32 Line,                               
         INT32 StartColumn,                        
         INT8 *data,                               
         INT32 Length = 1,                         
         COMPONENT Component = COMPONENT_Default   
         ) const { return (Read(Line, StartColumn, data, Length, CONVMODE_INT8, Component)); }

      ERRVALUE Read (
         INT32 Line,                         
         INT32 StartColumn,                     
         UINT8 *data,                        
         INT32 Length = 1,                   
         COMPONENT Component = COMPONENT_Default      
         ) const { return (Read(Line, StartColumn, data, Length, CONVMODE_INT8, Component)); }

      ERRVALUE Read (
         INT32 Line,                         
         INT32 StartColumn,                     
         INT16 *data,                        
         INT32 Length = 1,                   
         COMPONENT Component = COMPONENT_Default      
         ) const { return (Read(Line, StartColumn, data, Length, CONVMODE_INT16, Component)); }

      ERRVALUE Read (
         INT32 Line,                         
         INT32 StartColumn,                     
         UINT16 *data,                       
         INT32 Length = 1,                   
         COMPONENT Component = COMPONENT_Default      
         ) const { return (Read(Line, StartColumn, data, Length, CONVMODE_INT16, Component)); }

      ERRVALUE Read (
         INT32 Line,                         
         INT32 StartColumn,                     
         INT32 *data,                        
         INT32 Length = 1,                   
         COMPONENT Component = COMPONENT_Default      
         ) const { return (Read(Line, StartColumn, data, Length, CONVMODE_INT32, Component)); }

      ERRVALUE Read (
         INT32 Line,                         
         INT32 StartColumn,                     
         UINT32 *data,                       
         INT32 Length = 1,                   
         COMPONENT Component = COMPONENT_Default      
         ) const { return (Read(Line, StartColumn, data, Length, CONVMODE_INT32, Component)); }

      ERRVALUE Read (
         INT32 Line,                         
         INT32 StartColumn,                     
         float *data,                        
         INT32 Length = 1,                   
         COMPONENT Component = COMPONENT_Default      
         ) const { return (Read(Line, StartColumn, data, Length, CONVMODE_Float, Component)); }

      ERRVALUE Read (
         INT32 Line,                         
         INT32 StartColumn,                     
         double *data,                       
         INT32 Length = 1,                   
         COMPONENT Component = COMPONENT_Default      
         ) const { return (Read(Line, StartColumn, data, Length, CONVMODE_Double, Component)); }

      ERRVALUE ReadColumn (
         INT32 Line,                         
         INT32 StartColumn,                     
         void *data,                         
         INT32 Length = 1,                   
         CONVMODE Convert = CONVMODE_None,         
         COMPONENT Component = COMPONENT_Default      
         ) const;

      ERRVALUE ReadColumn (
         INT32 Line,                         
         INT32 StartColumn,                     
         INT8 *data,                         
         INT32 Length = 1,                   
         COMPONENT Component = COMPONENT_Default      
         ) const { return (ReadColumn(Line, StartColumn, data, Length, CONVMODE_INT8, Component)); }

      ERRVALUE ReadColumn (
         INT32 Line,                         
         INT32 StartColumn,                     
         UINT8 *data,                        
         INT32 Length = 1,                   
         COMPONENT Component = COMPONENT_Default      
         ) const { return (ReadColumn(Line, StartColumn, data, Length, CONVMODE_INT8, Component)); }

      ERRVALUE ReadColumn (
         INT32 Line,                         
         INT32 StartColumn,                     
         INT16 *data,                        
         INT32 Length = 1,                   
         COMPONENT Component = COMPONENT_Default      
         ) const { return (ReadColumn(Line, StartColumn, data, Length, CONVMODE_INT16, Component)); }

      ERRVALUE ReadColumn (
         INT32 Line,                         
         INT32 StartColumn,                     
         UINT16 *data,                       
         INT32 Length = 1,                   
         COMPONENT Component = COMPONENT_Default      
         ) const { return (ReadColumn(Line, StartColumn, data, Length, CONVMODE_INT16, Component)); }

      ERRVALUE ReadColumn (
         INT32 Line,                         
         INT32 StartColumn,                     
         INT32 *data,                        
         INT32 Length = 1,                   
         COMPONENT Component = COMPONENT_Default      
         ) const { return (ReadColumn(Line, StartColumn, data, Length, CONVMODE_INT32, Component)); }

      ERRVALUE ReadColumn (
         INT32 Line,                         
         INT32 StartColumn,                     
         UINT32 *data,                       
         INT32 Length = 1,                   
         COMPONENT Component = COMPONENT_Default      
         ) const { return (ReadColumn(Line, StartColumn, data, Length, CONVMODE_INT32, Component)); }

      ERRVALUE ReadColumn (
         INT32 Line,                         
         INT32 StartColumn,                     
         float *data,                        
         INT32 Length = 1,                   
         COMPONENT Component = COMPONENT_Default      
         ) const { return (ReadColumn(Line, StartColumn, data, Length, CONVMODE_Float, Component)); }

      ERRVALUE ReadColumn (
         INT32 Line,                         
         INT32 StartColumn,                     
         double *data,                       
         INT32 Length = 1,                   
         COMPONENT Component = COMPONENT_Default      
         ) const { return (ReadColumn(Line, StartColumn, data, Length, CONVMODE_Double, Component)); }

      ERRVALUE SetImageScale (
         const IMAGESCALE& scale                
         );

      ERRVALUE SetNullValue (
         const NULLVALUE& NullValue,               
         bool NullUsed = true                      
         );

      ERRVALUE Write (
         INT32 Line,                               
         INT32 StartColumn,                        
         const void *data,                         
         INT32 Length = 1,                         
         CONVMODE Convert = CONVMODE_None,         
         COMPONENT Component = COMPONENT_Default   
         );

      ERRVALUE Write (
         INT32 Line,                         
         INT32 StartColumn,                     
         const INT8 *data,                         
         INT32 Length = 1,                   
         COMPONENT Component = COMPONENT_Default      
         ) { return (Write(Line, StartColumn, data, Length, CONVMODE_INT8, Component)); }

      ERRVALUE Write (
         INT32 Line,                         
         INT32 StartColumn,                     
         const UINT8 *data,                        
         INT32 Length = 1,                   
         COMPONENT Component = COMPONENT_Default      
         ) { return (Write(Line, StartColumn, data, Length, CONVMODE_INT8, Component)); }

      ERRVALUE Write (
         INT32 Line,                         
         INT32 StartColumn,                     
         const INT16 *data,                        
         INT32 Length = 1,                   
         COMPONENT Component = COMPONENT_Default      
         ) { return (Write(Line, StartColumn, data, Length, CONVMODE_INT16, Component)); }

      ERRVALUE Write (
         INT32 Line,                         
         INT32 StartColumn,                     
         const UINT16 *data,                       
         INT32 Length = 1,                   
         COMPONENT Component = COMPONENT_Default      
         ) { return (Write(Line, StartColumn, data, Length, CONVMODE_INT16, Component)); }

      ERRVALUE Write (
         INT32 Line,                         
         INT32 StartColumn,                     
         const INT32 *data,                        
         INT32 Length = 1,                   
         COMPONENT Component = COMPONENT_Default      
         ) { return (Write(Line, StartColumn, data, Length, CONVMODE_INT32, Component)); }

      ERRVALUE Write (
         INT32 Line,                         
         INT32 StartColumn,                     
         const UINT32 *data,                       
         INT32 Length = 1,                   
         COMPONENT Component = COMPONENT_Default      
         ) { return (Write(Line, StartColumn, data, Length, CONVMODE_INT32, Component)); }

      ERRVALUE Write (
         INT32 Line,                         
         INT32 StartColumn,                     
         const float *data,                        
         INT32 Length = 1,                   
         COMPONENT Component = COMPONENT_Default      
         ) { return (Write(Line, StartColumn, data, Length, CONVMODE_Float, Component)); }

      ERRVALUE Write (
         INT32 Line,                         
         INT32 StartColumn,                     
         const double *data,                       
         INT32 Length = 1,                   
         COMPONENT Component = COMPONENT_Default      
         ) { return (Write(Line, StartColumn, data, Length, CONVMODE_Double, Component)); }

   protected:
      void AssignValues (
         const RASTINFO& rinfo
         );

      bool IsRasterHandleValid (
         ) { return m_RasterHandle != NULL; }

      void SetRasterHandle (
         RASTERHANDLE* RastHandle
         );

      RASTERHANDLE& GetRasterHandle (
         ) { return *m_RasterHandle; }

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      virtual ERRVALUE v_CloseObject ();
      virtual RVC::OBJTYPE v_GetDftObjectType () const;
      virtual bool v_IsObjectOpen () const;
      virtual ERRVALUE v_OpenObject (OPENMODE OpenMode, MDLGPARENT parent, const CREDENTIALS* Credentials);

      virtual void v_GetExtents (DRECT3D &extents) const;
      virtual void v_GetScale (double& xscale, double& yscale) const;
      virtual double v_GetZScale () const;
      virtual double v_GetZOffset () const;
      virtual bool v_HasCapability (int Capability) const;
      virtual void v_SetScale (double xscale, double yscale);
      virtual void v_SetZOffset (double zoffset);
      virtual void v_SetZScale (double zscale);

      virtual ERRVALUE v_GetBandParms (INT32 BandNum, BANDPARMS& BandParms) const;
      virtual CELLTYPE v_GetCellType () const;
      virtual double v_GetColumnScale () const;
      virtual double v_GetLineScale () const;
      virtual ERRVALUE v_GetNullValue (INT32 BandNum, NULLVALUE& NullValue) const;
      virtual INT32 v_GetNumBands () const;
      virtual INT32 v_GetNumColumns () const { return (m_MakeParms.GetNumColumns()); }
      virtual INT32 v_GetNumLines () const { return (m_MakeParms.GetNumLines()); }
      virtual bool v_HasNullValue (INT32 BandNum) const;
      virtual ERRVALUE v_ReadBand (INT32 Band, INT32 Line, INT32 StartColumn, void *data, INT32 Length, CONVMODE Convert) const;
      virtual ERRVALUE v_ReadColumnBand (INT32 Band, INT32 Line, INT32 StartColumn, void *data, INT32 Length, CONVMODE Convert) const;
      virtual ERRVALUE v_SetCacheRect (const LRECT2D& Rect);
      virtual ERRVALUE v_SetCacheSize (INT32 NumTiles);
      virtual ERRVALUE v_SetCacheSize (CACHEMODE CacheFlags);
      virtual ERRVALUE v_SetNullValue (INT32 BandNum, const NULLVALUE* NullValue);
      virtual ERRVALUE v_WriteBand (INT32 Band, INT32 Line, INT32 StartColumn, const void *data, INT32 Length, CONVMODE Convert);

      int ComputeNumPyramidLevels (PYRAMID flags);

      PYRAMID ValidatePyramidFlags (PYRAMID flags) const;

      RASTERHANDLE* m_RasterHandle;

      MAKEPARMS m_MakeParms;        
      LINKTYPE m_LinkType;       
      INT32 m_XTiles;               
      INT32 m_YTiles;               
      INT32 m_TileSize;          

      friend class MAKEPARMS;
      #endif // GENERATING_DOXYGEN_OUTPUT
   };

class RASTER::GETOBJFILTER_ISSELECTABLE : public GETOBJFILTER {
   public:

      GETOBJFILTER_ISSELECTABLE (
         RVC::IMAGE::CELLTYPE CellTypes,
         bool DenyTypes = false,
         bool NeedSameSize = false
         );

      virtual ~GETOBJFILTER_ISSELECTABLE () {}

   protected:

      virtual bool v_IsSelectable (const RVC::OBJITEM& objitem, int position = -1);
      virtual bool v_IsValidList (const RVC::OBJITEMLIST& objlist);

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      IMAGE::CELLTYPE m_CellTypes;
      bool m_NeedSameSize;

      #endif // GENERATING_DOXYGEN_OUTPUT
   };


class RASTER::GETOBJFILTER_ISOVERLAPPING : public GETOBJFILTER {
   public:

      GETOBJFILTER_ISOVERLAPPING (
         const RVC::OBJITEM& SrcObjItem,
         RVC::IMAGE::CELLTYPE CellTypes,
         bool DenyTypes = false,
         bool NeedSameSize = false
         );

      virtual ~GETOBJFILTER_ISOVERLAPPING () {}

   protected:

      virtual bool v_IsSelectable (const RVC::OBJITEM& objitem, int position = -1);
      virtual bool v_IsValidList (const RVC::OBJITEMLIST& objlist);

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      RASTER::GETOBJFILTER_ISSELECTABLE m_IsSelectable;
      GEOSPATIAL::GETOBJFILTER_ISOVERLAPPING m_IsOverlapping;
      #endif // GENERATING_DOXYGEN_OUTPUT
   };


class RASTER::LINKPARMS {
   public:
      virtual ~LINKPARMS (
         );

   RASTER::LINKTYPE GetLinkType() const;

   protected:

      LINKPARMS (
         const FILEPATH& filename,           
         RASTER::LINKTYPE LinkType,          
         GEOSPATIAL::MAKELINKFLAGS flags
         );

      RASTLINKDATAGEN& GetGenericLinkData (
         );

      RASTINFO& GetRasterHeader (
         );

      void SetBandList (
         const INT32* BandList,
         INT32 NumBands
         );

      void SetComponent (
         INT32 component
         );

      void SetGenericLinkData (
         const RASTLINKDATAGEN& GenLinkData
         );

      void SetPyramidLink (
         );

      void SetRasterHeader (
         const RASTINFO& RastInfo
         );

      void SetSample (
         INT32 Sample
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      RASTERLINKPARMS* m_LinkParms;

      friend class RASTER;
      friend class MULTIRASTER;
      #endif // GENERATING_DOXYGEN_OUTPUT

   }; // End of LINKPARMS nested class.


class RASTER::LINKPARMS_ECW : public RASTER::LINKPARMS {
   public:

      LINKPARMS_ECW (
         const FILEPATH& filename,           
         const INT32* BandList,              
         INT32 Sample = 1,                   
         GEOSPATIAL::MAKELINKFLAGS flags = GEOSPATIAL::MAKELINKFLAG_None
         ) :
         LINKPARMS(filename, RASTER::LINKTYPE_ECW, flags)
         {
         if (BandList != 0) SetBandList(BandList, 3);
         SetSample(Sample);
         }
   };


class RASTER::LINKPARMS_GDAL : public RASTER::LINKPARMS {
   public:

      LINKPARMS_GDAL (
         const FILEPATH& filename,           
         INT32 component = 0,                
         GEOSPATIAL::MAKELINKFLAGS flags = GEOSPATIAL::MAKELINKFLAG_None
         ) :
         LINKPARMS(filename, RASTER::LINKTYPE_GDAL, flags)
         {
         SetComponent(component);
         }
   };


class RASTER::LINKPARMS_GENERIC : public RASTER::LINKPARMS {
   public:
      enum LINKORDER {
         LINKORDER_HiLo,
         LINKORDER_LoHi
         };

      enum INTERLEAVE_TYPE {
         INTTYPE_Line,     //Not INTERLEAVE_Line because rvcrast.h has it defined already
         INTTYPE_Band,
         INTTYPE_Pixel
         };

      LINKPARMS_GENERIC (
         const FILEPATH& filename,           
         RVC::IMAGE::CELLTYPE celltype,
         INT32 numlins,
         INT32 numcols,
         GEOSPATIAL::MAKELINKFLAGS flags = GEOSPATIAL::MAKELINKFLAG_None
         );

      void SetBandTrailerBytes (
         INT32 bandtbytes
         );

      void SetByteOrder (
         LINKORDER order
         );

      void SetImageScale (
         const RASTER::IMAGESCALE& scale
         );

      void SetCompressionType (
         RVC::RASTER::COMPTYPE comptype
         );

      void SetHeaderBytes (
         INT64 headerbytes
         );

      void SetInterleaveAdd (
         INT16 intadd
         );

      void SetInterleaveTrailerBytes (
         INT32 intertbytes
         );

      void SetInterleaveFactor (
         INT16 intfact
         );

      void SetInterleaveType (
         INTERLEAVE_TYPE inttype
         );

      void SetInverted (
         bool inverted
         );

      void SetLineTrailerBytes (
         INT32 linetbytes
         );

      void SetNullValue (
         const IMAGE::NULLVALUE& nullval
         );

      void SetNumBands (
         INT32 numbands
         );

      void SetTileColumns (
         INT32 tilecols
         );

      void SetTileLines (
         INT32 tilelins
         );
   };


class RASTER::LINKPARMS_JP2 : public RASTER::LINKPARMS {
   public:

      LINKPARMS_JP2 (
         const FILEPATH& filename,           
         INT32 component = 0,                
         GEOSPATIAL::MAKELINKFLAGS flags = GEOSPATIAL::MAKELINKFLAG_None
         ) :
         LINKPARMS(filename, RASTER::LINKTYPE_JP2, flags)
         {
         SetComponent(component);
         }

      void SetPyramid (
         ) { SetPyramidLink(); }
   };


class RASTER::LINKPARMS_JPEG : public RASTER::LINKPARMS {
   public:

      LINKPARMS_JPEG (
         const FILEPATH& filename,           
         GEOSPATIAL::MAKELINKFLAGS flags = GEOSPATIAL::MAKELINKFLAG_None
         ) :
         LINKPARMS(filename, RASTER::LINKTYPE_JPEG, flags)
         {}
   };


class RASTER::LINKPARMS_MRSID : public RASTER::LINKPARMS {
   public:

      LINKPARMS_MRSID (
         const FILEPATH& filename,           
         GEOSPATIAL::MAKELINKFLAGS flags = GEOSPATIAL::MAKELINKFLAG_None
         ) :
         LINKPARMS(filename, RASTER::LINKTYPE_MrSID, flags)
         {}
   };


class RASTER::LINKPARMS_PNG : public RASTER::LINKPARMS {
   public:

      LINKPARMS_PNG (
         const FILEPATH& filename,           
         GEOSPATIAL::MAKELINKFLAGS flags = GEOSPATIAL::MAKELINKFLAG_None
         ) :
         LINKPARMS(filename, RASTER::LINKTYPE_PNG, flags)
         {}
   };


class RASTER::LINKPARMS_SOCETSETDT : public RASTER::LINKPARMS {
   public:

      LINKPARMS_SOCETSETDT (
         const FILEPATH& filename,           
         GEOSPATIAL::MAKELINKFLAGS flags = GEOSPATIAL::MAKELINKFLAG_None
         ) :
         LINKPARMS(filename, RASTER::LINKTYPE_SocetSetDT, flags)
         {}
   };


class RASTER::LINKPARMS_TIFF : public RASTER::LINKPARMS {
   public:

      LINKPARMS_TIFF (
         const FILEPATH& filename,           
         INT32 ImageIndex,                   
         INT32 component = 0,                
         GEOSPATIAL::MAKELINKFLAGS flags = GEOSPATIAL::MAKELINKFLAG_None
         ) :
         LINKPARMS(filename, RASTER::LINKTYPE_TIFF, flags)
         {
         SetComponent(component);
         SetSample(ImageIndex);
         }
   };

}     

#endif      

---