Public Member Functions | |
GDALProxyPoolRasterBand (GDALProxyPoolDataset *poDS, int nBand, GDALDataType eDataType, int nBlockXSize, int nBlockYSize) | |
GDALProxyPoolRasterBand (GDALProxyPoolDataset *poDS, GDALRasterBand *poUnderlyingRasterBand) | |
void | AddSrcMaskBandDescription (GDALDataType eDataType, int nBlockXSize, int nBlockYSize) |
virtual char ** | GetMetadata (const char *pszDomain) |
Fetch metadata. | |
virtual const char * | GetMetadataItem (const char *pszName, const char *pszDomain) |
Fetch single metadata item. | |
virtual char ** | GetCategoryNames () |
Fetch the list of category names for this raster. | |
virtual const char * | GetUnitType () |
Return raster unit type. | |
virtual GDALColorTable * | GetColorTable () |
Fetch the color table associated with band. | |
virtual GDALRasterBand * | GetOverview (int) |
Fetch overview raster band object. | |
virtual GDALRasterBand * | GetRasterSampleOverview (int nDesiredSamples) |
Fetch best sampling overview. | |
virtual GDALRasterBand * | GetMaskBand () |
Return the mask band associated with the band. | |
Protected Member Functions | |
virtual GDALRasterBand * | RefUnderlyingRasterBand () |
virtual void | UnrefUnderlyingRasterBand (GDALRasterBand *poUnderlyingRasterBand) |
Friends | |
class | GDALProxyPoolOverviewRasterBand |
class | GDALProxyPoolMaskBand |
char ** GDALProxyPoolRasterBand::GetCategoryNames | ( | ) | [virtual] |
Fetch the list of category names for this raster.
The return list is a "StringList" in the sense of the CPL functions. That is a NULL terminated array of strings. Raster values without associated names will have an empty string in the returned list. The first entry in the list is for raster values of zero, and so on.
The returned stringlist should not be altered or freed by the application. It may change on the next GDAL call, so please copy it if it is needed for any period of time.
Reimplemented from GDALProxyRasterBand.
References GDALRasterBand::GetCategoryNames().
GDALColorTable * GDALProxyPoolRasterBand::GetColorTable | ( | ) | [virtual] |
Fetch the color table associated with band.
If there is no associated color table, the return result is NULL. The returned color table remains owned by the GDALRasterBand, and can't be depended on for long, nor should it ever be modified by the caller.
This method is the same as the C function GDALGetRasterColorTable().
Reimplemented from GDALProxyRasterBand.
References GDALColorTable::Clone(), and GDALRasterBand::GetColorTable().
GDALRasterBand * GDALProxyPoolRasterBand::GetMaskBand | ( | ) | [virtual] |
Return the mask band associated with the band.
The GDALRasterBand class includes a default implementation of GetMaskBand() that returns one of four default implementations :
If a corresponding .msk file exists it will be used for the mask band. If the dataset has a NODATA_VALUES metadata item, an instance of the new GDALNoDataValuesMaskBand class will be returned. GetMaskFlags() will return GMF_NODATA | GMF_PER_DATASET.
Reimplemented from GDALProxyRasterBand.
References GDALRasterBand::GetMaskBand().
char ** GDALProxyPoolRasterBand::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().
pszDomain | the domain of interest. Use "" or NULL for the default domain. |
Reimplemented from GDALProxyRasterBand.
References GDALMajorObject::GetMetadata().
const char * GDALProxyPoolRasterBand::GetMetadataItem | ( | const char * | pszName, | |
const char * | pszDomain | |||
) | [virtual] |
Fetch single metadata item.
The C function GDALGetMetadataItem() does the same thing as this method.
pszName | the key for the metadata item to fetch.
|
Reimplemented from GDALProxyRasterBand.
References GDALMajorObject::GetMetadataItem().
GDALRasterBand * GDALProxyPoolRasterBand::GetOverview | ( | int | i | ) | [virtual] |
Fetch overview raster band object.
This method is the same as the C function GDALGetOverview().
i | overview index between 0 and GetOverviewCount()-1. |
Reimplemented from GDALProxyRasterBand.
References GDALRasterBand::GetOverview().
GDALRasterBand * GDALProxyPoolRasterBand::GetRasterSampleOverview | ( | int | nDesiredSamples | ) | [virtual] |
Fetch best sampling overview.
Returns the most reduced overview of the given band that still satisfies the desired number of samples. This function can be used with zero as the number of desired samples to fetch the most reduced overview. The same band as was passed in will be returned if it has not overviews, or if none of the overviews have enough samples.
This method is the same as the C function GDALGetRasterSampleOverview().
nDesiredSamples | the returned band will have at least this many pixels. |
Reimplemented from GDALProxyRasterBand.
const char * GDALProxyPoolRasterBand::GetUnitType | ( | ) | [virtual] |
Return raster unit type.
Return a name for the units of this raster's values. For instance, it might be "m" for an elevation model in meters, or "ft" for feet. If no units are available, a value of "" will be returned. The returned string should not be modified, nor freed by the calling application.
This method is the same as the C function GDALGetRasterUnitType().
Reimplemented from GDALProxyRasterBand.
References GDALRasterBand::GetUnitType().