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.

Classes

class  BANDPARMS
 Class to represent and manage band specific information. More...
class  NULLVALUE
 Container for image null value. More...
class  OBSERVER
 OBSERVER class for RVC::IMAGE objects. More...

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_Unsigned = (CELLTYPE_Unsigned_Max64), CELLTYPE_Signed_Max16 = (CELLTYPE_Signed_8 | CELLTYPE_Signed_16),
  CELLTYPE_Signed_Max32 = (CELLTYPE_Signed_Max16 | CELLTYPE_Signed_32), CELLTYPE_Signed_Max64 = (CELLTYPE_Signed_Max32 | CELLTYPE_Signed_64), CELLTYPE_Signed = (CELLTYPE_Signed_Max64), CELLTYPE_Integer_Max8 = (CELLTYPE_Unsigned_Max8 | CELLTYPE_Signed_8),
  CELLTYPE_Integer_Max16 = (CELLTYPE_Unsigned_Max16 | CELLTYPE_Signed_Max32), CELLTYPE_Integer_Max32 = (CELLTYPE_Unsigned_Max32 | CELLTYPE_Signed_Max32), CELLTYPE_Integer_Max64 = (CELLTYPE_Unsigned_Max64 | CELLTYPE_Signed_Max64), CELLTYPE_Integer = (CELLTYPE_Unsigned | CELLTYPE_Signed),
  CELLTYPE_Float = (CELLTYPE_Float_32 | CELLTYPE_Float_64), CELLTYPE_Scalar = (CELLTYPE_Integer | CELLTYPE_Float), CELLTYPE_ComplexRI = (CELLTYPE_ComplexRI_64 | CELLTYPE_ComplexRI_128), CELLTYPE_ComplexMP = (CELLTYPE_ComplexMP_64 | CELLTYPE_ComplexMP_128),
  CELLTYPE_Complex = (CELLTYPE_ComplexRI | CELLTYPE_ComplexMP), CELLTYPE_ColorRGB = (CELLTYPE_X1R5G5B5_16 | CELLTYPE_X1B5G5R5_16 | CELLTYPE_RedGreenBlue_24 | CELLTYPE_BlueGreenRed_24), CELLTYPE_ColorRGBA = (CELLTYPE_RedGreenBlueAlpha_32 | CELLTYPE_AlphaRedGreenBlue_32), CELLTYPE_ColorCMYK = (CELLTYPE_CyanMagentaYellowBlack_32 | CELLTYPE_BlackCyanMagentaYellow_32),
  CELLTYPE_ColorNoAlpha = (CELLTYPE_ColorRGB | CELLTYPE_ColorCMYK), CELLTYPE_ColorHasAlpha = (CELLTYPE_ColorRGBA), CELLTYPE_Color = (CELLTYPE_ColorNoAlpha | CELLTYPE_ColorHasAlpha), CELLTYPE_ColorMapValid = (CELLTYPE_Unsigned_4 | CELLTYPE_Unsigned_8 | CELLTYPE_Unsigned_16),
  CELLTYPE_3Cell_Color = (CELLTYPE_ColorRGB), CELLTYPE_4Cell_Color = (CELLTYPE_ColorRGBA | CELLTYPE_ColorCMYK), CELLTYPE_HasAlphaBand = (CELLTYPE_ColorHasAlpha), 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 = 0x000, PYRAMID_Rebuild = 0x001, PYRAMID_Average = 0x002, PYRAMID_UseParentTileSize = 0x008,
  PYRAMID_UseColorMap = 0x010, PYRAMID_Disable = 0x080, PYRAMID_CompressLossy = 0x100, PYRAMID_CompressLossless = 0x200,
  PYRAMID_LargerMinTierSize = 0x400, PYRAMID_NoHistogram = 0x800
}

Public Member Functions

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

Static Public Member Functions

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

Static Protected Member Functions

static DATATYPE ConvToDATATYPE (int RvcType, UINT16 NumBits)
static 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

Member Enumeration Documentation

enum RVC::IMAGE::CACHEMODE
Enumerator:
CACHEMODE_Default 

Image cache values for SetCacheMode().

Default cache size is 4 tiles unless compressed

CACHEMODE_DiagonalRow 

Sets image cache to allocate a hypotenuse amount of tiles.

CACHEMODE_TileRow 

Default cache size if image is compressed, caches a row of tiles.

enum RVC::IMAGE::CAPABILITY
Enumerator:
CAPABILITY_None 
CAPABILITY_SequentialReadOptimal 

Image is best accessed one scanline at a time in top to bottom order.

Reimplemented from RVC::GEOSPATIAL.

enum RVC::IMAGE::CELLTYPE

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

Enumerator:
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_Unsigned 
CELLTYPE_Signed_Max16 
CELLTYPE_Signed_Max32 
CELLTYPE_Signed_Max64 
CELLTYPE_Signed 
CELLTYPE_Integer_Max8 
CELLTYPE_Integer_Max16 
CELLTYPE_Integer_Max32 
CELLTYPE_Integer_Max64 
CELLTYPE_Integer 
CELLTYPE_Float 
CELLTYPE_Scalar 
CELLTYPE_ComplexRI 
CELLTYPE_ComplexMP 
CELLTYPE_Complex 
CELLTYPE_ColorRGB 
CELLTYPE_ColorRGBA 
CELLTYPE_ColorCMYK 
CELLTYPE_ColorNoAlpha 
CELLTYPE_ColorHasAlpha 
CELLTYPE_Color 
CELLTYPE_ColorMapValid 
CELLTYPE_3Cell_Color 
CELLTYPE_4Cell_Color 
CELLTYPE_HasAlphaBand 
CELLTYPE_DatabaseValid 
CELLTYPE_HistogramValid 
CELLTYPE_All 
enum RVC::IMAGE::CONVMODE

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

Enumerator:
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.

enum RVC::IMAGE::DATATYPE

Valid image datatypes.

Enumerator:
DATATYPE_Invalid 

Not a valid image 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).

enum RVC::IMAGE::PACKORDER
Enumerator:
PACKORDER_LeastSigBit 
PACKORDER_MostSigBit 
enum RVC::IMAGE::PYRAMID
Enumerator:
PYRAMID_Default 

Create pyramid with default settings.

PYRAMID_Rebuild 

Rebuild tiers even if exist.

PYRAMID_Average 

Average cells instead of sampling.

PYRAMID_UseParentTileSize 

Use parent image's tile size.

PYRAMID_UseColorMap 

Use colormap for averaging.

PYRAMID_Disable 

Disable pyramid creation.

PYRAMID_CompressLossy 

Use a predefined lossy compression type for tiers.

PYRAMID_CompressLossless 

Use a predefined lossless compression type for tiers.

PYRAMID_LargerMinTierSize 

Only create pyramid tiers that are usable by multiraster.

PYRAMID_NoHistogram 

Don't create a histogram after building pyramid tiers.

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

static 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.
static 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.
static DATATYPE RVC::IMAGE::ConvToDATATYPE ( int  RvcType,
UINT16  NumBits 
) [static, protected]
static UINT32 RVC::IMAGE::ConvToRastMode ( CONVMODE  value  )  [static, protected]
static DEPRECATED UINT16 RVC::IMAGE::ConvToRVCTYPE ( DATATYPE  type,
UINT16  NumBits 
) [static]

Temporary static method to convert IMAGE::DATATYPE and NumBits to legacy RVCTYPE flags.

Returns:
: RVCTYPE_ flag
static DEPRECATED UINT16 RVC::IMAGE::ConvToRVCTYPE ( CELLTYPE  CellType  )  [static]

Temporary static method to convert IMAGE::CELLTYPE to legacy RVCTYPE flags.

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

Obtain individual image band parameters.

CELLTYPE RVC::IMAGE::GetCellType (  )  const [inline]

Get the CELLTYPE of the IMAGE.

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

Get CELLTYPE corresponding to COLORSPACE.

Returns:
CELLTYPE value or CELLTYPE_Invalid if no conversion possible.
static void RVC::IMAGE::GetCellTypeRange ( CELLTYPE  CellType,
DOUBLE_RANGE &  Range,
int  component = 0 
) [static]

Get Image value range according to the CELLTYPE.

Parameters:
component Specify component, useful for complex types to get the imaginary or phase components
static 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

static 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 image cell column scale value.

Returns:
image cell column scale
static 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
static DATATYPE RVC::IMAGE::GetDataTypeFromCellType ( CELLTYPE  CellType  )  [static]

Get DATATYPE associated with specified CELLTYPE.

static 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
static 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 image cell row scale value.

Returns:
image cell row scale
ERRVALUE RVC::IMAGE::GetNullValue ( INT32  BandNum,
NULLVALUE &  NullValue 
) const [inline]

Obtain image band null value information.

Parameters:
BandNum Image band number to get NULLVALUE from
NullValue Current NULLVALUE to get from image
INT32 RVC::IMAGE::GetNumBands (  )  const [inline]

Determine the number of bands present in the image.

Returns:
number of bands
static UINT16 RVC::IMAGE::GetNumBitsFromCellType ( CELLTYPE  CellType  )  [static]

Get number of bits per cell for specified CELLTYPE.

INT64 RVC::IMAGE::GetNumCells (  )  const [inline]

Get number of cells in image.

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

Obtain number of columns in the image.

Returns:
number of columns in the image
static UINT16 RVC::IMAGE::GetNumComponentsFromCellType ( CELLTYPE  CellType  )  [static]

Get number of component values for specified CELLTYPE.

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

Obtain number of lines (rows) in the image.

Returns:
number of rows in the image
INT32 RVC::IMAGE::GetNumRows (  )  const [inline]

Obtain number of rows in the image.

Returns:
number of rows in the image
static NUMTYPE RVC::IMAGE::GetNumTypeFromCellType ( CELLTYPE  CellType  )  [static]

Get NUMTYPE associated with specified CELLTYPE.

static 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.
static bool RVC::IMAGE::IsImage ( RVC::OBJTYPE  ObjType  )  [static]

Determine if the object type is an image object.

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

Read a row of image cells up to a certain length, converting to 64 bit double.

Parameters:
Band Read a image line, 8 byte doubles Image band number to read
Row Image row to read
StartColumn Image column to start reading on
data Buffer to read into
Length Number of columns to read
ERRVALUE RVC::IMAGE::ReadBand ( INT32  Band,
INT32  Row,
INT32  StartColumn,
float *  data,
INT32  Length = 1 
) const [inline]

Read a row of image cells up to a certain length, converting to 32 bit float.

Parameters:
Band Read a image line, 4 byte floats Image band number to read
Row Image row to read
StartColumn Image column to start reading on
data Buffer to read into
Length Number of columns to read
ERRVALUE RVC::IMAGE::ReadBand ( INT32  Band,
INT32  Row,
INT32  StartColumn,
UINT32 *  data,
INT32  Length = 1 
) const [inline]

Read a row of image cells up to a certain length, converting to unsigned 32 bit.

Parameters:
Band Read a image line, unsigned 32 bit Image band number to read
Row Image row to read
StartColumn Image column to start reading on
data Buffer to read into
Length Number of columns to read
ERRVALUE RVC::IMAGE::ReadBand ( INT32  Band,
INT32  Row,
INT32  StartColumn,
INT32 *  data,
INT32  Length = 1 
) const [inline]

Read a row of image cells up to a certain length, converting to signed 32 bit.

Parameters:
Band Read a image line, signed 32 bit Image band number to read
Row Image row to read
StartColumn Image column to start reading on
data Buffer to read into
Length Number of columns to read
ERRVALUE RVC::IMAGE::ReadBand ( INT32  Band,
INT32  Row,
INT32  StartColumn,
UINT16 *  data,
INT32  Length = 1 
) const [inline]

Read a row of image cells up to a certain length, converting to unsigned 16 bit.

Parameters:
Band Read a image line, unsigned 16 bit Image band number to read
Row Image row to read
StartColumn Image column to start reading on
data Buffer to read into
Length Number of columns to read
ERRVALUE RVC::IMAGE::ReadBand ( INT32  Band,
INT32  Row,
INT32  StartColumn,
INT16 *  data,
INT32  Length = 1 
) const [inline]

Read a row of image cells up to a certain length, converting to signed 16 bit.

Parameters:
Band Read a image line, signed 16 bit Image band number to read
Row Image row to read
StartColumn Image column to start reading on
data Buffer to read into
Length Number of columns to read
ERRVALUE RVC::IMAGE::ReadBand ( INT32  Band,
INT32  Row,
INT32  StartColumn,
UINT8 *  data,
INT32  Length = 1 
) const [inline]

Read a row of image cells up to a certain length, converting to unsigned 8 bit.

Parameters:
Band Read a image line, unsigned 8 bit Image band number to read
Row Image row to read
StartColumn Image column to start reading on
data Buffer to read into
Length Number of columns to read
ERRVALUE RVC::IMAGE::ReadBand ( INT32  Band,
INT32  Row,
INT32  StartColumn,
INT8 *  data,
INT32  Length = 1 
) const [inline]

Read a row of image cells up to a certain length, converting to signed 8 bit.

Parameters:
Band Read a image line, signed 8 bit Image band number to read
Row Image row to read
StartColumn Image column to start reading on
data Buffer to read into
Length Number of columns to read
ERRVALUE RVC::IMAGE::ReadBand ( INT32  Band,
INT32  Row,
INT32  StartColumn,
void *  data,
INT32  Length = 1,
CONVMODE  Convert = CONVMODE_None 
) const [inline]

Read a row of image cells up to a certain length.

Parameters:
Row Image row to read
StartColumn Image column to start reading on
data Buffer to read into
Length Number of columns to read
Convert Data conversion mode
ERRVALUE RVC::IMAGE::ReadColumnBand ( INT32  Band,
INT32  Row,
INT32  StartColumn,
double *  data,
INT32  Length = 1 
) const [inline]

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

Parameters:
Band Read a image column, 8 byte doubles Image band number to read
Row Image row to start reading on
StartColumn Image column to read
data Buffer to read into
Length Number of lines to read
ERRVALUE RVC::IMAGE::ReadColumnBand ( INT32  Band,
INT32  Row,
INT32  StartColumn,
float *  data,
INT32  Length = 1 
) const [inline]

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

Parameters:
Band Read a image column, 4 byte floats Image band number to read
Row Image row to start reading on
StartColumn Image column to read
data Buffer to read into
Length Number of lines to read
ERRVALUE RVC::IMAGE::ReadColumnBand ( INT32  Band,
INT32  Row,
INT32  StartColumn,
UINT32 *  data,
INT32  Length = 1 
) const [inline]

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

Parameters:
Band Read a image column, unsigned 32 bit Image band number to read
Row Image row to start reading on
StartColumn Image column to read
data Buffer to read into
Length Number of lines to read
ERRVALUE RVC::IMAGE::ReadColumnBand ( INT32  Band,
INT32  Row,
INT32  StartColumn,
INT32 *  data,
INT32  Length = 1 
) const [inline]

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

Parameters:
Band Read a image column, signed 32 bit Image band number to read
Row Image row to start reading on
StartColumn Image column to read
data Buffer to read into
Length Number of lines to read
ERRVALUE RVC::IMAGE::ReadColumnBand ( INT32  Band,
INT32  Row,
INT32  StartColumn,
UINT16 *  data,
INT32  Length = 1 
) const [inline]

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

Parameters:
Band Read a image column, unsigned 16 bit Image band number to read
Row Image row to start reading on
StartColumn Image column to read
data Buffer to read into
Length Number of lines to read
ERRVALUE RVC::IMAGE::ReadColumnBand ( INT32  Band,
INT32  Row,
INT32  StartColumn,
INT16 *  data,
INT32  Length = 1 
) const [inline]

Read a column of image cells up to a certain length, converting to signed 16 bit.

Parameters:
Band Read a image column, signed 16 bit Image band number to read
Row Image row to start reading on
StartColumn Image column to read
data Buffer to read into
Length Number of lines to read
ERRVALUE RVC::IMAGE::ReadColumnBand ( INT32  Band,
INT32  Row,
INT32  StartColumn,
UINT8 *  data,
INT32  Length = 1 
) const [inline]

Read a column of image cells up to a certain length, converting to unsigned 8 bit.

Parameters:
Band Read a image column, unsigned 8 bit Image band number to read
Row Image row to start reading on
StartColumn Image column to read
data Buffer to read into
Length Number of lines to read
ERRVALUE RVC::IMAGE::ReadColumnBand ( INT32  Band,
INT32  Row,
INT32  StartColumn,
INT8 *  data,
INT32  Length = 1 
) const [inline]

Read a column of image cells up to a certain length, converting to signed 8 bit.

Parameters:
Band Read a image column, signed 8 bit Image band number to read
Row Image row to start reading on
StartColumn Image column to read
data Buffer to read into
Length Number of lines to read
ERRVALUE RVC::IMAGE::ReadColumnBand ( INT32  Band,
INT32  Row,
INT32  StartColumn,
void *  data,
INT32  Length = 1,
CONVMODE  Convert = CONVMODE_None 
) const [inline]

Read a row of image cells up to a certain length.

Parameters:
Row Image row to read
StartColumn Image column to start reading on
data Buffer to read into
Length Number of columns to read
Convert Data conversion mode
ERRVALUE RVC::IMAGE::SetCacheRect ( const LRECT2D &  Rect  )  [inline]

Set the image cache to best cache the image section requested.

Parameters:
Rect Section of image to cache
ERRVALUE RVC::IMAGE::SetCacheSize ( CACHEMODE  CacheFlags  )  [inline]

Set the image tile cache to cache a number of tiles specified by the RVC::IMAGE::CACHEMODE enumeration.

Parameters:
CacheFlags Tile row or diagonal tile cache sizes
ERRVALUE RVC::IMAGE::SetCacheSize ( INT32  NumTiles  )  [inline]

Set the image tile cache to cache the number of tiles specified.

Parameters:
NumTiles Number of tiles to set cache
ERRVALUE RVC::IMAGE::SetNullValue ( INT32  BandNum,
const NULLVALUE *  NullValue 
) [inline]

Set the null value for the image If the 'NullValue' pointer is 'null', the image does not have a null value.

Parameters:
NullValue If pointer is 'null', the image has no null value, if not, the image has a null value
ERRVALUE RVC::IMAGE::WriteBand ( INT32  Band,
INT32  Row,
INT32  StartColumn,
const double *  data,
INT32  Length = 1 
) [inline]

Write a row of image cells up to a certain length, converting from 64 bit double.

Parameters:
Band Write a image line, 8 byte doubles Image band number to write
Row Image row to write
StartColumn Image column to start writing on
data Buffer to write from
Length Number of columns to write
ERRVALUE RVC::IMAGE::WriteBand ( INT32  Band,
INT32  Row,
INT32  StartColumn,
const float *  data,
INT32  Length = 1 
) [inline]

Write a row of image cells up to a certain length, converting from 32 bit float.

Parameters:
Band Write a image line, 4 byte floats Image band number to write
Row Image row to write
StartColumn Image column to start writing on
data Buffer to write from
Length Number of columns to write
ERRVALUE RVC::IMAGE::WriteBand ( INT32  Band,
INT32  Row,
INT32  StartColumn,
const UINT32 *  data,
INT32  Length = 1 
) [inline]

Write a row of image cells up to a certain length, converting from unsigned 32 bit.

Parameters:
Band Write a image line, unsigned 32 bit Image band number to write
Row Image row to write
StartColumn Image column to start writing on
data Buffer to write from
Length Number of columns to write
ERRVALUE RVC::IMAGE::WriteBand ( INT32  Band,
INT32  Row,
INT32  StartColumn,
const INT32 *  data,
INT32  Length = 1 
) [inline]

Write a row of image cells up to a certain length, converting from signed 32 bit.

Parameters:
Band Write a image line, signed 32 bit Image band number to write
Row Image row to write
StartColumn Image column to start writing on
data Buffer to write from
Length Number of columns to write
ERRVALUE RVC::IMAGE::WriteBand ( INT32  Band,
INT32  Row,
INT32  StartColumn,
const UINT16 *  data,
INT32  Length = 1 
) [inline]

Write a row of image cells up to a certain length, converting from unsigned 16 bit.

Parameters:
Band Write a image line, unsigned 16 bit Image band number to write
Row Image row to write
StartColumn Image column to start writing on
data Buffer to write from
Length Number of columns to write
ERRVALUE RVC::IMAGE::WriteBand ( INT32  Band,
INT32  Row,
INT32  StartColumn,
const INT16 *  data,
INT32  Length = 1 
) [inline]

Write a row of image cells up to a certain length, converting from signed 16 bit.

Parameters:
Band Write a image line, signed 16 bit Image band number to write
Row Image row to write
StartColumn Image column to start writing on
data Buffer to write from
Length Number of columns to write
ERRVALUE RVC::IMAGE::WriteBand ( INT32  Band,
INT32  Row,
INT32  StartColumn,
const UINT8 *  data,
INT32  Length = 1 
) [inline]

Write a row of image cells up to a certain length, converting from unsigned 8 bit.

Parameters:
Band Write a image line, unsigned 8 bit Image band number to write
Row Image row to write
StartColumn Image column to start writing on
data Buffer to write from
Length Number of columns to write
ERRVALUE RVC::IMAGE::WriteBand ( INT32  Band,
INT32  Row,
INT32  StartColumn,
const INT8 *  data,
INT32  Length = 1 
) [inline]

Write a row of image cells up to a certain length, converting from signed 8 bit.

Parameters:
Band Write a image line, signed 8 bit Image band number to write
Row Image row to write
StartColumn Image column to start writing on
data Buffer to write from
Length Number of columns to write
ERRVALUE RVC::IMAGE::WriteBand ( INT32  Band,
INT32  Row,
INT32  StartColumn,
const void *  data,
INT32  Length = 1,
CONVMODE  Convert = CONVMODE_None 
) [inline]

Write a row of image cells up to a certain length.

Parameters:
Band Image band number to write
Row Image row to write
StartColumn Image column to start writing on
data Buffer to write into
Length Number of columns to write
Convert Data conversion mode
The documentation for this class was generated from the following file:
Generated on Sun Oct 7 21:37:36 2012 for TNTsdk 2012 by  doxygen 1.6.1