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)
const;
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;
204 char **papszOptions )
override;
214 typedef struct _GDALProxyPoolCacheEntry GDALProxyPoolCacheEntry;
215 class GDALProxyPoolRasterBand;
217 class CPL_DLL GDALProxyPoolDataset :
public GDALProxyDataset
222 mutable char *pszProjectionRef =
nullptr;
225 double adfGeoTransform[6]{0,1,0,0,0,1};
226 bool bHasSrcProjection =
false;
227 bool m_bHasSrcSRS =
false;
228 bool bHasSrcGeoTransform =
false;
229 char *pszGCPProjection =
nullptr;
235 mutable GDALProxyPoolCacheEntry* cacheEntry =
nullptr;
236 char *m_pszOwner =
nullptr;
238 GDALDataset *RefUnderlyingDataset(
bool bForceOpen)
const;
240 GDALProxyPoolDataset(
const char* pszSourceDatasetDescription,
243 const char* pszOwner );
246 GDALDataset *RefUnderlyingDataset()
const override;
247 void UnrefUnderlyingDataset(
GDALDataset* poUnderlyingDataset)
const override;
249 friend class GDALProxyPoolRasterBand;
252 GDALProxyPoolDataset(
const char* pszSourceDatasetDescription,
253 int nRasterXSize,
int nRasterYSize,
256 const char * pszProjectionRef =
nullptr,
257 double * padfGeoTransform =
nullptr,
258 const char* pszOwner =
nullptr );
261 static GDALProxyPoolDataset* Create(
const char* pszSourceDatasetDescription,
265 const char* pszOwner =
nullptr );
267 ~GDALProxyPoolDataset()
override;
275 void AddSrcBandDescription(
GDALDataType eDataType,
int nBlockXSize,
281 void AddSrcBand(
int nBand,
GDALDataType eDataType,
int nBlockXSize,
283 void FlushCache(
bool bAtClosing)
override;
288 const char *_GetProjectionRef()
override;
289 CPLErr _SetProjection(
const char * )
override;
291 CPLErr GetGeoTransform(
double * )
override;
292 CPLErr SetGeoTransform(
double * )
override;
297 char **GetMetadata(
const char * pszDomain )
override;
298 const char *GetMetadataItem(
const char * pszName,
299 const char * pszDomain )
override;
301 void *GetInternalHandle(
const char * pszRequest )
override;
303 const char *_GetGCPProjection()
override;
315 class GDALProxyPoolOverviewRasterBand;
316 class GDALProxyPoolMaskBand;
318 class CPL_DLL GDALProxyPoolRasterBand :
public GDALProxyRasterBand
323 char *pszUnitType =
nullptr;
324 char **papszCategoryNames =
nullptr;
327 int nSizeProxyOverviewRasterBand = 0;
328 GDALProxyPoolOverviewRasterBand **papoProxyOverviewRasterBand =
nullptr;
329 GDALProxyPoolMaskBand *poProxyMaskBand =
nullptr;
335 void UnrefUnderlyingRasterBand(
GDALRasterBand* poUnderlyingRasterBand )
338 friend class GDALProxyPoolOverviewRasterBand;
339 friend class GDALProxyPoolMaskBand;
342 GDALProxyPoolRasterBand( GDALProxyPoolDataset* poDS,
int nBand,
344 int nBlockXSize,
int nBlockYSize );
345 GDALProxyPoolRasterBand( GDALProxyPoolDataset* poDS,
347 ~GDALProxyPoolRasterBand()
override;
349 void AddSrcMaskBandDescription(
GDALDataType eDataType,
int nBlockXSize,
352 void AddSrcMaskBandDescriptionFromUnderlying();
357 char **GetMetadata(
const char * pszDomain )
override;
358 const char *GetMetadataItem(
const char * pszName,
359 const char * pszDomain )
override;
360 char **GetCategoryNames()
override;
361 const char *GetUnitType()
override;
367 CPLErr FlushCache(
bool bAtClosing)
override;
377 class GDALProxyPoolOverviewRasterBand :
public GDALProxyPoolRasterBand
380 GDALProxyPoolRasterBand *poMainBand =
nullptr;
381 int nOverviewBand = 0;
384 mutable int nRefCountUnderlyingMainRasterBand = 0;
390 void UnrefUnderlyingRasterBand(
GDALRasterBand* poUnderlyingRasterBand )
394 GDALProxyPoolOverviewRasterBand( GDALProxyPoolDataset* poDS,
396 GDALProxyPoolRasterBand* poMainBand,
398 ~GDALProxyPoolOverviewRasterBand()
override;
405 class GDALProxyPoolMaskBand :
public GDALProxyPoolRasterBand
408 GDALProxyPoolRasterBand *poMainBand =
nullptr;
411 mutable int nRefCountUnderlyingMainRasterBand = 0;
417 void UnrefUnderlyingRasterBand(
GDALRasterBand* poUnderlyingRasterBand )
421 GDALProxyPoolMaskBand( GDALProxyPoolDataset* poDS,
423 GDALProxyPoolRasterBand* poMainBand );
424 GDALProxyPoolMaskBand( GDALProxyPoolDataset* poDS,
425 GDALProxyPoolRasterBand* poMainBand,
427 int nBlockXSize,
int nBlockYSize );
428 ~GDALProxyPoolMaskBand()
override;
430 bool IsMaskBand()
const override {
return true; }
441 typedef struct GDALProxyPoolDatasetHS *GDALProxyPoolDatasetH;
443 GDALProxyPoolDatasetH CPL_DLL GDALProxyPoolDatasetCreate(
const char* pszSourceDatasetDescription,
444 int nRasterXSize,
int nRasterYSize,
446 const char * pszProjectionRef,
447 double * padfGeoTransform);
449 void CPL_DLL GDALProxyPoolDatasetDelete(GDALProxyPoolDatasetH hProxyPoolDataset);
451 void CPL_DLL GDALProxyPoolDatasetAddSrcBandDescription( GDALProxyPoolDatasetH hProxyPoolDataset,
453 int nBlockXSize,
int nBlockYSize);
virtual CPLErr IWriteBlock(int nBlockXOff, int nBlockYOff, void *pData)
Definition: gdalrasterband.cpp:616
virtual int HasArbitraryOverviews()
Check for arbitrary overviews.
Definition: gdalrasterband.cpp:2435
virtual CPLErr SetNoDataValue(double dfNoData)
Set the no data value for this band.
Definition: gdalrasterband.cpp:1814
virtual GDALColorTable * GetColorTable()
Fetch the color table associated with band.
Definition: gdalrasterband.cpp:2338
virtual GDALMaskValueRange GetMaskValueRange() const
Returns the range of values that a mask band can take.
Definition: gdalrasterband.cpp:6717
virtual CPLErr ComputeStatistics(int bApproxOK, double *pdfMin, double *pdfMax, double *pdfMean, double *pdfStdDev, GDALProgressFunc, void *pProgressData)
Compute image statistics.
Definition: gdalrasterband.cpp:5214
virtual const char * GetUnitType()
Return raster unit type.
Definition: gdalrasterband.cpp:2915
virtual CPLErr BuildOverviews(const char *pszResampling, int nOverviews, int *panOverviewList, GDALProgressFunc pfnProgress, void *pProgressData)
Build raster overview(s)
Definition: gdalrasterband.cpp:2672
virtual CPLErr DeleteNoDataValue()
Remove the no data value for this band.
Definition: gdalrasterband.cpp:2016
virtual double GetOffset(int *pbSuccess=nullptr)
Fetch the raster value offset.
Definition: gdalrasterband.cpp:2713
virtual CPLErr SetColorTable(GDALColorTable *poCT)
Set the raster color table.
Definition: gdalrasterband.cpp:2387
virtual CPLErr GetDefaultHistogram(double *pdfMin, double *pdfMax, int *pnBuckets, GUIntBig **ppanHistogram, int bForce, GDALProgressFunc, void *pProgressData)
Fetch default raster histogram.
Definition: gdalrasterband.cpp:3757
virtual bool IsMaskBand() const
Returns whether a band is a mask band.
Definition: gdalrasterband.cpp:6667
virtual CPLErr Fill(double dfRealValue, double dfImaginaryValue=0)
Fill this band with a constant value.
Definition: gdalrasterband.cpp:1379
virtual CPLVirtualMem * GetVirtualMemAuto(GDALRWFlag eRWFlag, int *pnPixelSpace, GIntBig *pnLineSpace, char **papszOptions)
Create a CPLVirtualMem object from a GDAL raster band object.
Definition: gdalrasterband.cpp:7039
virtual GDALDriver * GetDriver(void)
Fetch the driver to which this dataset relates.
Definition: gdaldataset.cpp:1315
Format specific driver.
Definition: gdal_priv.h:1524
This class represents an OpenGIS Spatial Reference System, and contains methods for converting betwee...
Definition: ogr_spatialref.h:157
virtual CPLErr SetDefaultHistogram(double dfMin, double dfMax, int nBuckets, GUIntBig *panHistogram)
Set default histogram.
Definition: gdalrasterband.cpp:6012
virtual CPLErr SetUnitType(const char *pszNewValue)
Set unit type.
Definition: gdalrasterband.cpp:2963
virtual GDALColorInterp GetColorInterpretation()
How should this band be interpreted as color?
Definition: gdalrasterband.cpp:2246
virtual char ** GetCategoryNames()
Fetch the list of category names for this raster.
Definition: gdalrasterband.cpp:1525
GDALColorInterp
Definition: gdal.h:204
A single raster band (or channel).
Definition: gdal_priv.h:1150
GDALMaskValueRange
Range of values found in a mask band.
Definition: gdal_priv.h:1140
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:2841
void static void char ** GetMetadata(const char *pszDomain="") override
Fetch metadata.
Definition: gdaldataset.cpp:4229
GDALDataType
Definition: gdal.h:63
virtual const char * GetMetadataItem(const char *pszName, const char *pszDomain="")
Fetch single metadata item.
Definition: gdalmajorobject.cpp:344
virtual CPLErr SetGCPs(int nGCPCount, const GDAL_GCP *pasGCPList, const OGRSpatialReference *poGCP_SRS)
Assign GCPs.
Definition: gdaldataset.cpp:1834
virtual const GDAL_GCP * GetGCPs()
Fetch GCPs.
Definition: gdaldataset.cpp:1729
A set of associated raster bands, usually from one file.
Definition: gdal_priv.h:339
struct _CPLHashSet CPLHashSet
Opaque type for a hash set.
Definition: cpl_hash_set.h:52
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:301
virtual int GetOverviewCount()
Return the number of overview layers available.
Definition: gdalrasterband.cpp:2472
virtual CPLErr SetDefaultRAT(const GDALRasterAttributeTable *poRAT)
Set default Raster Attribute Table.
Definition: gdalrasterband.cpp:6159
virtual void * GetInternalHandle(const char *pszHandleName)
Fetch a format specific internally meaningful handle.
Definition: gdaldataset.cpp:1277
virtual GDALRasterBand * GetMaskBand()
Return the mask band associated with the band.
Definition: gdalrasterband.cpp:6244
virtual char ** GetMetadata(const char *pszDomain="")
Fetch metadata.
Definition: gdalmajorobject.cpp:249
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1053
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:3972
unsigned long long GUIntBig
Large unsigned integer type (generally 64-bit unsigned integer type).
Definition: cpl_port.h:233
virtual GDALRasterBand * GetRasterSampleOverview(GUIntBig)
Fetch best sampling overview.
Definition: gdalrasterband.cpp:2564
virtual const OGRSpatialReference * GetGCPSpatialRef() const
Get output spatial reference system for GCPs.
Definition: gdaldataset.cpp:1646
virtual CPLErr SetSpatialRef(const OGRSpatialReference *poSRS)
Set the spatial reference system for this dataset.
Definition: gdaldataset.cpp:1059
Ground Control Point.
Definition: gdal.h:732
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:303
virtual CPLErr IReadBlock(int nBlockXOff, int nBlockYOff, void *pData)=0
Read a block of data.
virtual int GetGCPCount()
Get number of GCPs.
Definition: gdaldataset.cpp:1549
virtual GDALRasterBand * GetOverview(int)
Fetch overview raster band object.
Definition: gdalrasterband.cpp:2514
virtual char ** GetMetadataDomainList()
Fetch list of metadata domains.
Definition: gdalmajorobject.cpp:161
virtual CPLErr ComputeRasterMinMax(int, double *)
Compute the min/max values for a band.
Definition: gdalrasterband.cpp:5777
struct CPLVirtualMem CPLVirtualMem
Opaque type that represents a virtual memory mapping.
Definition: cpl_virtualmem.h:62
virtual CPLErr SetScale(double dfNewScale)
Set scaling ratio.
Definition: gdalrasterband.cpp:2868
virtual CPLErr CreateMaskBand(int nFlagsIn)
Adds a mask band to the dataset.
Definition: gdaldataset.cpp:3147
GIntBig GSpacing
Type to express pixel, line or band spacing.
Definition: gdal.h:287
virtual double GetNoDataValue(int *pbSuccess=nullptr)
Fetch the no data value for this band.
Definition: gdalrasterband.cpp:1629
GDALAccess
Definition: gdal.h:116
virtual CPLErr GetStatistics(int bApproxOK, int bForce, double *pdfMin, double *pdfMax, double *pdfMean, double *padfStdDev)
Fetch image statistics.
Definition: gdalrasterband.cpp:4052
@ GA_ReadOnly
Definition: gdal.h:117
virtual const OGRSpatialReference * GetSpatialRef() const
Fetch the spatial reference for this dataset.
Definition: gdaldataset.cpp:928
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition: cpl_port.h:230
virtual CPLErr FlushCache(bool bAtClosing=false)
Flush raster data cache.
Definition: gdalrasterband.cpp:1022
virtual CPLErr SetGeoTransform(double *padfTransform)
Set the affine transformation coefficients.
Definition: gdaldataset.cpp:1232
virtual char ** GetFileList(void)
Fetch files forming dataset.
Definition: gdaldataset.cpp:3026
virtual GDALRasterAttributeTable * GetDefaultRAT()
Fetch default Raster Attribute Table.
Definition: gdalrasterband.cpp:6111
virtual void FlushCache(bool bAtClosing=false)
Flush all write cached data to disk.
Definition: gdaldataset.cpp:435
virtual double GetMinimum(int *pbSuccess=nullptr)
Fetch the minimum value for this band.
Definition: gdalrasterband.cpp:2159
virtual double GetScale(int *pbSuccess=nullptr)
Fetch the raster value scale.
Definition: gdalrasterband.cpp:2819
GDALRWFlag
Definition: gdal.h:122
virtual CPLErr SetColorInterpretation(GDALColorInterp eColorInterp)
Set color interpretation of a band.
Definition: gdalrasterband.cpp:2291
virtual CPLErr IRasterIO(GDALRWFlag, int, int, int, int, void *, int, int, GDALDataType, GSpacing, GSpacing, GDALRasterIOExtraArg *psExtraArg)
Read/write a region of image data for this band.
Definition: rasterio.cpp:209
virtual CPLErr SetStatistics(double dfMin, double dfMax, double dfMean, double dfStdDev)
Set statistics on band.
Definition: gdalrasterband.cpp:5710
CPLErr SetMetadataItem(const char *pszName, const char *pszValue, const char *pszDomain) override
Set single metadata item.
CPLErr
Error category.
Definition: cpl_error.h:52
CPLErr SetMetadata(char **papszMetadata, const char *pszDomain) override
Set metadata.
virtual CPLErr SetCategoryNames(char **papszNames)
Set the category names for this band.
Definition: gdalrasterband.cpp:1573
virtual CPLErr GetHistogram(double dfMin, double dfMax, int nBuckets, GUIntBig *panHistogram, int bIncludeOutOfRange, int bApproxOK, GDALProgressFunc, void *pProgressData)
Compute raster histogram.
Definition: gdalrasterband.cpp:3215
virtual int GetMaskFlags()
Return the status flags of the mask band associated with the band.
Definition: gdalrasterband.cpp:6526
virtual CPLErr GetGeoTransform(double *padfTransform)
Fetch the affine transformation coefficients.
Definition: gdaldataset.cpp:1177
virtual CPLErr CreateMaskBand(int nFlagsIn)
Adds a mask band to the current band.
Definition: gdalrasterband.cpp:6607
CPLErr SetMetadata(char **papszMetadata, const char *pszDomain) override
Set metadata.
Definition: gdal_rat.h:47
virtual double GetMaximum(int *pbSuccess=nullptr)
Fetch the maximum value for this band.
Definition: gdalrasterband.cpp:2066
CPLErr SetMetadataItem(const char *pszName, const char *pszValue, const char *pszDomain) override
Set single metadata item.
virtual CPLErr SetOffset(double dfNewOffset)
Set scaling offset.
Definition: gdalrasterband.cpp:2762
char ** GetMetadataDomainList() override
Fetch list of metadata domains.
Definition: gdaldataset.cpp:4330
#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:927
A color table / palette.
Definition: gdal_priv.h:1032