GDAL
Public Member Functions | Public Attributes
VRTSourcedRasterBand Class Reference
Inheritance diagram for VRTSourcedRasterBand:
VRTRasterBand GDALRasterBand GDALMajorObject VRTDerivedRasterBand

List of all members.

Public Member Functions

 VRTSourcedRasterBand (GDALDataset *poDS, int nBand)
 VRTSourcedRasterBand (GDALDataType eType, int nXSize, int nYSize)
 VRTSourcedRasterBand (GDALDataset *poDS, int nBand, GDALDataType eType, int nXSize, int nYSize)
virtual CPLErr IRasterIO (GDALRWFlag, int, int, int, int, void *, int, int, GDALDataType, int, int)
virtual const char * GetMetadataItem (const char *pszName, const char *pszDomain="")
 Fetch single metadata item.
virtual char ** GetMetadata (const char *pszDomain="")
 Fetch metadata.
virtual CPLErr SetMetadata (char **papszMetadata, const char *pszDomain="")
 Set metadata.
virtual CPLErr SetMetadataItem (const char *pszName, const char *pszValue, const char *pszDomain="")
 Set single metadata item.
virtual CPLErr XMLInit (CPLXMLNode *, const char *)
virtual CPLXMLNodeSerializeToXML (const char *pszVRTPath)
virtual double GetMinimum (int *pbSuccess=NULL)
 Fetch the minimum value for this band.
virtual double GetMaximum (int *pbSuccess=NULL)
 Fetch the maximum value for this band.
CPLErr AddSource (VRTSource *)
CPLErr AddSimpleSource (GDALRasterBand *poSrcBand, int nSrcXOff=-1, int nSrcYOff=-1, int nSrcXSize=-1, int nSrcYSize=-1, int nDstXOff=-1, int nDstYOff=-1, int nDstXSize=-1, int nDstYSize=-1, const char *pszResampling="near", double dfNoDataValue=VRT_NODATA_UNSET)
CPLErr AddComplexSource (GDALRasterBand *poSrcBand, int nSrcXOff=-1, int nSrcYOff=-1, int nSrcXSize=-1, int nSrcYSize=-1, int nDstXOff=-1, int nDstYOff=-1, int nDstXSize=-1, int nDstYSize=-1, double dfScaleOff=0.0, double dfScaleRatio=1.0, double dfNoDataValue=VRT_NODATA_UNSET, int nColorTableComponent=0)
CPLErr AddMaskBandSource (GDALRasterBand *poSrcBand, int nSrcXOff=-1, int nSrcYOff=-1, int nSrcXSize=-1, int nSrcYSize=-1, int nDstXOff=-1, int nDstYOff=-1, int nDstXSize=-1, int nDstYSize=-1)
CPLErr AddFuncSource (VRTImageReadFunc pfnReadFunc, void *hCBData, double dfNoDataValue=VRT_NODATA_UNSET)
virtual CPLErr IReadBlock (int, int, void *)
virtual void GetFileList (char ***ppapszFileList, int *pnSize, int *pnMaxSize, CPLHashSet *hSetFiles)
virtual int CloseDependentDatasets ()
virtual int IsSourcedRasterBand ()

Public Attributes

int nSources
VRTSource ** papoSources
int bEqualAreas

Member Function Documentation

double VRTSourcedRasterBand::GetMaximum ( int *  pbSuccess = NULL) [virtual]

Fetch the maximum value for this band.

For file formats that don't know this intrinsically, the maximum supported value for the data type will generally be returned.

This method is the same as the C function GDALGetRasterMaximum().

Parameters:
pbSuccesspointer to a boolean to use to indicate if the returned value is a tight maximum or not. May be NULL (default).
Returns:
the maximum raster value (excluding no data pixels)

Reimplemented from GDALRasterBand.

References CPLAtofM(), GetMetadataItem(), GDALRasterBand::GetXSize(), and GDALRasterBand::GetYSize().

char ** VRTSourcedRasterBand::GetMetadata ( const char *  pszDomain = "") [virtual]

Fetch metadata.

The returned string list is owned by the object, and may change at any time. It is formated as a "Name=value" list with the last pointer value being NULL. Use the the CPL StringList functions such as CSLFetchNameValue() to manipulate it.

Note that relatively few formats return any metadata at this time.

This method does the same thing as the C function GDALGetMetadata().

Parameters:
pszDomainthe domain of interest. Use "" or NULL for the default domain.
Returns:
NULL or a string list.

Reimplemented from GDALMajorObject.

const char * VRTSourcedRasterBand::GetMetadataItem ( const char *  pszName,
const char *  pszDomain = "" 
) [virtual]

Fetch single metadata item.

The C function GDALGetMetadataItem() does the same thing as this method.

Parameters:
pszNamethe key for the metadata item to fetch.
pszDomainthe domain to fetch for, use NULL for the default domain.
Returns:
NULL on failure to find the key, or a pointer to an internal copy of the value string on success.

Reimplemented from GDALMajorObject.

References GDALInvGeoTransform(), GDALRasterBand::GetDataset(), GDALRasterBand::GetXSize(), and GDALRasterBand::GetYSize().

Referenced by GetMaximum(), and GetMinimum().

double VRTSourcedRasterBand::GetMinimum ( int *  pbSuccess = NULL) [virtual]

Fetch the minimum value for this band.

For file formats that don't know this intrinsically, the minimum supported value for the data type will generally be returned.

This method is the same as the C function GDALGetRasterMinimum().

Parameters:
pbSuccesspointer to a boolean to use to indicate if the returned value is a tight minimum or not. May be NULL (default).
Returns:
the minimum raster value (excluding no data pixels)

Reimplemented from GDALRasterBand.

References CPLAtofM(), GetMetadataItem(), GDALRasterBand::GetXSize(), and GDALRasterBand::GetYSize().

CPLErr VRTSourcedRasterBand::SetMetadata ( char **  papszMetadataIn,
const char *  pszDomain = "" 
) [virtual]

Set metadata.

The C function GDALSetMetadata() does the same thing as this method.

Parameters:
papszMetadataInthe metadata in name=value string list format to apply.
pszDomainthe domain of interest. Use "" or NULL for the default domain.
Returns:
CE_None on success, CE_Failure on failure and CE_Warning if the metadata has been accepted, but is likely not maintained persistently by the underlying object between sessions.

Reimplemented from VRTRasterBand.

References GDALGetDriverByName().

CPLErr VRTSourcedRasterBand::SetMetadataItem ( const char *  pszName,
const char *  pszValue,
const char *  pszDomain = "" 
) [virtual]

Set single metadata item.

The C function GDALSetMetadataItem() does the same thing as this method.

Parameters:
pszNamethe key for the metadata item to fetch.
pszValuethe value to assign to the key.
pszDomainthe domain to set within, use NULL for the default domain.
Returns:
CE_None on success, or an error code on failure.

Reimplemented from VRTRasterBand.

References GDALGetDriverByName().


The documentation for this class was generated from the following files:

Generated for GDAL by doxygen 1.7.6.1.