GDAL
Public Member Functions | Friends
GDALGeneric3x3RasterBand Class Reference
Inheritance diagram for GDALGeneric3x3RasterBand:
GDALRasterBand GDALMajorObject

List of all members.

Public Member Functions

 GDALGeneric3x3RasterBand (GDALGeneric3x3Dataset *poDS, GDALDataType eDstDataType)
virtual CPLErr IReadBlock (int, int, void *)
virtual double GetNoDataValue (int *pbHasNoData)
 Fetch the no data value for this band.
- Public Member Functions inherited from GDALRasterBand
 GDALRasterBand ()
virtual ~GDALRasterBand ()
int GetXSize ()
 Fetch XSize of raster.
int GetYSize ()
 Fetch YSize of raster.
int GetBand ()
 Fetch the band number.
GDALDatasetGetDataset ()
 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.
GDALRasterBlockGetLockedBlockRef (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 char ** GetCategoryNames ()
 Fetch the list of category names for this raster.
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.
virtual double GetOffset (int *pbSuccess=NULL)
 Fetch the raster value offset.
virtual double GetScale (int *pbSuccess=NULL)
 Fetch the raster value scale.
virtual const char * GetUnitType ()
 Return raster unit type.
virtual GDALColorInterp GetColorInterpretation ()
 How should this band be interpreted as color?
virtual GDALColorTableGetColorTable ()
 Fetch the color table associated with band.
virtual CPLErr Fill (double dfRealValue, double dfImaginaryValue=0)
 Fill this band with a constant value.
virtual CPLErr SetCategoryNames (char **)
 Set the category names for this band.
virtual CPLErr SetNoDataValue (double)
 Set the no data value for this band.
virtual CPLErr SetColorTable (GDALColorTable *)
 Set the raster color table.
virtual CPLErr SetColorInterpretation (GDALColorInterp)
 Set color interpretation of a band.
virtual CPLErr SetOffset (double)
 Set scaling offset.
virtual CPLErr SetScale (double)
 Set scaling ratio.
virtual CPLErr SetUnitType (const char *)
 Set unit type.
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 int GetOverviewCount ()
 Return the number of overview layers available.
virtual GDALRasterBandGetOverview (int)
 Fetch overview raster band object.
virtual GDALRasterBandGetRasterSampleOverview (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 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.
virtual const
GDALRasterAttributeTable
GetDefaultRAT ()
 Fetch default Raster Attribute Table.
virtual CPLErr SetDefaultRAT (const GDALRasterAttributeTable *)
 Set default Raster Attribute Table.
virtual GDALRasterBandGetMaskBand ()
 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 ReportError (CPLErr eErrClass, int err_no, const char *fmt,...) CPL_PRINT_FUNC_FORMAT(4
 Emits an error related to a raster band.
- Public Member Functions inherited from GDALMajorObject
int GetMOFlags ()
void SetMOFlags (int nFlags)
virtual const char * GetDescription () const
 Fetch object description.
virtual void SetDescription (const char *)
 Set object description.
virtual char ** GetMetadata (const char *pszDomain="")
 Fetch metadata.
virtual CPLErr SetMetadata (char **papszMetadata, const char *pszDomain="")
 Set metadata.
virtual const char * GetMetadataItem (const char *pszName, const char *pszDomain="")
 Fetch single metadata item.
virtual CPLErr SetMetadataItem (const char *pszName, const char *pszValue, const char *pszDomain="")
 Set single metadata item.

Friends

class GDALGeneric3x3Dataset

Additional Inherited Members

- Protected Member Functions inherited from GDALRasterBand
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 *)
GDALRasterBlockTryGetLockedBlockRef (int nXBlockOff, int nYBlockYOff)
 Try fetching block ref.
- Protected Attributes inherited from GDALRasterBand
GDALDatasetpoDS
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
GDALRasterBandpoMask
bool bOwnMask
int nMaskFlags
- Protected Attributes inherited from GDALMajorObject
int nFlags
CPLString sDescription
GDALMultiDomainMetadata oMDMD

Member Function Documentation

double GDALGeneric3x3RasterBand::GetNoDataValue ( int *  pbSuccess)
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().

Parameters:
pbSuccesspointer to a boolean to use to indicate if a value is actually associated with this layer. May be NULL (default).
Returns:
the nodata value for this band.

Reimplemented from GDALRasterBand.


The documentation for this class was generated from the following file:

Generated for GDAL by doxygen 1.8.1.1.