Main Page | Modules | Directories | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages | Search for 

RVC::IMAGE Class Reference

Interface for RVC objects that support an multiple image band paradigm. More...

#include <rvc/image.h>

Inheritance diagram for RVC::IMAGE:

Inheritance graph
[legend]
List of all members.

Public Types

enum  CACHEMODE { CACHEMODE_Default = 0, CACHEMODE_DiagonalRow, CACHEMODE_TileRow }
enum  CAPABILITY { CAPABILITY_None = 0, CAPABILITY_SequentialReadOptimal = 1024 }
enum  CELLTYPE {
  CELLTYPE_Invalid = 0x00000000, CELLTYPE_Binary = 0x00000001, CELLTYPE_Unsigned_4 = 0x00000002, CELLTYPE_Unsigned_8 = 0x00000004,
  CELLTYPE_Unsigned_32 = 0x00000008, CELLTYPE_Unsigned_16 = 0x00000010, CELLTYPE_Unsigned_64 = 0x00000020, CELLTYPE_Signed_8 = 0x00000040,
  CELLTYPE_Signed_16 = 0x00000080, CELLTYPE_Signed_32 = 0x00000100, CELLTYPE_Signed_64 = 0x00000200, CELLTYPE_Float_32 = 0x00000400,
  CELLTYPE_Float_64 = 0x00000800, CELLTYPE_ComplexRI_64 = 0x00001000, CELLTYPE_ComplexMP_64 = 0x00002000, CELLTYPE_ComplexRI_128 = 0x00004000,
  CELLTYPE_ComplexMP_128 = 0x00008000, CELLTYPE_X1R5G5B5_16 = 0x00010000, CELLTYPE_X1B5G5R5_16 = 0x00020000, CELLTYPE_RedGreenBlue_24 = 0x00040000,
  CELLTYPE_BlueGreenRed_24 = 0x00080000, CELLTYPE_RedGreenBlueAlpha_32 = 0x00100000, CELLTYPE_AlphaRedGreenBlue_32 = 0x00200000, CELLTYPE_CyanMagentaYellowBlack_32 = 0x00400000,
  CELLTYPE_BlackCyanMagentaYellow_32 = 0x00800000, CELLTYPE_None = 0x00000000, CELLTYPE_Unsigned_Max8 = (CELLTYPE_Binary + CELLTYPE_Unsigned_4 + CELLTYPE_Unsigned_8), CELLTYPE_Unsigned_Max16 = (CELLTYPE_Unsigned_Max8 + CELLTYPE_Unsigned_16),
  CELLTYPE_Unsigned_Max32 = (CELLTYPE_Unsigned_Max16 + CELLTYPE_Unsigned_32), CELLTYPE_Unsigned_Max64 = (CELLTYPE_Unsigned_Max32 + CELLTYPE_Unsigned_64), CELLTYPE_Signed_Max32 = (CELLTYPE_Signed_8 + CELLTYPE_Signed_16 + CELLTYPE_Signed_32), CELLTYPE_Signed_Max64 = (CELLTYPE_Signed_Max32 + CELLTYPE_Signed_64),
  CELLTYPE_Integer_Max32 = (CELLTYPE_Unsigned_Max32 + CELLTYPE_Signed_Max32), CELLTYPE_Integer_Max64 = (CELLTYPE_Unsigned_Max64 + CELLTYPE_Signed_Max64), CELLTYPE_Float = (CELLTYPE_Float_32 + CELLTYPE_Float_64), CELLTYPE_Scalar = (CELLTYPE_Integer_Max64 + CELLTYPE_Float),
  CELLTYPE_Complex = (CELLTYPE_ComplexRI_64 + CELLTYPE_ComplexMP_64 + CELLTYPE_ComplexRI_128 + CELLTYPE_ComplexMP_128), CELLTYPE_3Cell_Color = (CELLTYPE_X1R5G5B5_16 + CELLTYPE_X1B5G5R5_16 + CELLTYPE_RedGreenBlue_24 + CELLTYPE_BlueGreenRed_24), CELLTYPE_4Cell_Color = (CELLTYPE_RedGreenBlueAlpha_32 + CELLTYPE_AlphaRedGreenBlue_32 + CELLTYPE_CyanMagentaYellowBlack_32 + CELLTYPE_BlackCyanMagentaYellow_32), CELLTYPE_Color = (CELLTYPE_3Cell_Color + CELLTYPE_4Cell_Color),
  CELLTYPE_ColorMapValid = (CELLTYPE_Unsigned_4 + CELLTYPE_Unsigned_8 + CELLTYPE_Unsigned_16), CELLTYPE_HasAlphaBand = (CELLTYPE_RedGreenBlueAlpha_32 + CELLTYPE_AlphaRedGreenBlue_32), CELLTYPE_DatabaseValid = (CELLTYPE_Integer_Max32), CELLTYPE_HistogramValid = (CELLTYPE_Scalar + CELLTYPE_Complex),
  CELLTYPE_All = (CELLTYPE_Scalar + CELLTYPE_Complex + CELLTYPE_Color)
}
enum  CONVMODE {
  CONVMODE_None = 0, CONVMODE_ByteSpread, CONVMODE_INT8, CONVMODE_INT16,
  CONVMODE_INT32, CONVMODE_Float, CONVMODE_Double, CONVMODE_RGB,
  CONVMODE_BGR, CONVMODE_RGBSpread, CONVMODE_BGRSpread, CONVMODE_ComplexRIFloat,
  CONVMODE_ComplexMPFloat, CONVMODE_ComplexRIDouble, CONVMODE_ComplexMPDouble
}
enum  DATATYPE {
  DATATYPE_Invalid = 0, DATATYPE_Unsigned, DATATYPE_Signed, DATATYPE_Float,
  DATATYPE_BGR, DATATYPE_RGB, DATATYPE_BGR16, DATATYPE_RGB16,
  DATATYPE_ComplexRI, DATATYPE_ComplexMP, DATATYPE_RGBA, DATATYPE_ARGB,
  DATATYPE_CMYK, DATATYPE_KCMY
}
enum  PACKORDER { PACKORDER_LeastSigBit = 0, PACKORDER_MostSigBit }
enum  PYRAMID {
  PYRAMID_Default = 0x00, PYRAMID_None = PYRAMID_Default, PYRAMID_Rebuild = 0x01, PYRAMID_Average = 0x02,
  PYRAMID_Full = 0x04, PYRAMID_UseParentTileSize = 0x08, PYRAMID_UseColorMap = 0x10, PYRAMID_Partial = 0x20
}

Public Member Functions

ERRVALUE GetBandParms (INT32 BandNum, BANDPARMS &BandParms) const
double GetColumnScale () const
double GetLineScale () const
ERRVALUE GetNullValue (INT32 BandNum, NULLVALUE &NullValue) const
INT32 GetNumBands () const
INT32 GetNumColumns () const
INT32 GetNumLines () const
bool HasNullValue (INT32 BandNum) const
 IMAGE (const IMAGE &rhs)
 IMAGE ()
ERRVALUE ReadBand (INT32 Band, INT32 Line, INT32 StartColumn, double *data, INT32 Length=1) const
ERRVALUE ReadBand (INT32 Band, INT32 Line, INT32 StartColumn, float *data, INT32 Length=1) const
ERRVALUE ReadBand (INT32 Band, INT32 Line, INT32 StartColumn, UINT32 *data, INT32 Length=1) const
ERRVALUE ReadBand (INT32 Band, INT32 Line, INT32 StartColumn, INT32 *data, INT32 Length=1) const
ERRVALUE ReadBand (INT32 Band, INT32 Line, INT32 StartColumn, UINT16 *data, INT32 Length=1) const
ERRVALUE ReadBand (INT32 Band, INT32 Line, INT32 StartColumn, INT16 *data, INT32 Length=1) const
ERRVALUE ReadBand (INT32 Band, INT32 Line, INT32 StartColumn, UINT8 *data, INT32 Length=1) const
ERRVALUE ReadBand (INT32 Band, INT32 Line, INT32 StartColumn, INT8 *data, INT32 Length=1) const
ERRVALUE ReadBand (INT32 Band, INT32 Line, INT32 StartColumn, void *data, INT32 Length=1, CONVMODE Convert=CONVMODE_None) const
ERRVALUE ReadColumnBand (INT32 Band, INT32 Line, INT32 StartColumn, double *data, INT32 Length=1) const
ERRVALUE ReadColumnBand (INT32 Band, INT32 Line, INT32 StartColumn, float *data, INT32 Length=1) const
ERRVALUE ReadColumnBand (INT32 Band, INT32 Line, INT32 StartColumn, UINT32 *data, INT32 Length=1) const
ERRVALUE ReadColumnBand (INT32 Band, INT32 Line, INT32 StartColumn, INT32 *data, INT32 Length=1) const
ERRVALUE ReadColumnBand (INT32 Band, INT32 Line, INT32 StartColumn, UINT16 *data, INT32 Length=1) const
ERRVALUE ReadColumnBand (INT32 Band, INT32 Line, INT32 StartColumn, INT16 *data, INT32 Length=1) const
ERRVALUE ReadColumnBand (INT32 Band, INT32 Line, INT32 StartColumn, UINT8 *data, INT32 Length=1) const
ERRVALUE ReadColumnBand (INT32 Band, INT32 Line, INT32 StartColumn, INT8 *data, INT32 Length=1) const
ERRVALUE ReadColumnBand (INT32 Band, INT32 Line, INT32 StartColumn, void *data, INT32 Length=1, CONVMODE Convert=CONVMODE_None) const
ERRVALUE SetCacheSize (CACHEMODE CacheFlags)
ERRVALUE SetCacheSize (INT32 NumTiles)
ERRVALUE SetNullValue (INT32 BandNum, const NULLVALUE *NullValue)
ERRVALUE WriteBand (INT32 Band, INT32 Line, INT32 StartColumn, double *data, INT32 Length=1)
ERRVALUE WriteBand (INT32 Band, INT32 Line, INT32 StartColumn, float *data, INT32 Length=1)
ERRVALUE WriteBand (INT32 Band, INT32 Line, INT32 StartColumn, UINT32 *data, INT32 Length=1)
ERRVALUE WriteBand (INT32 Band, INT32 Line, INT32 StartColumn, INT32 *data, INT32 Length=1)
ERRVALUE WriteBand (INT32 Band, INT32 Line, INT32 StartColumn, UINT16 *data, INT32 Length=1)
ERRVALUE WriteBand (INT32 Band, INT32 Line, INT32 StartColumn, INT16 *data, INT32 Length=1)
ERRVALUE WriteBand (INT32 Band, INT32 Line, INT32 StartColumn, UINT8 *data, INT32 Length=1)
ERRVALUE WriteBand (INT32 Band, INT32 Line, INT32 StartColumn, INT8 *data, INT32 Length=1)
ERRVALUE WriteBand (INT32 Band, INT32 Line, INT32 StartColumn, void *data, INT32 Length=1, CONVMODE Convert=CONVMODE_None)
virtual ~IMAGE ()=0

Static Public Member Functions

CELLTYPE ComputeCellType (DATATYPE datatype, UINT16 numbits)
CELLTYPE ComputeCellTypeFromLegacy (UINT32 datatype, UINT16 numbits)
UINT16 ConvToRVCTYPE (DATATYPE type, UINT16 NumBits)
CELLTYPE GetCellTypeFromColorSpace (COLORSPACE ColorSpace)
CELLTYPE GetCellTypeFromDataTypeAndNumBits (UINT32 datatype, UINT16 numbits)
void GetCellTypeRange (CELLTYPE CellType, DOUBLE_RANGE &Range)
MISTRING GetCellTypeString (CELLTYPE CellType)
COLORSPACE GetColorSpaceFromCellType (CELLTYPE CellType, bool haspalette=false)
INT32 GetCompositeBandNum ()
DATATYPE GetDataTypeFromCellType (CELLTYPE CellType)
RVC::IMAGE * GetImage (const RVC::OBJITEM &ObjItem)
RVC::IMAGE * GetImage (const RVC::OBJECT &object)
UINT16 GetNumBitsFromCellType (CELLTYPE CellType)
RVC::OBJTYPESET GetObjTypeSet ()
bool IsImage (RVC::OBJTYPE ObjType)

Static Protected Member Functions

DATATYPE ConvToDATATYPE (int RvcType, UINT16 NumBits)
UINT32 ConvToRastMode (CONVMODE value)

Detailed Description

Interface for RVC objects that support an multiple image band paradigm.

This includes methods to read and write to each individual image band

RVC Object Types that this class supports: Derived class

Default RVC Object Type for this class: Derived class

Valid parents for this class: Derived class

Definition at line 179 of file image.h.

Member Enumeration Documentation

enum RVC::IMAGE::CACHEMODE
 

Enumeration values:
CACHEMODE_Default  Default cache size is 4 tiles unless compressed.
CACHEMODE_DiagonalRow  Sets raster cache to allocate a hypotenuse amount of tiles.
CACHEMODE_TileRow  Default cache size if raster is compressed, caches a row of tiles.

Definition at line 182 of file image.h.

enum RVC::IMAGE::CAPABILITY
 

Enumeration values:
CAPABILITY_None 
CAPABILITY_SequentialReadOptimal  Image is best accessed one scanline at a time in top to bottom order.

Reimplemented from RVC::GEOSPATIAL.

Definition at line 188 of file image.h.

enum RVC::IMAGE::CELLTYPE
 

Image cell type enumerating valid data type and bit depth combinations.

Enumeration values:
CELLTYPE_Invalid 
CELLTYPE_Binary 
CELLTYPE_Unsigned_4 
CELLTYPE_Unsigned_8 
CELLTYPE_Unsigned_32 
CELLTYPE_Unsigned_16 
CELLTYPE_Unsigned_64 
CELLTYPE_Signed_8 
CELLTYPE_Signed_16 
CELLTYPE_Signed_32 
CELLTYPE_Signed_64 
CELLTYPE_Float_32 
CELLTYPE_Float_64 
CELLTYPE_ComplexRI_64 
CELLTYPE_ComplexMP_64 
CELLTYPE_ComplexRI_128 
CELLTYPE_ComplexMP_128 
CELLTYPE_X1R5G5B5_16  Packed into UINT16 with Red in high bits.
CELLTYPE_X1B5G5R5_16  Packed into UINT16 with Blue in high bits.
CELLTYPE_RedGreenBlue_24  3 bytes, red first
CELLTYPE_BlueGreenRed_24  3 bytes, blue first
CELLTYPE_RedGreenBlueAlpha_32  4 bytes, red first
CELLTYPE_AlphaRedGreenBlue_32  4 bytes, alpha first
CELLTYPE_CyanMagentaYellowBlack_32  4 bytes, cyan first
CELLTYPE_BlackCyanMagentaYellow_32  4 bytes, black first
CELLTYPE_None 
CELLTYPE_Unsigned_Max8 
CELLTYPE_Unsigned_Max16 
CELLTYPE_Unsigned_Max32 
CELLTYPE_Unsigned_Max64 
CELLTYPE_Signed_Max32 
CELLTYPE_Signed_Max64 
CELLTYPE_Integer_Max32 
CELLTYPE_Integer_Max64 
CELLTYPE_Float 
CELLTYPE_Scalar 
CELLTYPE_Complex 
CELLTYPE_3Cell_Color 
CELLTYPE_4Cell_Color 
CELLTYPE_Color 
CELLTYPE_ColorMapValid 
CELLTYPE_HasAlphaBand 
CELLTYPE_DatabaseValid 
CELLTYPE_HistogramValid 
CELLTYPE_All 

Definition at line 231 of file image.h.

enum RVC::IMAGE::CONVMODE
 

Possible type conversion modes for Read(), ReadColumn() and Write().

Enumeration values:
CONVMODE_None  No conversion.
CONVMODE_ByteSpread  Convert < 8-bit to 8-bit by spreading over 0-255 range.
CONVMODE_INT8  Convert 1/2/4 bits to 8-bit by copy.
CONVMODE_INT16  Convert < INT16 to INT16 bits/cell.
CONVMODE_INT32  Convert < INT32 to INT32 bits/cell.
CONVMODE_Float  Convert to float.
CONVMODE_Double  Convert to double.
CONVMODE_RGB  Convert to RGB, only for Read() method.
CONVMODE_BGR  Convert to BGR, only for Read() method.
CONVMODE_RGBSpread  Convert to RGB and spread 16 to 24 bit, only for Read() method.
CONVMODE_BGRSpread  Convert to BGR and spread 16 to 24 bit, only for Read() method.
CONVMODE_ComplexRIFloat  Convert to Complex Real/Imaginary.
CONVMODE_ComplexMPFloat  Convert to Complex Magnitude/Phase.
CONVMODE_ComplexRIDouble  Convert to Complex Real/Imaginary.
CONVMODE_ComplexMPDouble  Convert to Complex Magnitude/Phase.

Definition at line 194 of file image.h.

enum RVC::IMAGE::DATATYPE
 

Valid image datatypes.

Enumeration values:
DATATYPE_Invalid  Not a valid raster datatype.
DATATYPE_Unsigned  UINT8, UINT16, UINT32 and < 8 bit.
DATATYPE_Signed  INT8, INT16, INT32.
DATATYPE_Float  FLOAT, DOUBLE.
DATATYPE_BGR  RED, GREEN, BLUE packed (blue first byte).
DATATYPE_RGB  RED, GREEN, BLUE packed (red first byte).
DATATYPE_BGR16  RED, GREEN, BLUE packed (blue high bits).
DATATYPE_RGB16  RED, GREEN, BLUE packed (red high bits).
DATATYPE_ComplexRI  Real, Imaginary.
DATATYPE_ComplexMP  Magnitude, Phase.
DATATYPE_RGBA  RED, GREEN, BLUE packed (red first byte).
DATATYPE_ARGB  RED, GREEN, BLUE packed (red first byte).
DATATYPE_CMYK  RED, GREEN, BLUE packed (red first byte).
DATATYPE_KCMY  RED, GREEN, BLUE packed (red first byte).

Definition at line 213 of file image.h.

enum RVC::IMAGE::PACKORDER
 

Enumeration values:
PACKORDER_LeastSigBit 
PACKORDER_MostSigBit 

Definition at line 282 of file image.h.

enum RVC::IMAGE::PYRAMID
 

Enumeration values:
PYRAMID_Default 
PYRAMID_None 
PYRAMID_Rebuild  Rebuild tiers even if exist.
PYRAMID_Average  Average raster cells instead of sampling.
PYRAMID_Full  Create 'full' pyramid set (always 2x2 sample steps).
PYRAMID_UseParentTileSize  Use parent raster's tile size.
PYRAMID_UseColorMap  Use colormap for averaging.
PYRAMID_Partial  Create 'partial' pyramid set (some 4x4 sample steps).

Definition at line 287 of file image.h.

Constructor & Destructor Documentation

RVC::IMAGE::IMAGE (   ) 
 

Default constructor.

RVC::IMAGE::IMAGE (  const IMAGE &  rhs  ) 
 

Copy constructor.

virtual RVC::IMAGE::~IMAGE (   )  [pure virtual]
 

Destructor.

Member Function Documentation

CELLTYPE RVC::IMAGE::ComputeCellType (  DATATYPE  datatype,
UINT16  numbits
)  [static]
 

Get CELLTYPE corresponding to datatype and numbits.

Returns:
CELLTYPE value or CELLTYPE_Invalid if no conversion possible.

CELLTYPE RVC::IMAGE::ComputeCellTypeFromLegacy (  UINT32  datatype,
UINT16  numbits
)  [static]
 

Get CELLTYPE corresponding to legacy datatype and numbits.

Returns:
CELLTYPE value or CELLTYPE_Invalid if no conversion possible.

DATATYPE RVC::IMAGE::ConvToDATATYPE (  int  RvcType,
UINT16  NumBits
)  [static, protected]
 

UINT32 RVC::IMAGE::ConvToRastMode (  CONVMODE  value  )  [static, protected]
 

UINT16 RVC::IMAGE::ConvToRVCTYPE (  DATATYPE  type,
UINT16  NumBits
)  [static]
 

Temporary static method to convert IMAGE::DATATYPE's to legacy RVCTYPE flags.

Returns:
: RVCTYPE_ flag

ERRVALUE RVC::IMAGE::GetBandParms (  INT32  BandNum,
BANDPARMS &  BandParms
)  const [inline]
 

Obtain individual image band parameters.

Definition at line 333 of file image.h.

CELLTYPE RVC::IMAGE::GetCellTypeFromColorSpace (  COLORSPACE  ColorSpace  )  [static]
 

Get CELLTYPE corresponding to COLORSPACE.

Returns:
CELLTYPE value or CELLTYPE_Invalid if no conversion possible.

CELLTYPE RVC::IMAGE::GetCellTypeFromDataTypeAndNumBits (  UINT32  datatype,
UINT16  numbits
)  [static]
 

Get CELLTYPE corresponding to legacy datatype and numbits.

Returns:
CELLTYPE value or CELLTYPE_Invalid if no conversion possible.

void RVC::IMAGE::GetCellTypeRange (  CELLTYPE  CellType,
DOUBLE_RANGE &  Range
)  [static]
 

Get Image value range according to the CELLTYPE.

MISTRING RVC::IMAGE::GetCellTypeString (  CELLTYPE  CellType  )  [static]
 

Get the string for the IMAGE::CELLTYPE specified.

The string is determined from the 'CellType' and the resource file

COLORSPACE RVC::IMAGE::GetColorSpaceFromCellType (  CELLTYPE  CellType,
bool  haspalette = false
)  [static]
 

Get COLORSPACE corresponding to specified cell type.

Returns:
COLORSPACE value or COLORSPACE_Unknown if no conversion possible.

double RVC::IMAGE::GetColumnScale (   )  const [inline]
 

Obtain the raster cell column scale value.

Returns:
raster cell column scale

Definition at line 372 of file image.h.

INT32 RVC::IMAGE::GetCompositeBandNum (   )  [inline, static]
 

Get the band number to use for composite image reading and writing in one image buffer Only useful for images of CELLTYPE_Complex and CELLTYPE_Color.

Returns:
Band number to read(), write() for CELLTYPE_Complex and CELLTYPE_Color images in one image buffer

Definition at line 378 of file image.h.

DATATYPE RVC::IMAGE::GetDataTypeFromCellType (  CELLTYPE  CellType  )  [static]
 

Get DATATYPE associated with specified CELLTYPE.

RVC::IMAGE* RVC::IMAGE::GetImage (  const RVC::OBJITEM &  ObjItem  )  [static]
 

Get image object referred to by 'ObjItem'.

Returns:
Allocated instance of RVC::IMAGE object (must be 'delete'd) or 0 if error

RVC::IMAGE* RVC::IMAGE::GetImage (  const RVC::OBJECT &  object  )  [static]
 

Get image object referred to by 'object'.

Returns:
Allocated instance of RVC::IMAGE object (must be 'delete'd) or 0 if error

double RVC::IMAGE::GetLineScale (   )  const [inline]
 

Obtain the raster cell line scale value.

Returns:
raster cell line scale

Definition at line 400 of file image.h.

ERRVALUE RVC::IMAGE::GetNullValue (  INT32  BandNum,
NULLVALUE &  NullValue
)  const [inline]
 

Obtain raster band null value information.

Parameters:
BandNum  Raster band number to get NULLVALUE from
NullValue  Current NULLVALUE to get from raster

Definition at line 404 of file image.h.

INT32 RVC::IMAGE::GetNumBands (   )  const [inline]
 

Determine the number of bands present in the raster.

Returns:
number of bands

Definition at line 411 of file image.h.

UINT16 RVC::IMAGE::GetNumBitsFromCellType (  CELLTYPE  CellType  )  [static]
 

Get number of bits per cell for specified CELLTYPE.

INT32 RVC::IMAGE::GetNumColumns (   )  const [inline]
 

Obtain number of columns in the raster.

Returns:
number of columns in the raster

Definition at line 421 of file image.h.

INT32 RVC::IMAGE::GetNumLines (   )  const [inline]
 

Obtain number of lines in the raster.

Returns:
number of lines in the raster

Definition at line 426 of file image.h.

RVC::OBJTYPESET RVC::IMAGE::GetObjTypeSet (   )  [static]
 

Get correct OBJTYPESET for all image OBJTYPE's.

Returns:
OBJTYPESET for all image OBJTYPE's

Reimplemented from RVC::GEOSPATIAL.

bool RVC::IMAGE::HasNullValue (  INT32  BandNum  )  const [inline]
 

Determine if null value exists for specified band.

Returns:
'true' if null value used, 'false' if not.

Definition at line 436 of file image.h.

bool RVC::IMAGE::IsImage (  RVC::OBJTYPE  ObjType  )  [static]
 

Determine if the object type is an image object.

ERRVALUE RVC::IMAGE::ReadBand (  INT32  Band,
INT32  Line,
INT32  StartColumn,
double *  data,
INT32  Length = 1
)  const [inline]
 

Read a line of raster cells up to a certain length, converting to 64 bit double.

Parameters:
Band  Read a raster line, 8 byte doubles Image band number to read
Line  Raster line to read
StartColumn  Raster column to start reading on
data  Buffer to read into
Length  Number of columns to read

Definition at line 519 of file image.h.

ERRVALUE RVC::IMAGE::ReadBand (  INT32  Band,
INT32  Line,
INT32  StartColumn,
float *  data,
INT32  Length = 1
)  const [inline]
 

Read a line of raster cells up to a certain length, converting to 32 bit float.

Parameters:
Band  Read a raster line, 4 byte floats Image band number to read
Line  Raster line to read
StartColumn  Raster column to start reading on
data  Buffer to read into
Length  Number of columns to read

Definition at line 510 of file image.h.

ERRVALUE RVC::IMAGE::ReadBand (  INT32  Band,
INT32  Line,
INT32  StartColumn,
UINT32 *  data,
INT32  Length = 1
)  const [inline]
 

Read a line of raster cells up to a certain length, converting to unsigned 32 bit.

Parameters:
Band  Read a raster line, unsigned 32 bit Image band number to read
Line  Raster line to read
StartColumn  Raster column to start reading on
data  Buffer to read into
Length  Number of columns to read

Definition at line 501 of file image.h.

ERRVALUE RVC::IMAGE::ReadBand (  INT32  Band,
INT32  Line,
INT32  StartColumn,
INT32 *  data,
INT32  Length = 1
)  const [inline]
 

Read a line of raster cells up to a certain length, converting to signed 32 bit.

Parameters:
Band  Read a raster line, signed 32 bit Image band number to read
Line  Raster line to read
StartColumn  Raster column to start reading on
data  Buffer to read into
Length  Number of columns to read

Definition at line 492 of file image.h.

ERRVALUE RVC::IMAGE::ReadBand (  INT32  Band,
INT32  Line,
INT32  StartColumn,
UINT16 *  data,
INT32  Length = 1
)  const [inline]
 

Read a line of raster cells up to a certain length, converting to unsigned 16 bit.

Parameters:
Band  Read a raster line, unsigned 16 bit Image band number to read
Line  Raster line to read
StartColumn  Raster column to start reading on
data  Buffer to read into
Length  Number of columns to read

Definition at line 483 of file image.h.

ERRVALUE RVC::IMAGE::ReadBand (  INT32  Band,
INT32  Line,
INT32  StartColumn,
INT16 *  data,
INT32  Length = 1
)  const [inline]
 

Read a line of raster cells up to a certain length, converting to signed 16 bit.

Parameters:
Band  Read a raster line, signed 16 bit Image band number to read
Line  Raster line to read
StartColumn  Raster column to start reading on
data  Buffer to read into
Length  Number of columns to read

Definition at line 474 of file image.h.

ERRVALUE RVC::IMAGE::ReadBand (  INT32  Band,
INT32  Line,
INT32  StartColumn,
UINT8 *  data,
INT32  Length = 1
)  const [inline]
 

Read a line of raster cells up to a certain length, converting to unsigned 8 bit.

Parameters:
Band  Read a raster line, unsigned 8 bit Image band number to read
Line  Raster line to read
StartColumn  Raster column to start reading on
data  Buffer to read into
Length  Number of columns to read

Definition at line 465 of file image.h.

ERRVALUE RVC::IMAGE::ReadBand (  INT32  Band,
INT32  Line,
INT32  StartColumn,
INT8 *  data,
INT32  Length = 1
)  const [inline]
 

Read a line of raster cells up to a certain length, converting to signed 8 bit.

Parameters:
Band  Read a raster line, signed 8 bit Image band number to read
Line  Raster line to read
StartColumn  Raster column to start reading on
data  Buffer to read into
Length  Number of columns to read

Definition at line 456 of file image.h.

ERRVALUE RVC::IMAGE::ReadBand (  INT32  Band,
INT32  Line,
INT32  StartColumn,
void *  data,
INT32  Length = 1,
CONVMODE  Convert = CONVMODE_None
)  const [inline]
 

Read a line of raster cells up to a certain length.

Parameters:
Line  Raster line to read
StartColumn  Raster column to start reading on
data  Buffer to read into
Length  Number of columns to read
Convert  Data conversion mode

Definition at line 446 of file image.h.

ERRVALUE RVC::IMAGE::ReadColumnBand (  INT32  Band,
INT32  Line,
INT32  StartColumn,
double *  data,
INT32  Length = 1
)  const [inline]
 

Read a column of raster cells up to a certain length, converting to 64 bit double.

Parameters:
Band  Read a raster column, 8 byte doubles Image band number to read
Line  Raster line to start reading on
StartColumn  Raster column to read
data  Buffer to read into
Length  Number of lines to read

Definition at line 601 of file image.h.

ERRVALUE RVC::IMAGE::ReadColumnBand (  INT32  Band,
INT32  Line,
INT32  StartColumn,
float *  data,
INT32  Length = 1
)  const [inline]
 

Read a column of raster cells up to a certain length, converting to 32 bit float.

Parameters:
Band  Read a raster column, 4 byte floats Image band number to read
Line  Raster line to start reading on
StartColumn  Raster column to read
data  Buffer to read into
Length  Number of lines to read

Definition at line 592 of file image.h.

ERRVALUE RVC::IMAGE::ReadColumnBand (  INT32  Band,
INT32  Line,
INT32  StartColumn,
UINT32 *  data,
INT32  Length = 1
)  const [inline]
 

Read a column of raster cells up to a certain length, converting to unsigned 32 bit.

Parameters:
Band  Read a raster column, unsigned 32 bit Image band number to read
Line  Raster line to start reading on
StartColumn  Raster column to read
data  Buffer to read into
Length  Number of lines to read

Definition at line 583 of file image.h.

ERRVALUE RVC::IMAGE::ReadColumnBand (  INT32  Band,
INT32  Line,
INT32  StartColumn,
INT32 *  data,
INT32  Length = 1
)  const [inline]
 

Read a column of raster cells up to a certain length, converting to signed 32 bit.

Parameters:
Band  Read a raster column, signed 32 bit Image band number to read
Line  Raster line to start reading on
StartColumn  Raster column to read
data  Buffer to read into
Length  Number of lines to read

Definition at line 574 of file image.h.

ERRVALUE RVC::IMAGE::ReadColumnBand (  INT32  Band,
INT32  Line,
INT32  StartColumn,
UINT16 *  data,
INT32  Length = 1
)  const [inline]
 

Read a column of raster cells up to a certain length, converting to unsigned 16 bit.

Parameters:
Band  Read a raster column, unsigned 16 bit Image band number to read
Line  Raster line to start reading on
StartColumn  Raster column to read
data  Buffer to read into
Length  Number of lines to read

Definition at line 565 of file image.h.

ERRVALUE RVC::IMAGE::ReadColumnBand (  INT32  Band,
INT32&nbs