VRTRawRasterBand Class Reference

Inheritance diagram for VRTRawRasterBand:

Public Member Functions
	VRTRawRasterBand (GDALDataset *poDS, int nBand, GDALDataType eType=GDT_Unknown)
virtual CPLErr	XMLInit (CPLXMLNode *, const char *)
virtual CPLXMLNode *	SerializeToXML (const char *pszVRTPath)
virtual CPLErr	IRasterIO (GDALRWFlag, int, int, int, int, void *, int, int, GDALDataType, GSpacing nPixelSpace, GSpacing nLineSpace, GDALRasterIOExtraArg *psExtraArg)
virtual CPLErr	IReadBlock (int, int, void *)
virtual CPLErr	IWriteBlock (int, int, void *)
CPLErr	SetRawLink (const char *pszFilename, const char *pszVRTPath, int bRelativeToVRT, vsi_l_offset nImageOffset, int nPixelOffset, int nLineOffset, const char *pszByteOrder)
void	ClearRawLink ()
virtual void	GetFileList (char ***ppapszFileList, int *pnSize, int *pnMaxSize, CPLHashSet *hSetFiles)
Public Member Functions inherited from VRTRasterBand
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	DeleteNoDataValue ()
	Remove 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, GUIntBig *panHistogram, int bIncludeOutOfRange, int bApproxOK, GDALProgressFunc, void *pProgressData)
	Compute raster histogram. More...
virtual CPLErr	GetDefaultHistogram (double *pdfMin, double *pdfMax, int *pnBuckets, GUIntBig **ppanHistogram, int bForce, GDALProgressFunc, void *pProgressData)
	Fetch default raster histogram. More...
virtual CPLErr	SetDefaultHistogram (double dfMin, double dfMax, int nBuckets, GUIntBig *panHistogram)
	Set default histogram. More...
CPLErr	CopyCommonInfoFrom (GDALRasterBand *)
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 ()
virtual int	IsPansharpenRasterBand ()
Public Member Functions inherited from GDALRasterBand
	GDALRasterBand ()
	GDALRasterBand (int bForceCachedIO)
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, GSpacing, GSpacing, GDALRasterIOExtraArg *psExtraArg) CPL_WARN_UNUSED_RESULT
	Read/write a region of image data for this band. More...
CPLErr	ReadBlock (int, int, void *) CPL_WARN_UNUSED_RESULT
	Read a block of image data efficiently. More...
CPLErr	WriteBlock (int, int, void *) CPL_WARN_UNUSED_RESULT
	Write a block of image data efficiently. More...
GDALRasterBlock *	GetLockedBlockRef (int nXBlockOff, int nYBlockOff, int bJustInitialize=FALSE) CPL_WARN_UNUSED_RESULT
	Fetch a pointer to an internally cached raster block. More...
CPLErr	FlushBlock (int, int, 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 (GUIntBig)
	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) CPL_WARN_UNUSED_RESULT
	Create a CPLVirtualMem object from a GDAL raster band object. More...
void	ReportError (CPLErr eErrClass, CPLErrorNum err_no, const char *fmt,...) CPL_PRINT_FUNC_FORMAT(4
	Emits an error related to a raster band. More...
Public Member Functions inherited from GDALMajorObject
int	GetMOFlags ()
void	SetMOFlags (int nFlagsIn)
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...

Additional Inherited Members
Protected Member Functions inherited from VRTRasterBand
void	Initialize (int nXSize, int nYSize)
Protected Member Functions inherited from GDALRasterBand
void	InvalidateMaskBand ()
CPLErr	RasterIOResampled (GDALRWFlag, int, int, int, int, void *, int, int, GDALDataType, GSpacing, GSpacing, GDALRasterIOExtraArg *psExtraArg) CPL_WARN_UNUSED_RESULT
int	EnterReadWrite (GDALRWFlag eRWFlag)
void	LeaveReadWrite ()
void	InitRWLock ()
CPLErr	OverviewRasterIO (GDALRWFlag, int, int, int, int, void *, int, int, GDALDataType, GSpacing, GSpacing, GDALRasterIOExtraArg *psExtraArg) CPL_WARN_UNUSED_RESULT
CPLErr	TryOverviewRasterIO (GDALRWFlag eRWFlag, int nXOff, int nYOff, int nXSize, int nYSize, void *pData, int nBufXSize, int nBufYSize, GDALDataType eBufType, GSpacing nPixelSpace, GSpacing nLineSpace, GDALRasterIOExtraArg *psExtraArg, int *pbTried)
int	InitBlockInfo ()
CPLErr	AdoptBlock (GDALRasterBlock *)
GDALRasterBlock *	TryGetLockedBlockRef (int nXBlockOff, int nYBlockYOff)
	Try fetching block ref. More...
void	AddBlockToFreeList (GDALRasterBlock *)
Protected Member Functions inherited from GDALMajorObject
char **	BuildMetadataDomainList (char **papszList, int bCheckNonEmpty,...) CPL_NULL_TERMINATED
	Helper function for custom implementations of GetMetadataDomainList() More...
Protected Attributes inherited from VRTRasterBand
int	m_bIsMaskBand
int	m_bNoDataValueSet
int	m_bHideNoDataValue
double	m_dfNoDataValue
GDALColorTable *	m_poColorTable
GDALColorInterp	m_eColorInterp
char *	m_pszUnitType
char **	m_papszCategoryNames
double	m_dfOffset
double	m_dfScale
CPLXMLNode *	m_psSavedHistograms
std::vector< VRTOverviewInfo >	m_apoOverviews
VRTRasterBand *	m_poMaskBand
Protected Attributes inherited from GDALRasterBand
GDALDataset *	poDS
int	nBand
int	nRasterXSize
int	nRasterYSize
GDALDataType	eDataType
GDALAccess	eAccess
int	nBlockXSize
int	nBlockYSize
int	nBlocksPerRow
int	nBlocksPerColumn
int	nBlockReads
int	bForceCachedIO
GDALRasterBand *	poMask
bool	bOwnMask
int	nMaskFlags
Protected Attributes inherited from GDALMajorObject
int	nFlags
CPLString	sDescription
GDALMultiDomainMetadata	oMDMD

---

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

• vrtdataset.h
• vrtrawrasterband.cpp