GDAL
|
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 CPLXMLNode * | SerializeToXML (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 () |
![]() | |
virtual CPLErr | SetNoDataValue (double) |
Set the no data value for this band. | |
virtual double | GetNoDataValue (int *pbSuccess=NULL) |
Fetch the no data value for this band. | |
virtual CPLErr | SetColorTable (GDALColorTable *) |
Set the raster color table. | |
virtual GDALColorTable * | GetColorTable () |
Fetch the color table associated with band. | |
virtual CPLErr | SetColorInterpretation (GDALColorInterp) |
Set color interpretation of a band. | |
virtual GDALColorInterp | GetColorInterpretation () |
How should this band be interpreted as color? | |
virtual const char * | GetUnitType () |
Return raster unit type. | |
CPLErr | SetUnitType (const char *) |
Set unit type. | |
virtual char ** | GetCategoryNames () |
Fetch the list of category names for this raster. | |
virtual CPLErr | SetCategoryNames (char **) |
Set the category names for this band. | |
virtual double | GetOffset (int *pbSuccess=NULL) |
Fetch the raster value offset. | |
CPLErr | SetOffset (double) |
Set scaling offset. | |
virtual double | GetScale (int *pbSuccess=NULL) |
Fetch the raster value scale. | |
CPLErr | SetScale (double) |
Set scaling ratio. | |
virtual int | GetOverviewCount () |
Return the number of overview layers available. | |
virtual GDALRasterBand * | GetOverview (int) |
Fetch overview raster band object. | |
virtual CPLErr | GetHistogram (double dfMin, double dfMax, int nBuckets, int *panHistogram, int bIncludeOutOfRange, int bApproxOK, GDALProgressFunc, void *pProgressData) |
Compute raster histogram. | |
virtual CPLErr | GetDefaultHistogram (double *pdfMin, double *pdfMax, int *pnBuckets, int **ppanHistogram, int bForce, GDALProgressFunc, void *pProgressData) |
Fetch default raster histogram. | |
virtual CPLErr | SetDefaultHistogram (double dfMin, double dfMax, int nBuckets, int *panHistogram) |
Set default histogram. | |
CPLErr | CopyCommonInfoFrom (GDALRasterBand *) |
virtual void | SetDescription (const char *) |
Set object description. | |
virtual GDALRasterBand * | GetMaskBand () |
Return the mask band associated with the band. | |
virtual int | GetMaskFlags () |
Return the status flags of the mask band associated with the band. | |
virtual CPLErr | CreateMaskBand (int nFlags) |
Adds a mask band to the current band. | |
void | SetMaskBand (VRTRasterBand *poMaskBand) |
void | SetIsMaskBand () |
CPLErr | UnsetNoDataValue () |
![]() | |
GDALRasterBand () | |
virtual | ~GDALRasterBand () |
int | GetXSize () |
Fetch XSize of raster. | |
int | GetYSize () |
Fetch YSize of raster. | |
int | GetBand () |
Fetch the band number. | |
GDALDataset * | GetDataset () |
Fetch the owning dataset handle. | |
GDALDataType | GetRasterDataType (void) |
Fetch the pixel data type for this band. | |
void | GetBlockSize (int *, int *) |
Fetch the "natural" block size of this band. | |
GDALAccess | GetAccess () |
Find out if we have update permission for this band. | |
CPLErr | RasterIO (GDALRWFlag, int, int, int, int, void *, int, int, GDALDataType, int, int) |
Read/write a region of image data for this band. | |
CPLErr | ReadBlock (int, int, void *) |
Read a block of image data efficiently. | |
CPLErr | WriteBlock (int, int, void *) |
Write a block of image data efficiently. | |
GDALRasterBlock * | GetLockedBlockRef (int nXBlockOff, int nYBlockOff, int bJustInitialize=FALSE) |
Fetch a pointer to an internally cached raster block. | |
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. | |
virtual CPLErr | FlushCache () |
Flush raster data cache. | |
virtual CPLErr | Fill (double dfRealValue, double dfImaginaryValue=0) |
Fill this band with a constant value. | |
virtual CPLErr | GetStatistics (int bApproxOK, int bForce, double *pdfMin, double *pdfMax, double *pdfMean, double *padfStdDev) |
Fetch image statistics. | |
virtual CPLErr | ComputeStatistics (int bApproxOK, double *pdfMin, double *pdfMax, double *pdfMean, double *pdfStdDev, GDALProgressFunc, void *pProgressData) |
Compute image statistics. | |
virtual CPLErr | SetStatistics (double dfMin, double dfMax, double dfMean, double dfStdDev) |
Set statistics on band. | |
virtual CPLErr | ComputeRasterMinMax (int, double *) |
Compute the min/max values for a band. | |
virtual int | HasArbitraryOverviews () |
Check for arbitrary overviews. | |
virtual GDALRasterBand * | GetRasterSampleOverview (int) |
Fetch best sampling overview. | |
virtual CPLErr | BuildOverviews (const char *, int, int *, GDALProgressFunc, void *) |
Build raster overview(s) | |
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. | |
virtual const GDALRasterAttributeTable * | GetDefaultRAT () |
Fetch default Raster Attribute Table. | |
virtual CPLErr | SetDefaultRAT (const GDALRasterAttributeTable *) |
Set default Raster Attribute Table. | |
void | ReportError (CPLErr eErrClass, int err_no, const char *fmt,...) CPL_PRINT_FUNC_FORMAT(4 |
Emits an error related to a raster band. | |
![]() | |
int | GetMOFlags () |
void | SetMOFlags (int nFlags) |
virtual const char * | GetDescription () const |
Fetch object description. |
Public Attributes | |
int | nSources |
VRTSource ** | papoSources |
int | bEqualAreas |
Additional Inherited Members | |
![]() | |
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 |
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.
References CPLAtofM(), GetMetadataItem(), GDALRasterBand::GetXSize(), and GDALRasterBand::GetYSize().
|
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.
|
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.
References GDALInvGeoTransform(), GDALRasterBand::GetDataset(), GDALRasterBand::GetXSize(), and GDALRasterBand::GetYSize().
Referenced by GetMaximum(), and GetMinimum().
|
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.
References CPLAtofM(), GetMetadataItem(), GDALRasterBand::GetXSize(), and GDALRasterBand::GetYSize().
|
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 VRTRasterBand.
References GDALGetDriverByName().
|
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 VRTRasterBand.
References GDALGetDriverByName().