GDAL
|
Public Member Functions | |
virtual CPLErr | XMLInit (CPLXMLNode *, const char *) |
virtual CPLXMLNode * | SerializeToXML (const char *pszVRTPath) |
virtual CPLErr | SetNoDataValue (double) |
Set the no data value for this band. More... | |
virtual double | GetNoDataValue (int *pbSuccess=NULL) |
Fetch the no data value for this band. More... | |
virtual CPLErr | SetColorTable (GDALColorTable *) |
Set the raster color table. More... | |
virtual GDALColorTable * | GetColorTable () |
Fetch the color table associated with band. More... | |
virtual CPLErr | SetColorInterpretation (GDALColorInterp) |
Set color interpretation of a band. More... | |
virtual GDALColorInterp | GetColorInterpretation () |
How should this band be interpreted as color? More... | |
virtual const char * | GetUnitType () |
Return raster unit type. More... | |
CPLErr | SetUnitType (const char *) |
Set unit type. More... | |
virtual char ** | GetCategoryNames () |
Fetch the list of category names for this raster. More... | |
virtual CPLErr | SetCategoryNames (char **) |
Set the category names for this band. More... | |
virtual CPLErr | SetMetadata (char **papszMD, const char *pszDomain="") |
Set metadata. More... | |
virtual CPLErr | SetMetadataItem (const char *pszName, const char *pszValue, const char *pszDomain="") |
Set single metadata item. More... | |
virtual double | GetOffset (int *pbSuccess=NULL) |
Fetch the raster value offset. More... | |
CPLErr | SetOffset (double) |
Set scaling offset. More... | |
virtual double | GetScale (int *pbSuccess=NULL) |
Fetch the raster value scale. More... | |
CPLErr | SetScale (double) |
Set scaling ratio. More... | |
virtual int | GetOverviewCount () |
Return the number of overview layers available. More... | |
virtual GDALRasterBand * | GetOverview (int) |
Fetch overview raster band object. 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... | |
CPLErr | CopyCommonInfoFrom (GDALRasterBand *) |
virtual void | GetFileList (char ***ppapszFileList, int *pnSize, int *pnMaxSize, CPLHashSet *hSetFiles) |
virtual void | SetDescription (const char *) |
Set object description. 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... | |
void | SetMaskBand (VRTRasterBand *poMaskBand) |
void | SetIsMaskBand () |
CPLErr | UnsetNoDataValue () |
virtual int | CloseDependentDatasets () |
virtual int | IsSourcedRasterBand () |
![]() | |
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... | |
virtual CPLErr | FlushCache () |
Flush raster data cache. 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 CPLErr | Fill (double dfRealValue, double dfImaginaryValue=0) |
Fill this band with a constant value. 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 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 GDALRasterAttributeTable * | GetDefaultRAT () |
Fetch default Raster Attribute Table. More... | |
virtual CPLErr | SetDefaultRAT (const GDALRasterAttributeTable *) |
Set default Raster Attribute Table. More... | |
virtual CPLVirtualMem * | GetVirtualMemAuto (GDALRWFlag eRWFlag, int *pnPixelSpace, GIntBig *pnLineSpace, char **papszOptions) |
Create a CPLVirtualMem object from a GDAL raster band object. 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 char ** | GetMetadataDomainList () |
Fetch list of metadata domains. More... | |
virtual char ** | GetMetadata (const char *pszDomain="") |
Fetch metadata. More... | |
virtual const char * | GetMetadataItem (const char *pszName, const char *pszDomain="") |
Fetch single metadata item. More... | |
Protected Member Functions | |
void | Initialize (int nXSize, int nYSize) |
![]() | |
void | InvalidateMaskBand () |
virtual CPLErr | IReadBlock (int, int, void *)=0 |
virtual CPLErr | IWriteBlock (int, int, void *) |
virtual CPLErr | IRasterIO (GDALRWFlag, int, int, int, int, void *, int, int, GDALDataType, int, int) |
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... | |
Protected Attributes | |
int | bIsMaskBand |
int | bNoDataValueSet |
int | bHideNoDataValue |
double | dfNoDataValue |
GDALColorTable * | poColorTable |
GDALColorInterp | eColorInterp |
char * | pszUnitType |
char ** | papszCategoryNames |
double | dfOffset |
double | dfScale |
CPLXMLNode * | psSavedHistograms |
std::vector< VRTOverviewInfo > | apoOverviews |
VRTRasterBand * | poMaskBand |
![]() | |
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 |
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 |
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.
|
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.
|
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 |
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.
Reimplemented in VRTSourcedRasterBand.
|
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.
|
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 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 VRTWarpedRasterBand.
|
virtual |
Return the number of overview layers available.
This method is the same as the C function GDALGetOverviewCount().
Reimplemented from GDALRasterBand.
Reimplemented in VRTWarpedRasterBand.
|
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 |
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.
|
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 object description.
The semantics of the description are specific to the derived type. For GDALDatasets it is the dataset name. For GDALRasterBands it is actually a description (if supported) or "".
Normally application code should not set the "description" for GDALDatasets. It is handled internally.
This method is the same as the C function GDALSetDescription().
Reimplemented from GDALMajorObject.
|
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.
Reimplemented in VRTSourcedRasterBand.
|
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.
Reimplemented in VRTSourcedRasterBand.
|
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 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.