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. | |
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 CPLErr | SetMetadata (char **papszMD, const char *pszDomain="") |
Set metadata. | |
virtual CPLErr | SetMetadataItem (const char *pszName, const char *pszValue, const char *pszDomain="") |
Set single metadata item. | |
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 | GetFileList (char ***ppapszFileList, int *pnSize, int *pnMaxSize, CPLHashSet *hSetFiles) |
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 () |
Protected Member Functions | |
void | Initialize (int nXSize, int nYSize) |
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 |
CPLErr VRTRasterBand::CreateMaskBand | ( | int | nFlags | ) | [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.
Reimplemented from GDALRasterBand.
References VRTDataset::CreateMaskBand().
char ** VRTRasterBand::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.
Reimplemented from GDALRasterBand.
GDALColorInterp VRTRasterBand::GetColorInterpretation | ( | ) | [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.
GDALColorTable * VRTRasterBand::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().
Reimplemented from GDALRasterBand.
CPLErr VRTRasterBand::GetDefaultHistogram | ( | double * | pdfMin, | |
double * | pdfMax, | |||
int * | pnBuckets, | |||
int ** | ppanHistogram, | |||
int | bForce, | |||
GDALProgressFunc | pfnProgress, | |||
void * | pProgressData | |||
) | [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.
pdfMin | pointer to double value that will contain the lower bound of the histogram.
|
Reimplemented from GDALRasterBand.
References CXT_Element, CPLXMLNode::eType, CPLXMLNode::psChild, CPLXMLNode::psNext, and CPLXMLNode::pszValue.
CPLErr VRTRasterBand::GetHistogram | ( | double | dfMin, | |
double | dfMax, | |||
int | nBuckets, | |||
int * | panHistogram, | |||
int | bIncludeOutOfRange, | |||
int | bApproxOK, | |||
GDALProgressFunc | pfnProgress, | |||
void * | pProgressData | |||
) | [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.
dfMin | the lower bound of the histogram.
|
Reimplemented from GDALRasterBand.
References CXT_Element.
GDALRasterBand * VRTRasterBand::GetMaskBand | ( | ) | [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 :
If a corresponding .msk file exists it will be used for the mask band. If the dataset has a NODATA_VALUES metadata item, an instance of the new GDALNoDataValuesMaskBand class will be returned. GetMaskFlags() will return GMF_NODATA | GMF_PER_DATASET.
Reimplemented from GDALRasterBand.
int VRTRasterBand::GetMaskFlags | ( | ) | [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:
GMF_ALL_VALID(0x01): There are no invalid pixels, all mask values will be 255. When used this will normally be the only flag set. GMF_PER_DATASET(0x02): The mask band is shared between all bands on the dataset. GMF_ALPHA(0x04): The mask band is actually an alpha band and may have values other than 0 and 255. GMF_NODATA(0x08): Indicates the mask is actually being generated from nodata values. (mutually exclusive of GMF_ALPHA)
The GDALRasterBand class includes a default implementation of GetMaskBand() that returns one of four default implementations :
Reimplemented from GDALRasterBand.
double VRTRasterBand::GetNoDataValue | ( | int * | pbSuccess = NULL |
) | [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.
double VRTRasterBand::GetOffset | ( | int * | pbSuccess = NULL |
) | [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.
GDALRasterBand * VRTRasterBand::GetOverview | ( | int | i | ) | [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.
References GA_ReadOnly, GDALClose(), GDALOpenShared(), and GDALDataset::GetRasterBand().
int VRTRasterBand::GetOverviewCount | ( | ) | [virtual] |
Return the number of overview layers available.
This method is the same as the C function GDALGetOverviewCount().
Reimplemented from GDALRasterBand.
Reimplemented in VRTWarpedRasterBand.
Referenced by VRTDerivedRasterBand::IRasterIO().
double VRTRasterBand::GetScale | ( | int * | pbSuccess = NULL |
) | [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.
const char * VRTRasterBand::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().
Reimplemented from GDALRasterBand.
CPLErr VRTRasterBand::SetCategoryNames | ( | char ** | ) | [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.
CPLErr VRTRasterBand::SetColorInterpretation | ( | GDALColorInterp | eColorInterp | ) | [virtual] |
Set color interpretation of a band.
eColorInterp | the new color interpretation to apply to this band. |
Reimplemented from GDALRasterBand.
CPLErr VRTRasterBand::SetColorTable | ( | GDALColorTable * | poCT | ) | [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.
References GDALColorTable::Clone(), and GCI_PaletteIndex.
void VRTRasterBand::SetDescription | ( | const char * | pszNewDesc | ) | [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.
CPLErr VRTRasterBand::SetMetadata | ( | char ** | papszMetadataIn, | |
const char * | pszDomain = "" | |||
) | [virtual] |
Set metadata.
The C function GDALSetMetadata() does the same thing as this method.
papszMetadata | the metadata in name=value string list format to apply.
|
Reimplemented from GDALMajorObject.
Reimplemented in VRTSourcedRasterBand.
CPLErr VRTRasterBand::SetMetadataItem | ( | const char * | pszName, | |
const char * | pszValue, | |||
const char * | pszDomain = "" | |||
) | [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.
|
Reimplemented from GDALMajorObject.
Reimplemented in VRTSourcedRasterBand.
CPLErr VRTRasterBand::SetNoDataValue | ( | double | ) | [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.
CPLErr VRTRasterBand::SetOffset | ( | double | dfNewOffset | ) | [virtual] |
Set scaling offset.
Very few formats implement this method. When not implemented it will issue a CPLE_NotSupported error and return CE_Failure.
dfNewOffset | the new offset. |
Reimplemented from GDALRasterBand.
CPLErr VRTRasterBand::SetScale | ( | double | dfNewScale | ) | [virtual] |
Set scaling ratio.
Very few formats implement this method. When not implemented it will issue a CPLE_NotSupported error and return CE_Failure.
dfNewScale | the new scale. |
Reimplemented from GDALRasterBand.
CPLErr VRTRasterBand::SetUnitType | ( | const char * | pszNewValue | ) | [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.