30 #ifndef GDAL_PROXY_H_INCLUDED
31 #define GDAL_PROXY_H_INCLUDED
51 virtual GDALDataset *RefUnderlyingDataset()
const = 0;
52 virtual void UnrefUnderlyingDataset(
GDALDataset* poUnderlyingDataset)
const;
54 CPLErr IBuildOverviews(
const char *,
int,
int *,
55 int,
int *, GDALProgressFunc,
void * )
override;
63 char **
GetMetadata(
const char * pszDomain )
override;
65 const char * pszDomain )
override;
67 const char * pszDomain )
override;
69 const char * pszValue,
70 const char * pszDomain )
override;
91 int nBufXSize,
int nBufYSize,
93 int nBandCount,
int *panBandList,
94 char **papszOptions )
override;
99 const char *_GetProjectionRef(
void)
override;
100 CPLErr _SetProjection(
const char * )
override;
101 const char *_GetGCPProjection()
override;
103 const char *pszGCPProjection )
override;
116 GDALProxyRasterBand() {}
119 virtual void UnrefUnderlyingRasterBand(
GDALRasterBand* poUnderlyingRasterBand);
129 char **
GetMetadata(
const char * pszDomain )
override;
131 const char * pszDomain )
override;
133 const char * pszDomain )
override;
135 const char * pszValue,
136 const char * pszDomain )
override;
140 double GetMinimum(
int *pbSuccess =
nullptr )
override;
141 double GetMaximum(
int *pbSuccess =
nullptr )
override;
142 double GetOffset(
int *pbSuccess =
nullptr )
override;
143 double GetScale(
int *pbSuccess =
nullptr )
override;
147 CPLErr Fill(
double dfRealValue,
double dfImaginaryValue = 0)
override;
159 double *pdfMin,
double *pdfMax,
160 double *pdfMean,
double *padfStdDev )
override;
162 double *pdfMin,
double *pdfMax,
163 double *pdfMean,
double *pdfStdDev,
164 GDALProgressFunc,
void *pProgressData )
override;
166 double dfMean,
double dfStdDev )
override;
174 GDALProgressFunc,
void * )
override;
177 int nBufXSize,
int nBufYSize,
181 int nBuckets,
GUIntBig * panHistogram,
182 int bIncludeOutOfRange,
int bApproxOK,
183 GDALProgressFunc,
void *pProgressData )
override;
186 int *pnBuckets,
GUIntBig ** ppanHistogram,
188 GDALProgressFunc,
void *pProgressData)
override;
190 int nBuckets,
GUIntBig *panHistogram )
override;
202 char **papszOptions )
override;
212 typedef struct _GDALProxyPoolCacheEntry GDALProxyPoolCacheEntry;
213 class GDALProxyPoolRasterBand;
215 class CPL_DLL GDALProxyPoolDataset :
public GDALProxyDataset
220 mutable char *pszProjectionRef =
nullptr;
223 double adfGeoTransform[6]{0,1,0,0,0,1};
224 bool bHasSrcProjection =
false;
225 bool m_bHasSrcSRS =
false;
226 bool bHasSrcGeoTransform =
false;
227 char *pszGCPProjection =
nullptr;
233 mutable GDALProxyPoolCacheEntry* cacheEntry =
nullptr;
234 char *m_pszOwner =
nullptr;
236 GDALDataset *RefUnderlyingDataset(
bool bForceOpen)
const;
239 GDALDataset *RefUnderlyingDataset()
const override;
240 void UnrefUnderlyingDataset(
GDALDataset* poUnderlyingDataset)
const override;
242 friend class GDALProxyPoolRasterBand;
245 GDALProxyPoolDataset(
const char* pszSourceDatasetDescription,
246 int nRasterXSize,
int nRasterYSize,
249 const char * pszProjectionRef =
nullptr,
250 double * padfGeoTransform =
nullptr,
251 const char* pszOwner =
nullptr );
252 ~GDALProxyPoolDataset()
override;
254 void SetOpenOptions(
char** papszOpenOptions );
255 void AddSrcBandDescription(
GDALDataType eDataType,
int nBlockXSize,
261 void AddSrcBand(
int nBand,
GDALDataType eDataType,
int nBlockXSize,
263 void FlushCache()
override;
268 const char *_GetProjectionRef()
override;
269 CPLErr _SetProjection(
const char * )
override;
271 CPLErr GetGeoTransform(
double * )
override;
272 CPLErr SetGeoTransform(
double * )
override;
277 char **GetMetadata(
const char * pszDomain )
override;
278 const char *GetMetadataItem(
const char * pszName,
279 const char * pszDomain )
override;
281 void *GetInternalHandle(
const char * pszRequest )
override;
283 const char *_GetGCPProjection()
override;
295 class GDALProxyPoolOverviewRasterBand;
296 class GDALProxyPoolMaskBand;
298 class CPL_DLL GDALProxyPoolRasterBand :
public GDALProxyRasterBand
303 char *pszUnitType =
nullptr;
304 char **papszCategoryNames =
nullptr;
307 int nSizeProxyOverviewRasterBand = 0;
308 GDALProxyPoolOverviewRasterBand **papoProxyOverviewRasterBand =
nullptr;
309 GDALProxyPoolMaskBand *poProxyMaskBand =
nullptr;
315 void UnrefUnderlyingRasterBand(
GDALRasterBand* poUnderlyingRasterBand )
318 friend class GDALProxyPoolOverviewRasterBand;
319 friend class GDALProxyPoolMaskBand;
322 GDALProxyPoolRasterBand( GDALProxyPoolDataset* poDS,
int nBand,
324 int nBlockXSize,
int nBlockYSize );
325 GDALProxyPoolRasterBand( GDALProxyPoolDataset* poDS,
327 ~GDALProxyPoolRasterBand()
override;
329 void AddSrcMaskBandDescription(
GDALDataType eDataType,
int nBlockXSize,
335 char **GetMetadata(
const char * pszDomain )
override;
336 const char *GetMetadataItem(
const char * pszName,
337 const char * pszDomain )
override;
338 char **GetCategoryNames()
override;
339 const char *GetUnitType()
override;
345 CPLErr FlushCache()
override;
355 class GDALProxyPoolOverviewRasterBand :
public GDALProxyPoolRasterBand
358 GDALProxyPoolRasterBand *poMainBand =
nullptr;
359 int nOverviewBand = 0;
362 int nRefCountUnderlyingMainRasterBand = 0;
368 void UnrefUnderlyingRasterBand(
GDALRasterBand* poUnderlyingRasterBand )
372 GDALProxyPoolOverviewRasterBand( GDALProxyPoolDataset* poDS,
374 GDALProxyPoolRasterBand* poMainBand,
376 ~GDALProxyPoolOverviewRasterBand() override;
383 class GDALProxyPoolMaskBand : public GDALProxyPoolRasterBand
386 GDALProxyPoolRasterBand *poMainBand =
nullptr;
389 int nRefCountUnderlyingMainRasterBand = 0;
395 void UnrefUnderlyingRasterBand(
GDALRasterBand* poUnderlyingRasterBand )
399 GDALProxyPoolMaskBand( GDALProxyPoolDataset* poDS,
401 GDALProxyPoolRasterBand* poMainBand );
402 GDALProxyPoolMaskBand( GDALProxyPoolDataset* poDS,
403 GDALProxyPoolRasterBand* poMainBand,
405 int nBlockXSize,
int nBlockYSize );
406 ~GDALProxyPoolMaskBand() override;
417 typedef struct GDALProxyPoolDatasetHS *GDALProxyPoolDatasetH;
419 GDALProxyPoolDatasetH CPL_DLL GDALProxyPoolDatasetCreate(
const char* pszSourceDatasetDescription,
420 int nRasterXSize,
int nRasterYSize,
422 const char * pszProjectionRef,
423 double * padfGeoTransform);
425 void CPL_DLL GDALProxyPoolDatasetDelete(GDALProxyPoolDatasetH hProxyPoolDataset);
427 void CPL_DLL GDALProxyPoolDatasetAddSrcBandDescription( GDALProxyPoolDatasetH hProxyPoolDataset,
429 int nBlockXSize,
int nBlockYSize);
The GDALRasterAttributeTable (or RAT) class is used to encapsulate a table used to provide attribute ...
Definition: gdal_rat.h:47
virtual GDALDriver * GetDriver(void)
Fetch the driver to which this dataset relates.
Definition: gdaldataset.cpp:1294
virtual CPLErr GetGeoTransform(double *padfTransform)
Fetch the affine transformation coefficients.
Definition: gdaldataset.cpp:1156
GDALDataType
Definition: gdal.h:60
virtual CPLErr SetCategoryNames(char **papszNames)
Set the category names for this band.
Definition: gdalrasterband.cpp:1552
virtual GDALRasterBand * GetMaskBand()
Return the mask band associated with the band.
Definition: gdalrasterband.cpp:5942
virtual char ** GetCategoryNames()
Fetch the list of category names for this raster.
Definition: gdalrasterband.cpp:1504
virtual void FlushCache(void)
Flush all write cached data to disk.
Definition: gdaldataset.cpp:416
virtual int HasArbitraryOverviews()
Check for arbitrary overviews.
Definition: gdalrasterband.cpp:2136
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:337
virtual GDALRasterBand * GetOverview(int)
Fetch overview raster band object.
Definition: gdalrasterband.cpp:2215
virtual CPLErr GetDefaultHistogram(double *pdfMin, double *pdfMax, int *pnBuckets, GUIntBig **ppanHistogram, int bForce, GDALProgressFunc, void *pProgressData)
Fetch default raster histogram.
Definition: gdalrasterband.cpp:3458
virtual CPLErr AdviseRead(int nXOff, int nYOff, int nXSize, int nYSize, int nBufXSize, int nBufYSize, GDALDataType eDT, int nBandCount, int *panBandList, char **papszOptions)
Advise driver of upcoming read requests.
Definition: gdaldataset.cpp:2743
virtual CPLErr IRasterIO(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.
Definition: rasterio.cpp:68
virtual GDALColorInterp GetColorInterpretation()
How should this band be interpreted as color?
Definition: gdalrasterband.cpp:1947
virtual CPLErr SetDefaultRAT(const GDALRasterAttributeTable *poRAT)
Set default Raster Attribute Table.
Definition: gdalrasterband.cpp:5857
GDALRWFlag
Definition: gdal.h:119
virtual CPLErr SetStatistics(double dfMin, double dfMax, double dfMean, double dfStdDev)
Set statistics on band.
Definition: gdalrasterband.cpp:5390
virtual void * GetInternalHandle(const char *pszHandleName)
Fetch a format specific internally meaningful handle.
Definition: gdaldataset.cpp:1256
virtual int GetMaskFlags()
Return the status flags of the mask band associated with the band.
Definition: gdalrasterband.cpp:6207
virtual GDALRasterAttributeTable * GetDefaultRAT()
Fetch default Raster Attribute Table.
Definition: gdalrasterband.cpp:5809
virtual CPLErr BuildOverviews(const char *pszResampling, int nOverviews, int *panOverviewList, GDALProgressFunc pfnProgress, void *pProgressData)
Build raster overview(s)
Definition: gdalrasterband.cpp:2373
virtual CPLErr GetHistogram(double dfMin, double dfMax, int nBuckets, GUIntBig *panHistogram, int bIncludeOutOfRange, int bApproxOK, GDALProgressFunc, void *pProgressData)
Compute raster histogram.
Definition: gdalrasterband.cpp:2916
virtual const OGRSpatialReference * GetGCPSpatialRef() const
Get output spatial reference system for GCPs.
Definition: gdaldataset.cpp:1593
virtual CPLErr ComputeStatistics(int bApproxOK, double *pdfMin, double *pdfMax, double *pdfMean, double *pdfStdDev, GDALProgressFunc, void *pProgressData)
Compute image statistics.
Definition: gdalrasterband.cpp:4882
virtual CPLErr SetOffset(double dfNewOffset)
Set scaling offset.
Definition: gdalrasterband.cpp:2463
CPLErr SetMetadata(char **papszMetadata, const char *pszDomain) override
Set metadata.
struct CPLVirtualMem CPLVirtualMem
Opaque type that represents a virtual memory mapping.
Definition: cpl_virtualmem.h:62
void char ** GetMetadata(const char *pszDomain="") override
Fetch metadata.
Definition: gdaldataset.cpp:3949
CPLErr SetMetadataItem(const char *pszName, const char *pszValue, const char *pszDomain) override
Set single metadata item.
virtual CPLErr IReadBlock(int nBlockXOff, int nBlockYOff, void *pData)=0
Read a block of data.
virtual CPLErr FlushCache()
Flush raster data cache.
Definition: gdalrasterband.cpp:1004
GIntBig GSpacing
Type to express pixel, line or band spacing.
Definition: gdal.h:273
virtual CPLErr SetDefaultHistogram(double dfMin, double dfMax, int nBuckets, GUIntBig *panHistogram)
Set default histogram.
Definition: gdalrasterband.cpp:5710
const char * GetMetadataItem(const char *pszName, const char *pszDomain) override
Fetch single metadata item.
virtual double GetScale(int *pbSuccess=nullptr)
Fetch the raster value scale.
Definition: gdalrasterband.cpp:2520
virtual CPLErr AdviseRead(int nXOff, int nYOff, int nXSize, int nYSize, int nBufXSize, int nBufYSize, GDALDataType eBufType, char **papszOptions)
Advise driver of upcoming read requests.
Definition: gdalrasterband.cpp:3673
virtual const GDAL_GCP * GetGCPs()
Fetch GCPs.
Definition: gdaldataset.cpp:1676
virtual CPLErr SetGCPs(int nGCPCount, const GDAL_GCP *pasGCPList, const OGRSpatialReference *poGCP_SRS)
Assign GCPs.
Definition: gdaldataset.cpp:1781
Public (C callable) GDAL entry points.
virtual CPLErr DeleteNoDataValue()
Remove the no data value for this band.
Definition: gdalrasterband.cpp:1717
virtual CPLErr SetSpatialRef(const OGRSpatialReference *poSRS)
Set the spatial reference system for this dataset.
Definition: gdaldataset.cpp:1038
virtual CPLErr SetGeoTransform(double *padfTransform)
Set the affine transformation coefficients.
Definition: gdaldataset.cpp:1211
virtual double GetNoDataValue(int *pbSuccess=nullptr)
Fetch the no data value for this band.
Definition: gdalrasterband.cpp:1604
virtual int GetGCPCount()
Get number of GCPs.
Definition: gdaldataset.cpp:1498
virtual CPLErr ComputeRasterMinMax(int, double *)
Compute the min/max values for a band.
Definition: gdalrasterband.cpp:5457
virtual CPLErr SetColorInterpretation(GDALColorInterp eColorInterp)
Set color interpretation of a band.
Definition: gdalrasterband.cpp:1992
virtual const char * GetUnitType()
Return raster unit type.
Definition: gdalrasterband.cpp:2616
virtual CPLErr SetColorTable(GDALColorTable *poCT)
Set the raster color table.
Definition: gdalrasterband.cpp:2088
virtual double GetMinimum(int *pbSuccess=nullptr)
Fetch the minimum value for this band.
Definition: gdalrasterband.cpp:1860
virtual GDALColorTable * GetColorTable()
Fetch the color table associated with band.
Definition: gdalrasterband.cpp:2039
virtual CPLErr CreateMaskBand(int nFlagsIn)
Adds a mask band to the dataset.
Definition: gdaldataset.cpp:2925
unsigned long long GUIntBig
Large unsigned integer type (generally 64-bit unsigned integer type).
Definition: cpl_port.h:251
virtual char ** GetFileList(void)
Fetch files forming dataset.
Definition: gdaldataset.cpp:2825
char ** GetMetadata(const char *pszDomain="") override
Fetch metadata.
This class represents an OpenGIS Spatial Reference System, and contains methods for converting betwee...
Definition: ogr_spatialref.h:156
virtual CPLErr SetScale(double dfNewScale)
Set scaling ratio.
Definition: gdalrasterband.cpp:2569
virtual CPLErr IWriteBlock(int nBlockXOff, int nBlockYOff, void *pData)
Write a block of data.
Definition: gdalrasterband.cpp:599
virtual double GetOffset(int *pbSuccess=nullptr)
Fetch the raster value offset.
Definition: gdalrasterband.cpp:2414
virtual int GetOverviewCount()
Return the number of overview layers available.
Definition: gdalrasterband.cpp:2173
CPLErr SetMetadataItem(const char *pszName, const char *pszValue, const char *pszDomain) override
Set single metadata item.
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.
Definition: gdalrasterband.cpp:6612
virtual CPLErr SetUnitType(const char *pszNewValue)
Set unit type.
Definition: gdalrasterband.cpp:2664
A single raster band (or channel).
Definition: gdal_priv.h:1057
GDALAccess
Definition: gdal.h:113
virtual CPLErr CreateMaskBand(int nFlagsIn)
Adds a mask band to the current band.
Definition: gdalrasterband.cpp:6288
A set of associated raster bands, usually from one file.
Definition: gdal_priv.h:335
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:339
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition: cpl_port.h:248
virtual const OGRSpatialReference * GetSpatialRef() const
Fetch the spatial reference for this dataset.
Definition: gdaldataset.cpp:907
virtual double GetMaximum(int *pbSuccess=nullptr)
Fetch the maximum value for this band.
Definition: gdalrasterband.cpp:1767
CPLErr SetMetadata(char **papszMetadata, const char *pszDomain) override
Set metadata.
virtual GDALRasterBand * GetRasterSampleOverview(GUIntBig)
Fetch best sampling overview.
Definition: gdalrasterband.cpp:2265
char ** GetMetadataDomainList() override
Fetch list of metadata domains.
Definition: gdaldataset.cpp:4050
GDALColorInterp
Definition: gdal.h:190
virtual CPLErr SetNoDataValue(double dfNoData)
Set the no data value for this band.
Definition: gdalrasterband.cpp:1663
const char * GetMetadataItem(const char *pszName, const char *pszDomain) override
Fetch single metadata item.
struct _CPLHashSet CPLHashSet
Opaque type for a hash set.
Definition: cpl_hash_set.h:52
virtual CPLErr GetStatistics(int bApproxOK, int bForce, double *pdfMin, double *pdfMax, double *pdfMean, double *padfStdDev)
Fetch image statistics.
Definition: gdalrasterband.cpp:3753
Format specific driver.
Definition: gdal_priv.h:1411
A color table / palette.
Definition: gdal_priv.h:962
virtual char ** GetMetadataDomainList()
Fetch list of metadata domains.
Definition: gdalmajorobject.cpp:161
virtual CPLErr Fill(double dfRealValue, double dfImaginaryValue=0)
Fill this band with a constant value.
Definition: gdalrasterband.cpp:1358
Ground Control Point.
Definition: gdal.h:560
CPLErr
Error category.
Definition: cpl_error.h:52
#define CPL_DISALLOW_COPY_ASSIGN(ClassName)
Helper to remove the copy and assignment constructors so that the compiler will not generate the defa...
Definition: cpl_port.h:989