RVC::RASTER Class Reference

Manage RVC::OBJTYPE_Raster RVC objects. More...

#include <rvc/raster.h>

Inheritance diagram for RVC::RASTER:
Inheritance graph
[legend]

List of all members.

Classes

class  GETOBJFILTER_ISOVERLAPPING
 Convenience filter for raster selection. More...
class  GETOBJFILTER_ISSELECTABLE
 Convenience filter for raster selection. More...
class  IMAGESCALE
 Class to implement raster scale values. More...
class  LINKPARMS
 Parmeters needed to link to external rasters. More...
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
class  MAKEPARMS
 Class to handle values needed to define the characteristics of a raster. More...

Public Types

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
}

Public Member Functions

 RASTER (const RVC::RASTER &rhs)
 RASTER ()
virtual ~RASTER ()
ERRVALUE ComputeUnivariateStatistics (STAT_UNIVARIATE &StatUnivariate, COMPONENT Component=COMPONENT_Default)
ERRVALUE CopyAverageTo (RASTER &DestRaster, INT32 ColumnSample, INT32 LineSample, COLOR_ARRAY *ColorMap=0)
ERRVALUE CopyRasterTo (RASTER &TargetRaster)
ERRVALUE CopyRasterTo (RVC::OBJITEM &ObjItemTarget, const MAKEPARMS &MakeParm, const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS)
ERRVALUE CopySampledTo (RASTER &DestRaster, INT32 ColumnSample, INT32 LineSample, const LRECT2D &ExtractRect, LRECT2D *DestRect=0)
ERRVALUE CopySampledTo (RASTER &DestRaster, INT32 ColumnSample, INT32 LineSample)
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
IMAGE::DATATYPE GetDataType () const
ERRVALUE GetEmbeddedPyramidList (SIMPLE_ARRAY< INT32 > &samplerates)
ERRVALUE GetImageScale (IMAGESCALE &scale) const
LINKTYPE GetLinkType () const
const MAKEPARMS & GetMakeParms () const
ERRVALUE GetNullValue (NULLVALUE &NullValue) const
UINT16 GetNumBits () const
INT32 GetNumTileColumns () const
INT32 GetNumTileLines () const
UINT16 GetNumUsedBits () const
INT32 GetNumXTiles () const
INT32 GetNumYTiles () const
PACKORDER GetPackOrder () const
ERRVALUE GetPyramidInfo (SIMPLE_ARRAY< IMAGEDIMENSIONS > &TierInfo, RVC::OBJITEMLIST &PyramidList) const
ERRVALUE GetPyramidList (SIMPLE_ARRAY< INT32 > &SampleList, RVC::OBJITEMLIST &PyramidList) const
INT32 GetTileSizeBytes () const
USAGE GetUsage () const
bool HasNullValue () const
bool IsCompressed () const
bool IsInverted () const
bool IsLossyCompressed () const
ERRVALUE Link (const RVC::OBJECT &parent, const RVC::DESCRIPTOR &Descriptor, const LINKPARMS &LinkParms, USAGE Usage, const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS)
ERRVALUE Link (const RVC::OBJECT &parent, const RVC::DESCRIPTOR &Descriptor, const LINKPARMS &LinkParms, const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS)
ERRVALUE Make (RVC::OBJITEM &ObjItem, MAKEPARMS &MakeParms, const char *Source=0, 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 MakePyramidSet (RASTER::COMPTYPE comptype, UINT16 compquality, IMAGE::PYRAMID flags=IMAGE::PYRAMID_Default, const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS)
ERRVALUE MakePyramidSet (IMAGE::PYRAMID flags=IMAGE::PYRAMID_Default, const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS)
RVC::RASTER & operator= (const RVC::RASTER &rhs)
float QueryStepOrder (STEPORDER steporder)
ERRVALUE Read (INT32 Line, INT32 StartColumn, double *data, INT32 Length=1, COMPONENT Component=COMPONENT_Default) const
ERRVALUE Read (INT32 Line, INT32 StartColumn, float *data, INT32 Length=1, COMPONENT Component=COMPONENT_Default) const
ERRVALUE Read (INT32 Line, INT32 StartColumn, UINT32 *data, INT32 Length=1, COMPONENT Component=COMPONENT_Default) const
ERRVALUE Read (INT32 Line, INT32 StartColumn, INT32 *data, INT32 Length=1, COMPONENT Component=COMPONENT_Default) const
ERRVALUE Read (INT32 Line, INT32 StartColumn, UINT16 *data, INT32 Length=1, COMPONENT Component=COMPONENT_Default) const
ERRVALUE Read (INT32 Line, INT32 StartColumn, INT16 *data, INT32 Length=1, COMPONENT Component=COMPONENT_Default) const
ERRVALUE Read (INT32 Line, INT32 StartColumn, UINT8 *data, INT32 Length=1, COMPONENT Component=COMPONENT_Default) const
ERRVALUE Read (INT32 Line, INT32 StartColumn, INT8 *data, INT32 Length=1, COMPONENT Component=COMPONENT_Default) const
ERRVALUE Read (INT32 Line, INT32 StartColumn, void *data, INT32 Length=1, CONVMODE Convert=CONVMODE_None, COMPONENT Component=COMPONENT_Default) const
ERRVALUE ReadColumn (INT32 Line, INT32 StartColumn, double *data, INT32 Length=1, COMPONENT Component=COMPONENT_Default) const
ERRVALUE ReadColumn (INT32 Line, INT32 StartColumn, float *data, INT32 Length=1, COMPONENT Component=COMPONENT_Default) const
ERRVALUE ReadColumn (INT32 Line, INT32 StartColumn, UINT32 *data, INT32 Length=1, COMPONENT Component=COMPONENT_Default) const
ERRVALUE ReadColumn (INT32 Line, INT32 StartColumn, INT32 *data, INT32 Length=1, COMPONENT Component=COMPONENT_Default) const
ERRVALUE ReadColumn (INT32 Line, INT32 StartColumn, UINT16 *data, INT32 Length=1, COMPONENT Component=COMPONENT_Default) const
ERRVALUE ReadColumn (INT32 Line, INT32 StartColumn, INT16 *data, INT32 Length=1, COMPONENT Component=COMPONENT_Default) const
ERRVALUE ReadColumn (INT32 Line, INT32 StartColumn, UINT8 *data, INT32 Length=1, COMPONENT Component=COMPONENT_Default) const
ERRVALUE ReadColumn (INT32 Line, INT32 StartColumn, INT8 *data, INT32 Length=1, COMPONENT Component=COMPONENT_Default) const
ERRVALUE ReadColumn (INT32 Line, INT32 StartColumn, void *data, INT32 Length=1, CONVMODE Convert=CONVMODE_None, COMPONENT Component=COMPONENT_Default) const
ERRVALUE SetImageScale (const IMAGESCALE &scale)
ERRVALUE SetNullValue (const NULLVALUE &NullValue, bool NullUsed=true)
ERRVALUE Write (INT32 Line, INT32 StartColumn, const double *data, INT32 Length=1, COMPONENT Component=COMPONENT_Default)
ERRVALUE Write (INT32 Line, INT32 StartColumn, const float *data, INT32 Length=1, COMPONENT Component=COMPONENT_Default)
ERRVALUE Write (INT32 Line, INT32 StartColumn, const UINT32 *data, INT32 Length=1, COMPONENT Component=COMPONENT_Default)
ERRVALUE Write (INT32 Line, INT32 StartColumn, const INT32 *data, INT32 Length=1, COMPONENT Component=COMPONENT_Default)
ERRVALUE Write (INT32 Line, INT32 StartColumn, const UINT16 *data, INT32 Length=1, COMPONENT Component=COMPONENT_Default)
ERRVALUE Write (INT32 Line, INT32 StartColumn, const INT16 *data, INT32 Length=1, COMPONENT Component=COMPONENT_Default)
ERRVALUE Write (INT32 Line, INT32 StartColumn, const UINT8 *data, INT32 Length=1, COMPONENT Component=COMPONENT_Default)
ERRVALUE Write (INT32 Line, INT32 StartColumn, const INT8 *data, INT32 Length=1, COMPONENT Component=COMPONENT_Default)
ERRVALUE Write (INT32 Line, INT32 StartColumn, const void *data, INT32 Length=1, CONVMODE Convert=CONVMODE_None, COMPONENT Component=COMPONENT_Default)

Static Public Member Functions

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)
static TEXTID GetComponentTextID (COMPONENT component)
static ERRVALUE GetPyramidInfo (const OBJITEM &RastObjItem, SIMPLE_ARRAY< IMAGEDIMENSIONS > &TierInfo, RVC::OBJITEMLIST &PyramidList, const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS)
static ERRVALUE GetPyramidList (const OBJITEM &RastObjItem, SIMPLE_ARRAY< INT32 > &SampleList, RVC::OBJITEMLIST &PyramidList, const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS)

Protected Member Functions

void AssignValues (const RASTINFO &rinfo)
RASTERHANDLE & GetRasterHandle ()
bool IsRasterHandleValid ()
void SetRasterHandle (RASTERHANDLE *RastHandle)

Detailed Description

Manage RVC::OBJTYPE_Raster RVC objects.

Valid parents for this class:

Member Enumeration Documentation

enum RVC::RASTER::COMPONENT
Enumerator:
COMPONENT_Default 

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

Select default component

COMPONENT_Red 

Convert RGB to Red.

COMPONENT_Green 

Convert RGB to Green.

COMPONENT_Blue 

Convert RGB to Blue.

COMPONENT_Real 

Convert to Real complex component.

COMPONENT_Imaginary 

Convert to Imaginary complex component.

COMPONENT_Magnitude 

Convert to Magnitude complex component.

COMPONENT_Phase 

Convert to Phase complex component.

COMPONENT_Alpha 

Convert to Alpha channel component from RGBA or ARGB.

COMPONENT_Cyan 

Convert to Cyan from CMYK or KCMY.

COMPONENT_Magenta 

Convert to Magenta from CMYK or KCMY.

COMPONENT_Yellow 

Convert to Yellow from CMYK or KCMY.

COMPONENT_Black 

Convert to Black from CMYK or KCMY.

enum RVC::RASTER::COMPTYPE
Enumerator:
COMPTYPE_None 

Raster compression types.

No compression within each tile (empty tiles not stored though)

COMPTYPE_RLE 

RLE compression, valid for 1-bit rasters.

COMPTYPE_JPEG 

JPEG compression, valid for 8-bit and 24-bit rasters.

COMPTYPE_Huffman 

Huffman compression, used in Hyperspectral images.

COMPTYPE_DPCM 

DPCM compression.

COMPTYPE_JPEG2000 

JPEG2000 compression.

COMPTYPE_JP2 
enum RVC::RASTER::LINKTYPE
Enumerator:
LINKTYPE_NoLink 

Type of external objects that can be linked to.

Raster is internal

LINKTYPE_TIFF 

Raster is a link to TIFF image.

LINKTYPE_Generic 

Raster is a link to a generic raster image.

LINKTYPE_MrSID 
LINKTYPE_ECW 
LINKTYPE_JP2 
LINKTYPE_SocetSetDT 
LINKTYPE_PNG 
LINKTYPE_JPEG 
LINKTYPE_GDAL 
LINKTYPE_Multi 
enum RVC::RASTER::STEPORDER
Enumerator:
STEPORDER_FullSequential 

Full width section sequentially from beginning of image.

STEPORDER_TileSequential 

Tile width section sequentially from beginning of tile.

STEPORDER_TileRandom 

Section anywhere entirely within single tile.

STEPORDER_AnyRandom 

Section anywhere in image, even across tile boundaries.

enum RVC::RASTER::USAGE
Enumerator:
USAGE_Default 

Raster usage values, used in Make().

Ordinary raster

USAGE_HyspcBand 

HyperSpectral Band raster.

USAGE_HyspcClass 

HyperSpectral Class raster.

USAGE_HyspcAverage 

HyperSpectral Average raster.

USAGE_Pyramid 

Pyramid raster.

USAGE_PrinComp 

Principle Components raster.

USAGE_NullBand 

Null band raster.

USAGE_Opacity 

Opacity mask raster.

USAGE_SurfaceElevation 

Surface Elevation raster.

USAGE_SurfaceError 

Surface Error raster.

USAGE_SurfaceRadius 

Surface Radius raster.

USAGE_MultiRasterTile 

Tile of a multiraster.

Constructor & Destructor Documentation

RVC::RASTER::RASTER (  ) 

Default constructor.

RVC::RASTER::RASTER ( const RVC::RASTER &  rhs  ) 

Copy constructor.

virtual RVC::RASTER::~RASTER (  )  [virtual]

Destructor.

Member Function Documentation

void RVC::RASTER::AssignValues ( const RASTINFO &  rinfo  )  [protected]
static ERRVALUE RVC::RASTER::AutoLinkJP2 ( RVC::OBJECT &  ParentObj,
const FILEPATH &  LinkFile,
RVC::GEOSPATIAL::MAKELINKFLAGS  LinkFlags 
) [static]
static ERRVALUE RVC::RASTER::AutoLinkTIFF ( RVC::OBJECT &  ParentObj,
const FILEPATH &  LinkFile,
RVC::GEOSPATIAL::MAKELINKFLAGS  LinkFlags 
) [static]
static bool RVC::RASTER::ComputeNextPyramidSize ( INT32 &  NumColumns,
INT32 &  NumLines,
bool  IsFirst 
) [static]

Compute the next pyramid size based on the sizes passed in.

Returns:
'True' if the next size is valid, 'false' if not
Parameters:
IsFirst True if for first tier, false for additional tiers
ERRVALUE RVC::RASTER::ComputeUnivariateStatistics ( STAT_UNIVARIATE &  StatUnivariate,
COMPONENT  Component = COMPONENT_Default 
)

Compute Univariate Statistics on this raster object.

Parameters:
StatUnivariate Univariate Statistics RETURNED
Component Component extraction value
ERRVALUE RVC::RASTER::CopyAverageTo ( RASTER &  DestRaster,
INT32  ColumnSample,
INT32  LineSample,
COLOR_ARRAY *  ColorMap = 0 
)

Copy the raster into the 'DestRaster' object using the sampling rates 'ColumnSample' and 'LineSample' This algorithm averages the cell cluster based on the sample rate for the destination.

ERRVALUE RVC::RASTER::CopyRasterTo ( RASTER &  TargetRaster  ) 

Copy the raster into the 'TargetRaster' object.

The target raster must have the same dimensions and usually the same cell type as the raster being copied, however, limited cell type conversions where required for compression are supported.

Parameters:
TargetRaster Newly created raster to copy into
ERRVALUE RVC::RASTER::CopyRasterTo ( RVC::OBJITEM &  ObjItemTarget,
const MAKEPARMS &  MakeParm,
const CREDENTIALS *Credentials  RVC_DEFAULT_CREDENTIALS 
)

Copy the raster to the specified target location.

The target raster will be created with the same dimensions as the raster being copied. If no compatible cell type is specified in the MakeParm instance, the cell type will be determined from the source raster. The cell type may also be adjusted based on the compression settings. Use of this function may require computation of a histogram for the source raster and may also require multiple processing passes on the source raster.

Parameters:
ObjItemTarget Target raster location passed/returned
MakeParm Parameters for target raster creation
RVC_DEFAULT_CREDENTIALS User credentials passed in, NULL for default behavior
ERRVALUE RVC::RASTER::CopySampledTo ( RASTER &  DestRaster,
INT32  ColumnSample,
INT32  LineSample,
const LRECT2D &  ExtractRect,
LRECT2D *  DestRect = 0 
)

Copy the raster into the 'DestRaster' object using the sampling rates 'ColumnSample' and 'LineSample' This algorithm selects a cell to copy to the destination raster based on the sample rate.

When constructing your ExtractRect (and optional DestRect), note that this method considers the "initial" x and y coordinates to be the upper-left hand corner of the image, and the "last" coordinates to be the lower-right hand corner.

Parameters:
DestRect Initial / last rows and columns to copy to DestRaster. Destination position. Only need to supply start line and column coordinates, final x and y will be filled in by this method.
ERRVALUE RVC::RASTER::CopySampledTo ( RASTER &  DestRaster,
INT32  ColumnSample,
INT32  LineSample 
)

Copy the raster into the 'DestRaster' object using the sampling rates 'ColumnSample' and 'LineSample' This algorithm selects a cell to copy to the destination raster based on the sample rate.

ERRVALUE RVC::RASTER::CreateSMLContext ( SML::CONTEXT **  pcontext  ) 

Create an SML context for the given raster class instance.

Parameters:
pcontext SML context allocated and RETURNED
ERRVALUE RVC::RASTER::ExtractTo ( RASTER &  TgtRaster,
const LRECT2D &  SrcRect,
LRECT2D *  TgtRect = 0 
)

Extract portion of raster, including null value/mask and georeference.

Parameters:
SrcRect Destination raster
TgtRect Source rectangle to extract Destination position. Only need to supply start line and column coordinates, final x and y will be filled in by this method.
ERRVALUE RVC::RASTER::GetComponents ( SIMPLE_ARRAY< COMPONENT > &  Components  )  const

Obtain array of components present for this raster.

static TEXTID RVC::RASTER::GetComponentTextID ( COMPONENT  component  )  [static]

Get TEXTID for name of COMPONENT.

COMPTYPE RVC::RASTER::GetCompressionType (  )  const [inline]

Obtain raster compression type.

Returns:
RVC::RASTER::COMPTYPE for the raster.
IMAGE::DATATYPE RVC::RASTER::GetDataType (  )  const [inline]

Obtain raster datatype based on RVC::IMAGE::DATATYPE enumeration.

Returns:
RVC::IMAGE::DATATYPE of the raster
ERRVALUE RVC::RASTER::GetEmbeddedPyramidList ( SIMPLE_ARRAY< INT32 > &  samplerates  ) 

Linked rasters only - finds sampling information for embedded reduced resolution image data if the link format supports it.

ERRVALUE RVC::RASTER::GetImageScale ( IMAGESCALE &  scale  )  const

Obtain raster scale values (line, column, data scale and data offset).

Parameters:
scale Class to hold image scale values RETURNED
LINKTYPE RVC::RASTER::GetLinkType (  )  const [inline]

Obtain type of external image the raster object is linked to.

Returns:
RVC::RASTER::LINKTYPE enumeration value
const MAKEPARMS& RVC::RASTER::GetMakeParms (  )  const [inline]

Obtain raster creation parameters.

Returns:
const RVC::RASTER::MAKEPARMS
ERRVALUE RVC::RASTER::GetNullValue ( NULLVALUE &  NullValue  )  const

Obtain raster null value information.

Parameters:
NullValue Current NULLVALUE to get from raster
UINT16 RVC::RASTER::GetNumBits (  )  const [inline]

Obtain number of bits in a raster cell.

Returns:
number of bits in a raster cell
INT32 RVC::RASTER::GetNumTileColumns (  )  const [inline]

Obtain number of columns in a raster tile.

Returns:
number of columns in the raster tile
INT32 RVC::RASTER::GetNumTileLines (  )  const [inline]

Obtain number of lines in a raster tile.

Returns:
number of lines in the raster tile
UINT16 RVC::RASTER::GetNumUsedBits (  )  const [inline]

Get the number of used bits.

This related to JP2 compression and is dependent on the source raster value range. The number of used bits will be less than or equal to the number of bits in the created raster object.

INT32 RVC::RASTER::GetNumXTiles (  )  const [inline]

Obtain number of tiles in a raster row.

Returns:
number of row tiles
INT32 RVC::RASTER::GetNumYTiles (  )  const [inline]

Obtain number of tiles in a raster column.

Returns:
number of column tiles
PACKORDER RVC::RASTER::GetPackOrder (  )  const [inline]

Obtain raster pack order.

Returns:
Raster pack order
static ERRVALUE RVC::RASTER::GetPyramidInfo ( const OBJITEM &  RastObjItem,
SIMPLE_ARRAY< IMAGEDIMENSIONS > &  TierInfo,
RVC::OBJITEMLIST &  PyramidList,
const CREDENTIALS *Credentials  RVC_DEFAULT_CREDENTIALS 
) [static]

Return list of available raster pyramid sub-rasters.

The TierInfo array will be sorted in ascending order by sampling and the array and list are aligned.

Parameters:
TierInfo Simple array of tier dimensions and sampling returned.
PyramidList List of pyramid raster ObjItem's RETURNED
RVC_DEFAULT_CREDENTIALS User credentials passed in, NULL for default behavior
ERRVALUE RVC::RASTER::GetPyramidInfo ( SIMPLE_ARRAY< IMAGEDIMENSIONS > &  TierInfo,
RVC::OBJITEMLIST &  PyramidList 
) const

Return list of available raster pyramid sub-rasters.

The TierInfo array will be sorted in ascending order by sampling and the array and list are aligned.

Parameters:
TierInfo Simple array of tier dimensions and sampling returned.
PyramidList List of pyramid raster ObjItem's RETURNED
static ERRVALUE RVC::RASTER::GetPyramidList ( const OBJITEM &  RastObjItem,
SIMPLE_ARRAY< INT32 > &  SampleList,
RVC::OBJITEMLIST &  PyramidList,
const CREDENTIALS *Credentials  RVC_DEFAULT_CREDENTIALS 
) [static]

Return list of available raster pyramid sub-rasters.

The sample rate list will be sorted in ascending order and the array and list are aligned.

Parameters:
SampleList Simple array of available sample rates RETURNED
PyramidList List of pyramid raster ObjItem's RETURNED
RVC_DEFAULT_CREDENTIALS User credentials passed in, NULL for default behavior
ERRVALUE RVC::RASTER::GetPyramidList ( SIMPLE_ARRAY< INT32 > &  SampleList,
RVC::OBJITEMLIST &  PyramidList 
) const

Return list of available raster pyramid sub-rasters.

The sample rate list will be sorted in ascending order and the array and list are aligned.

Parameters:
SampleList Simple array of available sample rates RETURNED
PyramidList List of pyramid raster ObjItem's RETURNED
RASTERHANDLE& RVC::RASTER::GetRasterHandle (  )  [inline, protected]
INT32 RVC::RASTER::GetTileSizeBytes (  )  const [inline]

Obtain number of bytes in a raster tile.

Returns:
size of raster tile in bytes
USAGE RVC::RASTER::GetUsage (  )  const [inline]

Obtain purpose of raster image.

Returns:
RVC::RASTER::USAGE enumeration value
bool RVC::RASTER::HasNullValue (  )  const

Determine if null value exists for raster.

bool RVC::RASTER::IsCompressed (  )  const [inline]

Is the raster compressed?

Returns:
true if the raster is compressed
bool RVC::RASTER::IsInverted (  )  const [inline]

Is the raster flipped around such that the first raster line is at the bottom of the image.

Returns:
true if the raster is inverted
bool RVC::RASTER::IsLossyCompressed (  )  const [inline]

Is the raster compressed with a lossy compression algorithm?

Returns:
true if the raster is compressed with a lossy compression algorithm
bool RVC::RASTER::IsRasterHandleValid (  )  [inline, protected]
ERRVALUE RVC::RASTER::Link ( const RVC::OBJECT &  parent,
const RVC::DESCRIPTOR &  Descriptor,
const LINKPARMS &  LinkParms,
USAGE  Usage,
const CREDENTIALS *Credentials  RVC_DEFAULT_CREDENTIALS 
)

Create a raster object and establish a link to an external image.

Parameters:
parent Parent object to create raster under
Usage raster object created will have this usage
RVC_DEFAULT_CREDENTIALS User credentials passed in, NULL for default behavior
ERRVALUE RVC::RASTER::Link ( const RVC::OBJECT &  parent,
const RVC::DESCRIPTOR &  Descriptor,
const LINKPARMS &  LinkParms,
const CREDENTIALS *Credentials  RVC_DEFAULT_CREDENTIALS 
)

Create a raster object and establish a link to an external image.

Parameters:
parent Parent object to create raster under
RVC_DEFAULT_CREDENTIALS User credentials passed in, NULL for default behavior
ERRVALUE RVC::RASTER::Make ( RVC::OBJITEM &  ObjItem,
MAKEPARMS &  MakeParms,
const char *  Source = 0,
const CREDENTIALS *Credentials  RVC_DEFAULT_CREDENTIALS 
)

Create a raster object.

Parameters:
ObjItem Parent object and DESCRIPTOR of object to create, new location RETURNED
MakeParms Parameters needed to create raster, cannot be changed after creation
Source Source of raster creation, default is GetAppName()
RVC_DEFAULT_CREDENTIALS User credentials passed in, NULL for default behavior
ERRVALUE RVC::RASTER::Make ( const RVC::OBJECT &  parent,
const RVC::DESCRIPTOR &  Descriptor,
MAKEPARMS &  MakeParms,
const CREDENTIALS *Credentials  RVC_DEFAULT_CREDENTIALS 
)

Create a raster object.

Parameters:
parent Parent object to create raster under
MakeParms Parameters needed to create raster, cannot be changed after creation
RVC_DEFAULT_CREDENTIALS User credentials passed in, NULL for default behavior
ERRVALUE RVC::RASTER::MakePyramidSet ( RASTER::COMPTYPE  comptype,
UINT16  compquality,
IMAGE::PYRAMID  flags = IMAGE::PYRAMID_Default,
const CREDENTIALS *Credentials  RVC_DEFAULT_CREDENTIALS 
)
Parameters:
RVC_DEFAULT_CREDENTIALS User credentials passed in, NULL for default behavior
ERRVALUE RVC::RASTER::MakePyramidSet ( IMAGE::PYRAMID  flags = IMAGE::PYRAMID_Default,
const CREDENTIALS *Credentials  RVC_DEFAULT_CREDENTIALS 
)

Create pyramid set under this raster object It will not write over valid pyramids unless PYRAMID_Rebuild is specified.

Parameters:
RVC_DEFAULT_CREDENTIALS User credentials passed in, NULL for default behavior
RVC::RASTER& RVC::RASTER::operator= ( const RVC::RASTER &  rhs  ) 

Assignment.

Reimplemented from RVC::OBJECT.

float RVC::RASTER::QueryStepOrder ( STEPORDER  steporder  ) 

Query support/efficiency for specified stepping order.

Returns:
Efficiency between 0 and 1, 0 indicates not supported, 1 indicates most efficient.
Parameters:
steporder Stepping order to query
ERRVALUE RVC::RASTER::Read ( INT32  Line,
INT32  StartColumn,
double *  data,
INT32  Length = 1,
COMPONENT  Component = COMPONENT_Default 
) const [inline]

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

Parameters:
Line Raster line to read
StartColumn Raster column to start reading on
data Buffer to read into
Length Number of columns to read
Component Component extraction value
ERRVALUE RVC::RASTER::Read ( INT32  Line,
INT32  StartColumn,
float *  data,
INT32  Length = 1,
COMPONENT  Component = COMPONENT_Default 
) const [inline]

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

Parameters:
Line Raster line to read
StartColumn Raster column to start reading on
data Buffer to read into
Length Number of columns to read
Component Component extraction value
ERRVALUE RVC::RASTER::Read ( INT32  Line,
INT32  StartColumn,
UINT32 *  data,
INT32  Length = 1,
COMPONENT  Component = COMPONENT_Default 
) const [inline]

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

Parameters:
Line Raster line to read
StartColumn Raster column to start reading on
data Buffer to read into
Length Number of columns to read
Component Component extraction value
ERRVALUE RVC::RASTER::Read ( INT32  Line,
INT32  StartColumn,
INT32 *  data,
INT32  Length = 1,
COMPONENT  Component = COMPONENT_Default 
) const [inline]

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

Parameters:
Line Raster line to read
StartColumn Raster column to start reading on
data Buffer to read into
Length Number of columns to read
Component Component extraction value
ERRVALUE RVC::RASTER::Read ( INT32  Line,
INT32  StartColumn,
UINT16 *  data,
INT32  Length = 1,
COMPONENT  Component = COMPONENT_Default 
) const [inline]

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

Parameters:
Line Raster line to read
StartColumn Raster column to start reading on
data Buffer to read into
Length Number of columns to read
Component Component extraction value
ERRVALUE RVC::RASTER::Read ( INT32  Line,
INT32  StartColumn,
INT16 *  data,
INT32  Length = 1,
COMPONENT  Component = COMPONENT_Default 
) const [inline]

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

Parameters:
Line Raster line to read
StartColumn Raster column to start reading on
data Buffer to read into
Length Number of columns to read
Component Component extraction value
ERRVALUE RVC::RASTER::Read ( INT32  Line,
INT32  StartColumn,
UINT8 *  data,
INT32  Length = 1,
COMPONENT  Component = COMPONENT_Default 
) const [inline]

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

Parameters:
Line Raster line to read
StartColumn Raster column to start reading on
data Buffer to read into
Length Number of columns to read
Component Component extraction value
ERRVALUE RVC::RASTER::Read ( INT32  Line,
INT32  StartColumn,
INT8 *  data,
INT32  Length = 1,
COMPONENT  Component = COMPONENT_Default 
) const [inline]

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

Parameters:
Line Raster line to read
StartColumn Raster column to start reading on
data Buffer to read into
Length Number of columns to read
Component Component extraction value
ERRVALUE RVC::RASTER::Read ( INT32  Line,
INT32  StartColumn,
void *  data,
INT32  Length = 1,
CONVMODE  Convert = CONVMODE_None,
COMPONENT  Component = COMPONENT_Default 
) const

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
Component Component extraction value
ERRVALUE RVC::RASTER::ReadColumn ( INT32  Line,
INT32  StartColumn,
double *  data,
INT32  Length = 1,
COMPONENT  Component = COMPONENT_Default 
) const [inline]

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

Parameters:
Line Raster line to start reading on
StartColumn Raster column to read
data Buffer to read into
Length Number of lines to read
Component Component extraction value
ERRVALUE RVC::RASTER::ReadColumn ( INT32  Line,
INT32  StartColumn,
float *  data,
INT32  Length = 1,
COMPONENT  Component = COMPONENT_Default 
) const [inline]

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

Parameters:
Line Raster line to start reading on
StartColumn Raster column to read
data Buffer to read into
Length Number of lines to read
Component Component extraction value
ERRVALUE RVC::RASTER::ReadColumn ( INT32  Line,
INT32  StartColumn,
UINT32 *  data,
INT32  Length = 1,
COMPONENT  Component = COMPONENT_Default 
) const [inline]

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

Parameters:
Line Raster line to start reading on
StartColumn Raster column to read
data Buffer to read into
Length Number of lines to read
Component Component extraction value
ERRVALUE RVC::RASTER::ReadColumn ( INT32  Line,
INT32  StartColumn,
INT32 *  data,
INT32  Length = 1,
COMPONENT  Component = COMPONENT_Default 
) const [inline]

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

Parameters:
Line Raster line to start reading on
StartColumn Raster column to read
data Buffer to read into
Length Number of lines to read
Component Component extraction value
ERRVALUE RVC::RASTER::ReadColumn ( INT32  Line,
INT32  StartColumn,
UINT16 *  data,
INT32  Length = 1,
COMPONENT  Component = COMPONENT_Default 
) const [inline]

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

Parameters:
Line Raster line to start reading on
StartColumn Raster column to read
data Buffer to read into
Length Number of lines to read
Component Component extraction value
ERRVALUE RVC::RASTER::ReadColumn ( INT32  Line,
INT32  StartColumn,
INT16 *  data,
INT32  Length = 1,
COMPONENT  Component = COMPONENT_Default 
) const [inline]

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

Parameters:
Line Raster line to start reading on
StartColumn Raster column to read
data Buffer to read into
Length Number of lines to read
Component Component extraction value
ERRVALUE RVC::RASTER::ReadColumn ( INT32  Line,
INT32  StartColumn,
UINT8 *  data,
INT32  Length = 1,
COMPONENT  Component = COMPONENT_Default 
) const [inline]

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

Parameters:
Line Raster line to start reading on
StartColumn Raster column to read
data Buffer to read into
Length Number of lines to read
Component Component extraction value
ERRVALUE RVC::RASTER::ReadColumn ( INT32  Line,
INT32  StartColumn,
INT8 *  data,
INT32  Length = 1,
COMPONENT  Component = COMPONENT_Default 
) const [inline]

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

Parameters:
Line Raster line to start reading on
StartColumn Raster column to read
data Buffer to read into
Length Number of lines to read
Component Component extraction value
ERRVALUE RVC::RASTER::ReadColumn ( INT32  Line,
INT32  StartColumn,
void *  data,
INT32  Length = 1,
CONVMODE  Convert = CONVMODE_None,
COMPONENT  Component = COMPONENT_Default 
) const

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

Parameters:
Line Raster line to start reading on
StartColumn Raster column to read
data Buffer to read into
Length Number of lines to read
Convert Data conversion mode
Component Component extraction value
ERRVALUE RVC::RASTER::SetImageScale ( const IMAGESCALE &  scale  ) 

Set the raster scale value parameters.

Parameters:
scale Scale values to set in raster
ERRVALUE RVC::RASTER::SetNullValue ( const NULLVALUE &  NullValue,
bool  NullUsed = true 
)

Set the raster null value parameters.

Parameters:
NullValue Null value to set in raster
NullUsed Whether null value is used or not
void RVC::RASTER::SetRasterHandle ( RASTERHANDLE *  RastHandle  )  [protected]
ERRVALUE RVC::RASTER::Write ( INT32  Line,
INT32  StartColumn,
const double *  data,
INT32  Length = 1,
COMPONENT  Component = COMPONENT_Default 
) [inline]

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

Parameters:
Line Raster line to write
StartColumn Raster column to start writing on
data Buffer to write from
Length Number of columns to write
Component Component extraction value
ERRVALUE RVC::RASTER::Write ( INT32  Line,
INT32  StartColumn,
const float *  data,
INT32  Length = 1,
COMPONENT  Component = COMPONENT_Default 
) [inline]

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

Parameters:
Line Raster line to write
StartColumn Raster column to start writing on
data Buffer to write from
Length Number of columns to write
Component Component extraction value
ERRVALUE RVC::RASTER::Write ( INT32  Line,
INT32  StartColumn,
const UINT32 *  data,
INT32  Length = 1,
COMPONENT  Component = COMPONENT_Default 
) [inline]

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

Parameters:
Line Raster line to write
StartColumn Raster column to start writing on
data Buffer to write from
Length Number of columns to write
Component Component extraction value
ERRVALUE RVC::RASTER::Write ( INT32  Line,
INT32  StartColumn,
const INT32 *  data,
INT32  Length = 1,
COMPONENT  Component = COMPONENT_Default 
) [inline]

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

Parameters:
Line Raster line to write
StartColumn Raster column to start writing on
data Buffer to write from
Length Number of columns to write
Component Component extraction value
ERRVALUE RVC::RASTER::Write ( INT32  Line,
INT32  StartColumn,
const UINT16 *  data,
INT32  Length = 1,
COMPONENT  Component = COMPONENT_Default 
) [inline]

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

Parameters:
Line Raster line to write
StartColumn Raster column to start writing on
data Buffer to write from
Length Number of columns to write
Component Component extraction value
ERRVALUE RVC::RASTER::Write ( INT32  Line,
INT32  StartColumn,
const INT16 *  data,
INT32  Length = 1,
COMPONENT  Component = COMPONENT_Default 
) [inline]

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

Parameters:
Line Raster line to write
StartColumn Raster column to start writing on
data Buffer to write from
Length Number of columns to write
Component Component extraction value
ERRVALUE RVC::RASTER::Write ( INT32  Line,
INT32  StartColumn,
const UINT8 *  data,
INT32  Length = 1,
COMPONENT  Component = COMPONENT_Default 
) [inline]

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

Parameters:
Line Raster line to write
StartColumn Raster column to start writing on
data Buffer to write from
Length Number of columns to write
Component Component extraction value
ERRVALUE RVC::RASTER::Write ( INT32  Line,
INT32  StartColumn,
const INT8 *  data,
INT32  Length = 1,
COMPONENT  Component = COMPONENT_Default 
) [inline]

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

Parameters:
Line Raster line to write
StartColumn Raster column to start writing on
data Buffer to write from
Length Number of columns to write
Component Component extraction value
ERRVALUE RVC::RASTER::Write ( INT32  Line,
INT32  StartColumn,
const void *  data,
INT32  Length = 1,
CONVMODE  Convert = CONVMODE_None,
COMPONENT  Component = COMPONENT_Default 
)

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

Parameters:
Line Raster line to write
StartColumn Raster column to start writing on
data Buffer to write from
Length Number of columns to write
Convert Data conversion mode
Component Component extraction value
The documentation for this class was generated from the following file:
Generated on Sun Oct 7 21:37:51 2012 for TNTsdk 2012 by  doxygen 1.6.1