GDALProxyPoolRasterBand Class Reference
Public Member Functions | |
| GDALProxyPoolRasterBand (GDALProxyPoolDataset *poDS, int nBand, GDALDataType eDataType, int nBlockXSize, int nBlockYSize) | |
| GDALProxyPoolRasterBand (GDALProxyPoolDataset *poDS, GDALRasterBand *poUnderlyingRasterBand) | |
| virtual char ** | GetMetadata (const char *pszDomain) |
| virtual const char * | GetMetadataItem (const char *pszName, const char *pszDomain) |
| virtual char ** | GetCategoryNames () |
| virtual const char * | GetUnitType () |
| virtual GDALColorTable * | GetColorTable () |
| virtual GDALRasterBand * | GetOverview (int) |
| virtual GDALRasterBand * | GetRasterSampleOverview (int nDesiredSamples) |
| virtual GDALRasterBand * | GetMaskBand () |
Protected Member Functions | |
| virtual GDALRasterBand * | RefUnderlyingRasterBand () |
| virtual void | UnrefUnderlyingRasterBand (GDALRasterBand *poUnderlyingRasterBand) |
Friends | |
| class | GDALProxyPoolOverviewRasterBand |
| class | GDALProxyPoolMaskBand |
Member Function Documentation
| 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.
- Returns:
- list of names, or NULL if none.
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().
- Returns:
- internal color table, or NULL.
Reimplemented from GDALProxyRasterBand.
References GDALColorTable::Clone(), and GDALRasterBand::GetColorTable().
| 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().
- Parameters:
-
pszDomain the domain of interest. Use "" or NULL for the default domain.
- Returns:
- NULL or a string list.
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.
- Parameters:
-
pszName the key for the metadata item to fetch. pszDomain the 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 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().
- Parameters:
-
i overview index between 0 and GetOverviewCount()-1.
- Returns:
- overview GDALRasterBand.
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().
- Parameters:
-
nDesiredSamples the returned band will have at least this many pixels.
- Returns:
- optimal overview or the band itself.
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().
- Returns:
- unit name string.
Reimplemented from GDALProxyRasterBand.
References GDALRasterBand::GetUnitType().
The documentation for this class was generated from the following files:
- gdal_proxy.h
- gdalproxypool.cpp
