GDAL
|
Public Member Functions | |
virtual char ** | GetMetadataDomainList () |
Fetch list of metadata domains. More... | |
virtual char ** | GetMetadata (const char *pszDomain) |
Fetch metadata. More... | |
virtual CPLErr | SetMetadata (char **papszMetadata, const char *pszDomain) |
Set metadata. More... | |
virtual const char * | GetMetadataItem (const char *pszName, const char *pszDomain) |
Fetch single metadata item. More... | |
virtual CPLErr | SetMetadataItem (const char *pszName, const char *pszValue, const char *pszDomain) |
Set single metadata item. More... | |
virtual CPLErr | FlushCache () |
Flush raster data cache. More... | |
virtual char ** | GetCategoryNames () |
Fetch the list of category names for this raster. More... | |
virtual double | GetNoDataValue (int *pbSuccess=NULL) |
Fetch the no data value for this band. More... | |
virtual double | GetMinimum (int *pbSuccess=NULL) |
Fetch the minimum value for this band. More... | |
virtual double | GetMaximum (int *pbSuccess=NULL) |
Fetch the maximum value for this band. More... | |
virtual double | GetOffset (int *pbSuccess=NULL) |
Fetch the raster value offset. More... | |
virtual double | GetScale (int *pbSuccess=NULL) |
Fetch the raster value scale. More... | |
virtual const char * | GetUnitType () |
Return raster unit type. More... | |
virtual GDALColorInterp | GetColorInterpretation () |
How should this band be interpreted as color? More... | |
virtual GDALColorTable * | GetColorTable () |
Fetch the color table associated with band. More... | |
virtual CPLErr | Fill (double dfRealValue, double dfImaginaryValue=0) |
Fill this band with a constant value. More... | |
virtual CPLErr | SetCategoryNames (char **) |
Set the category names for this band. More... | |
virtual CPLErr | SetNoDataValue (double) |
Set the no data value for this band. More... | |
virtual CPLErr | SetColorTable (GDALColorTable *) |
Set the raster color table. More... | |
virtual CPLErr | SetColorInterpretation (GDALColorInterp) |
Set color interpretation of a band. More... | |
virtual CPLErr | SetOffset (double) |
Set scaling offset. More... | |
virtual CPLErr | SetScale (double) |
Set scaling ratio. More... | |
virtual CPLErr | SetUnitType (const char *) |
Set unit type. More... | |
virtual CPLErr | GetStatistics (int bApproxOK, int bForce, double *pdfMin, double *pdfMax, double *pdfMean, double *padfStdDev) |
Fetch image statistics. More... | |
virtual CPLErr | ComputeStatistics (int bApproxOK, double *pdfMin, double *pdfMax, double *pdfMean, double *pdfStdDev, GDALProgressFunc, void *pProgressData) |
Compute image statistics. More... | |
virtual CPLErr | SetStatistics (double dfMin, double dfMax, double dfMean, double dfStdDev) |
Set statistics on band. More... | |
virtual CPLErr | ComputeRasterMinMax (int, double *) |
Compute the min/max values for a band. More... | |
virtual int | HasArbitraryOverviews () |
Check for arbitrary overviews. More... | |
virtual int | GetOverviewCount () |
Return the number of overview layers available. More... | |
virtual GDALRasterBand * | GetOverview (int) |
Fetch overview raster band object. More... | |
virtual GDALRasterBand * | GetRasterSampleOverview (int) |
Fetch best sampling overview. More... | |
virtual CPLErr | BuildOverviews (const char *, int, int *, GDALProgressFunc, void *) |
Build raster overview(s) More... | |
virtual CPLErr | AdviseRead (int nXOff, int nYOff, int nXSize, int nYSize, int nBufXSize, int nBufYSize, GDALDataType eDT, char **papszOptions) |
Advise driver of upcoming read requests. More... | |
virtual CPLErr | GetHistogram (double dfMin, double dfMax, int nBuckets, int *panHistogram, int bIncludeOutOfRange, int bApproxOK, GDALProgressFunc, void *pProgressData) |
Compute raster histogram. More... | |
virtual CPLErr | GetDefaultHistogram (double *pdfMin, double *pdfMax, int *pnBuckets, int **ppanHistogram, int bForce, GDALProgressFunc, void *pProgressData) |
Fetch default raster histogram. More... | |
virtual CPLErr | SetDefaultHistogram (double dfMin, double dfMax, int nBuckets, int *panHistogram) |
Set default histogram. More... | |
virtual GDALRasterAttributeTable * | GetDefaultRAT () |
Fetch default Raster Attribute Table. More... | |
virtual CPLErr | SetDefaultRAT (const GDALRasterAttributeTable *) |
Set default Raster Attribute Table. More... | |
virtual GDALRasterBand * | GetMaskBand () |
Return the mask band associated with the band. More... | |
virtual int | GetMaskFlags () |
Return the status flags of the mask band associated with the band. More... | |
virtual CPLErr | CreateMaskBand (int nFlags) |
Adds a mask band to the current band. More... | |
virtual CPLVirtualMem * | GetVirtualMemAuto (GDALRWFlag eRWFlag, int *pnPixelSpace, GIntBig *pnLineSpace, char **papszOptions) |
Create a CPLVirtualMem object from a GDAL raster band object. More... | |
![]() | |
GDALRasterBand () | |
virtual | ~GDALRasterBand () |
int | GetXSize () |
Fetch XSize of raster. More... | |
int | GetYSize () |
Fetch YSize of raster. More... | |
int | GetBand () |
Fetch the band number. More... | |
GDALDataset * | GetDataset () |
Fetch the owning dataset handle. More... | |
GDALDataType | GetRasterDataType (void) |
Fetch the pixel data type for this band. More... | |
void | GetBlockSize (int *, int *) |
Fetch the "natural" block size of this band. More... | |
GDALAccess | GetAccess () |
Find out if we have update permission for this band. More... | |
CPLErr | RasterIO (GDALRWFlag, int, int, int, int, void *, int, int, GDALDataType, int, int) |
Read/write a region of image data for this band. More... | |
CPLErr | ReadBlock (int, int, void *) |
Read a block of image data efficiently. More... | |
CPLErr | WriteBlock (int, int, void *) |
Write a block of image data efficiently. More... | |
GDALRasterBlock * | GetLockedBlockRef (int nXBlockOff, int nYBlockOff, int bJustInitialize=FALSE) |
Fetch a pointer to an internally cached raster block. More... | |
CPLErr | FlushBlock (int=-1, int=-1, int bWriteDirtyBlock=TRUE) |
unsigned char * | GetIndexColorTranslationTo (GDALRasterBand *poReferenceBand, unsigned char *pTranslationTable=NULL, int *pApproximateMatching=NULL) |
Compute translation table for color tables. More... | |
void | ReportError (CPLErr eErrClass, int err_no, const char *fmt,...) CPL_PRINT_FUNC_FORMAT(4 |
Emits an error related to a raster band. More... | |
![]() | |
int | GetMOFlags () |
void | SetMOFlags (int nFlags) |
virtual const char * | GetDescription () const |
Fetch object description. More... | |
virtual void | SetDescription (const char *) |
Set object description. More... | |
Protected Member Functions | |
virtual GDALRasterBand * | RefUnderlyingRasterBand ()=0 |
virtual void | UnrefUnderlyingRasterBand (GDALRasterBand *poUnderlyingRasterBand) |
virtual CPLErr | IReadBlock (int, int, void *) |
virtual CPLErr | IWriteBlock (int, int, void *) |
virtual CPLErr | IRasterIO (GDALRWFlag, int, int, int, int, void *, int, int, GDALDataType, int, int) |
![]() | |
void | InvalidateMaskBand () |
CPLErr | OverviewRasterIO (GDALRWFlag, int, int, int, int, void *, int, int, GDALDataType, int, int) |
int | InitBlockInfo () |
CPLErr | AdoptBlock (int, int, GDALRasterBlock *) |
GDALRasterBlock * | TryGetLockedBlockRef (int nXBlockOff, int nYBlockYOff) |
Try fetching block ref. More... | |
![]() | |
char ** | BuildMetadataDomainList (char **papszList, int bCheckNonEmpty,...) CPL_NULL_TERMINATED |
Helper function for custom implementations of GetMetadataDomainList() More... | |
Additional Inherited Members | |
![]() | |
GDALDataset * | poDS |
int | nBand |
int | nRasterXSize |
int | nRasterYSize |
GDALDataType | eDataType |
GDALAccess | eAccess |
int | nBlockXSize |
int | nBlockYSize |
int | nBlocksPerRow |
int | nBlocksPerColumn |
int | bSubBlockingActive |
int | nSubBlocksPerRow |
int | nSubBlocksPerColumn |
GDALRasterBlock ** | papoBlocks |
int | nBlockReads |
int | bForceCachedIO |
GDALRasterBand * | poMask |
bool | bOwnMask |
int | nMaskFlags |
![]() | |
int | nFlags |
CPLString | sDescription |
GDALMultiDomainMetadata | oMDMD |
|
virtual |
Advise driver of upcoming read requests.
Some GDAL drivers operate more efficiently if they know in advance what set of upcoming read requests will be made. The AdviseRead() method allows an application to notify the driver of the region of interest, and at what resolution the region will be read.
Many drivers just ignore the AdviseRead() call, but it can dramatically accelerate access via some drivers.
nXOff | The pixel offset to the top left corner of the region of the band to be accessed. This would be zero to start from the left side. |
nYOff | The line offset to the top left corner of the region of the band to be accessed. This would be zero to start from the top. |
nXSize | The width of the region of the band to be accessed in pixels. |
nYSize | The height of the region of the band to be accessed in lines. |
nBufXSize | the width of the buffer image into which the desired region is to be read, or from which it is to be written. |
nBufYSize | the height of the buffer image into which the desired region is to be read, or from which it is to be written. |
eBufType | the type of the pixel values in the pData data buffer. The pixel values will automatically be translated to/from the GDALRasterBand data type as needed. |
papszOptions | a list of name=value strings with special control options. Normally this is NULL. |
Reimplemented from GDALRasterBand.
|
virtual |
Build raster overview(s)
If the operation is unsupported for the indicated dataset, then CE_Failure is returned, and CPLGetLastErrorNo() will return CPLE_NotSupported.
WARNING: It is not possible to build overviews for a single band in TIFF format, and thus this method does not work for TIFF format, or any formats that use the default overview building in TIFF format. Instead it is necessary to build overviews on the dataset as a whole using GDALDataset::BuildOverviews(). That makes this method pretty useless from a practical point of view.
pszResampling | one of "NEAREST", "GAUSS", "CUBIC", "AVERAGE", "MODE", "AVERAGE_MAGPHASE" or "NONE" controlling the downsampling method applied. |
nOverviews | number of overviews to build. |
panOverviewList | the list of overview decimation factors to build. |
pfnProgress | a function to call to report progress, or NULL. |
pProgressData | application data to pass to the progress function. |
Reimplemented from GDALRasterBand.
|
virtual |
Compute the min/max values for a band.
If approximate is OK, then the band's GetMinimum()/GetMaximum() will be trusted. If it doesn't work, a subsample of blocks will be read to get an approximate min/max. If the band has a nodata value it will be excluded from the minimum and maximum.
If bApprox is FALSE, then all pixels will be read and used to compute an exact range.
This method is the same as the C function GDALComputeRasterMinMax().
bApproxOK | TRUE if an approximate (faster) answer is OK, otherwise FALSE. |
adfMinMax | the array in which the minimum (adfMinMax[0]) and the maximum (adfMinMax[1]) are returned. |
Reimplemented from GDALRasterBand.
|
virtual |
Compute image statistics.
Returns the minimum, maximum, mean and standard deviation of all pixel values in this band. If approximate statistics are sufficient, the bApproxOK flag can be set to true in which case overviews, or a subset of image tiles may be used in computing the statistics.
Once computed, the statistics will generally be "set" back on the raster band using SetStatistics().
This method is the same as the C function GDALComputeRasterStatistics().
bApproxOK | If TRUE statistics may be computed based on overviews or a subset of all tiles. |
pdfMin | Location into which to load image minimum (may be NULL). |
pdfMax | Location into which to load image maximum (may be NULL).- |
pdfMean | Location into which to load image mean (may be NULL). |
pdfStdDev | Location into which to load image standard deviation (may be NULL). |
pfnProgress | a function to call to report progress, or NULL. |
pProgressData | application data to pass to the progress function. |
Reimplemented from GDALRasterBand.
|
virtual |
Adds a mask band to the current band.
The default implementation of the CreateMaskBand() method is implemented based on similar rules to the .ovr handling implemented using the GDALDefaultOverviews object. A TIFF file with the extension .msk will be created with the same basename as the original file, and it will have as many bands as the original image (or just one for GMF_PER_DATASET). The mask images will be deflate compressed tiled images with the same block size as the original image if possible.
Note that if you got a mask band with a previous call to GetMaskBand(), it might be invalidated by CreateMaskBand(). So you have to call GetMaskBand() again.
This method is the same as the C function GDALCreateMaskBand().
Reimplemented from GDALRasterBand.
|
virtual |
Fill this band with a constant value.
GDAL makes no guarantees about what values pixels in newly created files are set to, so this method can be used to clear a band to a specified "default" value. The fill value is passed in as a double but this will be converted to the underlying type before writing to the file. An optional second argument allows the imaginary component of a complex constant value to be specified.
This method is the same as the C function GDALFillRaster().
dfRealValue | Real component of fill value |
dfImaginaryValue | Imaginary component of fill value, defaults to zero |
Reimplemented from GDALRasterBand.
|
virtual |
Flush raster data cache.
This call will recover memory used to cache data blocks for this raster band, and ensure that new requests are referred to the underlying driver.
This method is the same as the C function GDALFlushRasterCache().
Reimplemented from GDALRasterBand.
|
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.
This method is the same as the C function GDALGetRasterCategoryNames().
Reimplemented from GDALRasterBand.
Reimplemented in GDALProxyPoolRasterBand.
|
virtual |
How should this band be interpreted as color?
GCI_Undefined is returned when the format doesn't know anything about the color interpretation.
This method is the same as the C function GDALGetRasterColorInterpretation().
Reimplemented from GDALRasterBand.
|
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 GDALRasterBand.
Reimplemented in GDALProxyPoolRasterBand.
|
virtual |
Fetch default raster histogram.
The default method in GDALRasterBand will compute a default histogram. This method is overriden by derived classes (such as GDALPamRasterBand, VRTDataset, HFADataset...) that may be able to fetch efficiently an already stored histogram.
This method is the same as the C function GDALGetDefaultHistogram().
pdfMin | pointer to double value that will contain the lower bound of the histogram. |
pdfMax | pointer to double value that will contain the upper bound of the histogram. |
pnBuckets | pointer to int value that will contain the number of buckets in *ppanHistogram. |
ppanHistogram | pointer to array into which the histogram totals are placed. To be freed with VSIFree |
bForce | TRUE to force the computation. If FALSE and no default histogram is available, the method will return CE_Warning |
pfnProgress | function to report progress to completion. |
pProgressData | application data to pass to pfnProgress. |
Reimplemented from GDALRasterBand.
|
virtual |
Fetch default Raster Attribute Table.
A RAT will be returned if there is a default one associated with the band, otherwise NULL is returned. The returned RAT is owned by the band and should not be deleted by the application.
This method is the same as the C function GDALGetDefaultRAT().
Reimplemented from GDALRasterBand.
|
virtual |
Compute raster histogram.
Note that the bucket size is (dfMax-dfMin) / nBuckets.
For example to compute a simple 256 entry histogram of eight bit data, the following would be suitable. The unusual bounds are to ensure that bucket boundaries don't fall right on integer values causing possible errors due to rounding after scaling.
int anHistogram[256];
poBand->GetHistogram( -0.5, 255.5, 256, anHistogram, FALSE, FALSE, GDALDummyProgress, NULL );
Note that setting bApproxOK will generally result in a subsampling of the file, and will utilize overviews if available. It should generally produce a representative histogram for the data that is suitable for use in generating histogram based luts for instance. Generally bApproxOK is much faster than an exactly computed histogram.
This method is the same as the C function GDALGetRasterHistogram().
dfMin | the lower bound of the histogram. |
dfMax | the upper bound of the histogram. |
nBuckets | the number of buckets in panHistogram. |
panHistogram | array into which the histogram totals are placed. |
bIncludeOutOfRange | if TRUE values below the histogram range will mapped into panHistogram[0], and values above will be mapped into panHistogram[nBuckets-1] otherwise out of range values are discarded. |
bApproxOK | TRUE if an approximate, or incomplete histogram OK. |
pfnProgress | function to report progress to completion. |
pProgressData | application data to pass to pfnProgress. |
Reimplemented from GDALRasterBand.
|
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 :
Note that the GetMaskBand() should always return a GDALRasterBand mask, even if it is only an all 255 mask with the flags indicating GMF_ALL_VALID.
This method is the same as the C function GDALGetMaskBand().
Reimplemented from GDALRasterBand.
Reimplemented in GDALProxyPoolRasterBand.
|
virtual |
Return the status flags of the mask band associated with the band.
The GetMaskFlags() method returns an bitwise OR-ed set of status flags with the following available definitions that may be extended in the future:
The GDALRasterBand class includes a default implementation of GetMaskBand() that returns one of four default implementations :
This method is the same as the C function GDALGetMaskFlags().
Reimplemented from GDALRasterBand.
|
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().
pbSuccess | pointer to a boolean to use to indicate if the returned value is a tight maximum or not. May be NULL (default). |
Reimplemented from GDALRasterBand.
|
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 GDALMajorObject.
Reimplemented in GDALProxyPoolRasterBand.
|
virtual |
Fetch list of metadata domains.
The returned string list is the list of (non-empty) metadata domains.
This method does the same thing as the C function GDALGetMetadataDomainList().
Reimplemented from GDALMajorObject.
|
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. |
pszDomain | the domain to fetch for, use NULL for the default domain. |
Reimplemented from GDALMajorObject.
Reimplemented in GDALProxyPoolRasterBand.
|
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().
pbSuccess | pointer to a boolean to use to indicate if the returned value is a tight minimum or not. May be NULL (default). |
Reimplemented from GDALRasterBand.
|
virtual |
Fetch the no data value for this band.
If there is no out of data value, an out of range value will generally be returned. The no data value for a band is generally a special marker value used to mark pixels that are not valid data. Such pixels should generally not be displayed, nor contribute to analysis operations.
This method is the same as the C function GDALGetRasterNoDataValue().
pbSuccess | pointer to a boolean to use to indicate if a value is actually associated with this layer. May be NULL (default). |
Reimplemented from GDALRasterBand.
|
virtual |
Fetch the raster value offset.
This value (in combination with the GetScale() value) is used to transform raw pixel values into the units returned by GetUnits(). For example this might be used to store elevations in GUInt16 bands with a precision of 0.1, and starting from -100.
Units value = (raw value * scale) + offset
For file formats that don't know this intrinsically a value of zero is returned.
This method is the same as the C function GDALGetRasterOffset().
pbSuccess | pointer to a boolean to use to indicate if the returned value is meaningful or not. May be NULL (default). |
Reimplemented from GDALRasterBand.
|
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 GDALRasterBand.
Reimplemented in GDALProxyPoolRasterBand.
|
virtual |
Return the number of overview layers available.
This method is the same as the C function GDALGetOverviewCount().
Reimplemented from GDALRasterBand.
|
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 GDALRasterBand.
Reimplemented in GDALProxyPoolRasterBand.
|
virtual |
Fetch the raster value scale.
This value (in combination with the GetOffset() value) is used to transform raw pixel values into the units returned by GetUnits(). For example this might be used to store elevations in GUInt16 bands with a precision of 0.1, and starting from -100.
Units value = (raw value * scale) + offset
For file formats that don't know this intrinsically a value of one is returned.
This method is the same as the C function GDALGetRasterScale().
pbSuccess | pointer to a boolean to use to indicate if the returned value is meaningful or not. May be NULL (default). |
Reimplemented from GDALRasterBand.
|
virtual |
Fetch image statistics.
Returns the minimum, maximum, mean and standard deviation of all pixel values in this band. If approximate statistics are sufficient, the bApproxOK flag can be set to true in which case overviews, or a subset of image tiles may be used in computing the statistics.
If bForce is FALSE results will only be returned if it can be done quickly (ie. without scanning the data). If bForce is FALSE and results cannot be returned efficiently, the method will return CE_Warning but no warning will have been issued. This is a non-standard use of the CE_Warning return value to indicate "nothing done".
Note that file formats using PAM (Persistent Auxilary Metadata) services will generally cache statistics in the .pam file allowing fast fetch after the first request.
This method is the same as the C function GDALGetRasterStatistics().
bApproxOK | If TRUE statistics may be computed based on overviews or a subset of all tiles. |
bForce | If FALSE statistics will only be returned if it can be done without rescanning the image. |
pdfMin | Location into which to load image minimum (may be NULL). |
pdfMax | Location into which to load image maximum (may be NULL).- |
pdfMean | Location into which to load image mean (may be NULL). |
pdfStdDev | Location into which to load image standard deviation (may be NULL). |
Reimplemented from GDALRasterBand.
|
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 GDALRasterBand.
Reimplemented in GDALProxyPoolRasterBand.
|
virtual |
Create a CPLVirtualMem object from a GDAL raster band object.
Only supported on Linux for now.
This method allows creating a virtual memory object for a GDALRasterBand, that exposes the whole image data as a virtual array.
The default implementation relies on GDALRasterBandGetVirtualMem(), but specialized implementation, such as for raw files, may also directly use mechanisms of the operating system to create a view of the underlying file into virtual memory ( CPLVirtualMemFileMapNew() )
At the time of writing, the GeoTIFF driver and "raw" drivers (EHdr, ...) offer a specialized implementation with direct file mapping, provided that some requirements are met :
The pointer returned remains valid until CPLVirtualMemFree() is called. CPLVirtualMemFree() must be called before the raster band object is destroyed.
If p is such a pointer and base_type the type matching GDALGetRasterDataType(), the element of image coordinates (x, y) can be accessed with *(base_type*) ((GByte*)p + x * *pnPixelSpace + y * *pnLineSpace)
This method is the same as the C GDALGetVirtualMemAuto() function.
eRWFlag | Either GF_Read to read the band, or GF_Write to read/write the band. |
pnPixelSpace | Output parameter giving the byte offset from the start of one pixel value in the buffer to the start of the next pixel value within a scanline. |
pnLineSpace | Output parameter giving the byte offset from the start of one scanline in the buffer to the start of the next. |
papszOptions | NULL terminated list of options. If a specialized implementation exists, defining USE_DEFAULT_IMPLEMENTATION=YES will cause the default implementation to be used. When requiring or falling back to the default implementation, the following options are available : CACHE_SIZE (in bytes, defaults to 40 MB), PAGE_SIZE_HINT (in bytes), SINGLE_THREAD ("FALSE" / "TRUE", defaults to FALSE) |
Reimplemented from GDALRasterBand.
|
virtual |
Check for arbitrary overviews.
This returns TRUE if the underlying datastore can compute arbitrary overviews efficiently, such as is the case with OGDI over a network. Datastores with arbitrary overviews don't generally have any fixed overviews, but the RasterIO() method can be used in downsampling mode to get overview data efficiently.
This method is the same as the C function GDALHasArbitraryOverviews(),
Reimplemented from GDALRasterBand.
|
virtual |
Set the category names for this band.
See the GetCategoryNames() method for more on the interpretation of category names.
This method is the same as the C function GDALSetRasterCategoryNames().
papszNames | the NULL terminated StringList of category names. May be NULL to just clear the existing list. |
Reimplemented from GDALRasterBand.
|
virtual |
Set color interpretation of a band.
This method is the same as the C function GDALSetRasterColorInterpretation().
eColorInterp | the new color interpretation to apply to this band. |
Reimplemented from GDALRasterBand.
|
virtual |
Set the raster color table.
The driver will make a copy of all desired data in the colortable. It remains owned by the caller after the call.
This method is the same as the C function GDALSetRasterColorTable().
poCT | the color table to apply. This may be NULL to clear the color table (where supported). |
Reimplemented from GDALRasterBand.
|
virtual |
Set default histogram.
This method is the same as the C function GDALSetDefaultHistogram().
Reimplemented from GDALRasterBand.
|
virtual |
Set default Raster Attribute Table.
Associates a default RAT with the band. If not implemented for the format a CPLE_NotSupported error will be issued. If successful a copy of the RAT is made, the original remains owned by the caller.
This method is the same as the C function GDALSetDefaultRAT().
poRAT | the RAT to assign to the band. |
Reimplemented from GDALRasterBand.
|
virtual |
Set metadata.
The C function GDALSetMetadata() does the same thing as this method.
papszMetadataIn | the metadata in name=value string list format to apply. |
pszDomain | the domain of interest. Use "" or NULL for the default domain. |
Reimplemented from GDALMajorObject.
|
virtual |
Set single metadata item.
The C function GDALSetMetadataItem() does the same thing as this method.
pszName | the key for the metadata item to fetch. |
pszValue | the value to assign to the key. |
pszDomain | the domain to set within, use NULL for the default domain. |
Reimplemented from GDALMajorObject.
|
virtual |
Set the no data value for this band.
To clear the nodata value, just set it with an "out of range" value. Complex band no data values must have an imagery component of zero.
This method is the same as the C function GDALSetRasterNoDataValue().
dfNoData | the value to set. |
Reimplemented from GDALRasterBand.
|
virtual |
Set scaling offset.
Very few formats implement this method. When not implemented it will issue a CPLE_NotSupported error and return CE_Failure.
This method is the same as the C function GDALSetRasterOffset().
dfNewOffset | the new offset. |
Reimplemented from GDALRasterBand.
|
virtual |
Set scaling ratio.
Very few formats implement this method. When not implemented it will issue a CPLE_NotSupported error and return CE_Failure.
This method is the same as the C function GDALSetRasterScale().
dfNewScale | the new scale. |
Reimplemented from GDALRasterBand.
|
virtual |
Set statistics on band.
This method can be used to store min/max/mean/standard deviation statistics on a raster band.
The default implementation stores them as metadata, and will only work on formats that can save arbitrary metadata. This method cannot detect whether metadata will be properly saved and so may return CE_None even if the statistics will never be saved.
This method is the same as the C function GDALSetRasterStatistics().
dfMin | minimum pixel value. |
dfMax | maximum pixel value. |
dfMean | mean (average) of all pixel values. |
dfStdDev | Standard deviation of all pixel values. |
Reimplemented from GDALRasterBand.
|
virtual |
Set unit type.
Set the unit type for a raster band. Values should be one of "" (the default indicating it is unknown), "m" indicating meters, or "ft" indicating feet, though other nonstandard values are allowed.
This method is the same as the C function GDALSetRasterUnitType().
pszNewValue | the new unit type value. |
Reimplemented from GDALRasterBand.