GDAL
gdal_proxy.h
1 /******************************************************************************
2  * $Id: gdal_proxy.h 4b46f534fed80d31c3e15c1517169f40694a4a3e 2021-10-14 19:17:37 +0200 Even Rouault $
3  *
4  * Project: GDAL Core
5  * Purpose: GDAL Core C++/Private declarations
6  * Author: Even Rouault <even dot rouault at spatialys.com>
7  *
8  ******************************************************************************
9  * Copyright (c) 2008-2014, Even Rouault <even dot rouault at spatialys.com>
10  *
11  * Permission is hereby granted, free of charge, to any person obtaining a
12  * copy of this software and associated documentation files (the "Software"),
13  * to deal in the Software without restriction, including without limitation
14  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
15  * and/or sell copies of the Software, and to permit persons to whom the
16  * Software is furnished to do so, subject to the following conditions:
17  *
18  * The above copyright notice and this permission notice shall be included
19  * in all copies or substantial portions of the Software.
20  *
21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
22  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
24  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
26  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27  * DEALINGS IN THE SOFTWARE.
28  ****************************************************************************/
29 
30 #ifndef GDAL_PROXY_H_INCLUDED
31 #define GDAL_PROXY_H_INCLUDED
32 
33 #ifndef DOXYGEN_SKIP
34 
35 #include "gdal.h"
36 
37 #ifdef __cplusplus
38 
39 #include "gdal_priv.h"
40 #include "cpl_hash_set.h"
41 
42 /* ******************************************************************** */
43 /* GDALProxyDataset */
44 /* ******************************************************************** */
45 
46 class CPL_DLL GDALProxyDataset : public GDALDataset
47 {
48  protected:
49  GDALProxyDataset() {}
50 
51  virtual GDALDataset *RefUnderlyingDataset() const = 0;
52  virtual void UnrefUnderlyingDataset(GDALDataset* poUnderlyingDataset) const;
53 
54  CPLErr IBuildOverviews( const char *, int, int *,
55  int, int *, GDALProgressFunc, void * ) override;
56  CPLErr IRasterIO( GDALRWFlag, int, int, int, int,
57  void *, int, int, GDALDataType,
58  int, int *, GSpacing, GSpacing, GSpacing,
59  GDALRasterIOExtraArg* psExtraArg ) override;
60 
61  public:
62  char **GetMetadataDomainList() override;
63  char **GetMetadata( const char * pszDomain ) override;
64  CPLErr SetMetadata( char ** papszMetadata,
65  const char * pszDomain ) override;
66  const char *GetMetadataItem( const char * pszName,
67  const char * pszDomain ) override;
68  CPLErr SetMetadataItem( const char * pszName,
69  const char * pszValue,
70  const char * pszDomain ) override;
71 
72  void FlushCache(bool bAtClosing) override;
73 
74  const OGRSpatialReference* GetSpatialRef() const override;
75  CPLErr SetSpatialRef(const OGRSpatialReference* poSRS) override;
76 
77  CPLErr GetGeoTransform( double * ) override;
78  CPLErr SetGeoTransform( double * ) override;
79 
80  void *GetInternalHandle( const char * ) override;
81  GDALDriver *GetDriver() override;
82  char **GetFileList() override;
83 
84  int GetGCPCount() override;
85  const OGRSpatialReference* GetGCPSpatialRef() const override;
86  const GDAL_GCP *GetGCPs() override;
87  CPLErr SetGCPs( int nGCPCount, const GDAL_GCP *pasGCPList,
88  const OGRSpatialReference * poGCP_SRS ) override;
89 
90  CPLErr AdviseRead( int nXOff, int nYOff, int nXSize, int nYSize,
91  int nBufXSize, int nBufYSize,
92  GDALDataType eDT,
93  int nBandCount, int *panBandList,
94  char **papszOptions ) override;
95 
96  CPLErr CreateMaskBand( int nFlags ) override;
97 
98  protected:
99  const char *_GetProjectionRef(void) override;
100  CPLErr _SetProjection( const char * ) override;
101  const char *_GetGCPProjection() override;
102  CPLErr _SetGCPs( int nGCPCount, const GDAL_GCP *pasGCPList,
103  const char *pszGCPProjection ) override;
104 
105  private:
106  CPL_DISALLOW_COPY_ASSIGN(GDALProxyDataset)
107 };
108 
109 /* ******************************************************************** */
110 /* GDALProxyRasterBand */
111 /* ******************************************************************** */
112 
113 class CPL_DLL GDALProxyRasterBand : public GDALRasterBand
114 {
115  protected:
116  GDALProxyRasterBand() {}
117 
118  virtual GDALRasterBand* RefUnderlyingRasterBand() = 0;
119  virtual void UnrefUnderlyingRasterBand(GDALRasterBand* poUnderlyingRasterBand);
120 
121  CPLErr IReadBlock( int, int, void * ) override;
122  CPLErr IWriteBlock( int, int, void * ) override;
123  CPLErr IRasterIO( GDALRWFlag, int, int, int, int,
124  void *, int, int, GDALDataType,
125  GSpacing, GSpacing, GDALRasterIOExtraArg* psExtraArg ) override;
126 
127  public:
128  char **GetMetadataDomainList() override;
129  char **GetMetadata( const char * pszDomain ) override;
130  CPLErr SetMetadata( char ** papszMetadata,
131  const char * pszDomain ) override;
132  const char *GetMetadataItem( const char * pszName,
133  const char * pszDomain ) override;
134  CPLErr SetMetadataItem( const char * pszName,
135  const char * pszValue,
136  const char * pszDomain ) override;
137  CPLErr FlushCache(bool bAtClosing) override;
138  char **GetCategoryNames() override;
139  double GetNoDataValue( int *pbSuccess = nullptr ) 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;
144  const char *GetUnitType() override;
146  GDALColorTable *GetColorTable() override;
147  CPLErr Fill(double dfRealValue, double dfImaginaryValue = 0) override;
148 
149  CPLErr SetCategoryNames( char ** ) override;
150  CPLErr SetNoDataValue( double ) override;
151  CPLErr DeleteNoDataValue() override;
152  CPLErr SetColorTable( GDALColorTable * ) override;
154  CPLErr SetOffset( double ) override;
155  CPLErr SetScale( double ) override;
156  CPLErr SetUnitType( const char * ) override;
157 
158  CPLErr GetStatistics( int bApproxOK, int bForce,
159  double *pdfMin, double *pdfMax,
160  double *pdfMean, double *padfStdDev ) override;
161  CPLErr ComputeStatistics( int bApproxOK,
162  double *pdfMin, double *pdfMax,
163  double *pdfMean, double *pdfStdDev,
164  GDALProgressFunc, void *pProgressData ) override;
165  CPLErr SetStatistics( double dfMin, double dfMax,
166  double dfMean, double dfStdDev ) override;
167  CPLErr ComputeRasterMinMax( int, double* ) override;
168 
169  int HasArbitraryOverviews() override;
170  int GetOverviewCount() override;
171  GDALRasterBand *GetOverview( int ) override;
173  CPLErr BuildOverviews( const char *, int, int *,
174  GDALProgressFunc, void * ) override;
175 
176  CPLErr AdviseRead( int nXOff, int nYOff, int nXSize, int nYSize,
177  int nBufXSize, int nBufYSize,
178  GDALDataType eDT, char **papszOptions ) override;
179 
180  CPLErr GetHistogram( double dfMin, double dfMax,
181  int nBuckets, GUIntBig * panHistogram,
182  int bIncludeOutOfRange, int bApproxOK,
183  GDALProgressFunc, void *pProgressData ) override;
184 
185  CPLErr GetDefaultHistogram( double *pdfMin, double *pdfMax,
186  int *pnBuckets, GUIntBig ** ppanHistogram,
187  int bForce,
188  GDALProgressFunc, void *pProgressData) override;
189  CPLErr SetDefaultHistogram( double dfMin, double dfMax,
190  int nBuckets, GUIntBig *panHistogram ) override;
191 
193  CPLErr SetDefaultRAT( const GDALRasterAttributeTable * ) override;
194 
195  GDALRasterBand *GetMaskBand() override;
196  int GetMaskFlags() override;
197  CPLErr CreateMaskBand( int nFlags ) override;
198 
200  int *pnPixelSpace,
201  GIntBig *pnLineSpace,
202  char **papszOptions ) override;
203 
204  private:
205  CPL_DISALLOW_COPY_ASSIGN(GDALProxyRasterBand)
206 };
207 
208 /* ******************************************************************** */
209 /* GDALProxyPoolDataset */
210 /* ******************************************************************** */
211 
212 typedef struct _GDALProxyPoolCacheEntry GDALProxyPoolCacheEntry;
213 class GDALProxyPoolRasterBand;
214 
215 class CPL_DLL GDALProxyPoolDataset : public GDALProxyDataset
216 {
217  private:
218  GIntBig responsiblePID = -1;
219 
220  mutable char *pszProjectionRef = nullptr;
221  mutable OGRSpatialReference* m_poSRS = nullptr;
222  mutable OGRSpatialReference* m_poGCPSRS = 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;
228  int nGCPCount = 0;
229  GDAL_GCP *pasGCPList = nullptr;
230  CPLHashSet *metadataSet = nullptr;
231  CPLHashSet *metadataItemSet = nullptr;
232 
233  mutable GDALProxyPoolCacheEntry* cacheEntry = nullptr;
234  char *m_pszOwner = nullptr;
235 
236  GDALDataset *RefUnderlyingDataset(bool bForceOpen) const;
237 
238  GDALProxyPoolDataset( const char* pszSourceDatasetDescription,
239  GDALAccess eAccess,
240  int bShared,
241  const char* pszOwner );
242 
243  protected:
244  GDALDataset *RefUnderlyingDataset() const override;
245  void UnrefUnderlyingDataset(GDALDataset* poUnderlyingDataset) const override;
246 
247  friend class GDALProxyPoolRasterBand;
248 
249  public:
250  GDALProxyPoolDataset( const char* pszSourceDatasetDescription,
251  int nRasterXSize, int nRasterYSize,
252  GDALAccess eAccess = GA_ReadOnly,
253  int bShared = FALSE,
254  const char * pszProjectionRef = nullptr,
255  double * padfGeoTransform = nullptr,
256  const char* pszOwner = nullptr );
257 
258 
259  static GDALProxyPoolDataset* Create( const char* pszSourceDatasetDescription,
260  CSLConstList papszOpenOptions = nullptr,
261  GDALAccess eAccess = GA_ReadOnly,
262  int bShared = FALSE,
263  const char* pszOwner = nullptr );
264 
265  ~GDALProxyPoolDataset() override;
266 
267  void SetOpenOptions( CSLConstList papszOpenOptions );
268 
269  // If size (nBlockXSize&nBlockYSize) parameters is zero
270  // they will be loaded when RefUnderlyingRasterBand function is called.
271  // But in this case we cannot use them in other non-virtual methods before
272  // RefUnderlyingRasterBand fist call.
273  void AddSrcBandDescription( GDALDataType eDataType, int nBlockXSize,
274  int nBlockYSize );
275 
276  // Used by VRT SimpleSource to add a single GDALProxyPoolRasterBand while
277  // keeping all other bands initialized to a nullptr. This is under the assumption,
278  // VRT SimpleSource will not have to access any other bands than the one added.
279  void AddSrcBand(int nBand, GDALDataType eDataType, int nBlockXSize,
280  int nBlockYSize );
281  void FlushCache(bool bAtClosing) override;
282 
283  const OGRSpatialReference* GetSpatialRef() const override;
284  CPLErr SetSpatialRef(const OGRSpatialReference* poSRS) override;
285 
286  const char *_GetProjectionRef() override;
287  CPLErr _SetProjection( const char * ) override;
288 
289  CPLErr GetGeoTransform( double * ) override;
290  CPLErr SetGeoTransform( double * ) override;
291 
292  // Special behavior for the following methods : they return a pointer
293  // data type, that must be cached by the proxy, so it doesn't become invalid
294  // when the underlying object get closed.
295  char **GetMetadata( const char * pszDomain ) override;
296  const char *GetMetadataItem( const char * pszName,
297  const char * pszDomain ) override;
298 
299  void *GetInternalHandle( const char * pszRequest ) override;
300 
301  const char *_GetGCPProjection() override;
302  const OGRSpatialReference* GetGCPSpatialRef() const override;
303  const GDAL_GCP *GetGCPs() override;
304 
305  private:
306  CPL_DISALLOW_COPY_ASSIGN(GDALProxyPoolDataset)
307 };
308 
309 /* ******************************************************************** */
310 /* GDALProxyPoolRasterBand */
311 /* ******************************************************************** */
312 
313 class GDALProxyPoolOverviewRasterBand;
314 class GDALProxyPoolMaskBand;
315 
316 class CPL_DLL GDALProxyPoolRasterBand : public GDALProxyRasterBand
317 {
318  private:
319  CPLHashSet *metadataSet = nullptr;
320  CPLHashSet *metadataItemSet = nullptr;
321  char *pszUnitType = nullptr;
322  char **papszCategoryNames = nullptr;
323  GDALColorTable *poColorTable = nullptr;
324 
325  int nSizeProxyOverviewRasterBand = 0;
326  GDALProxyPoolOverviewRasterBand **papoProxyOverviewRasterBand = nullptr;
327  GDALProxyPoolMaskBand *poProxyMaskBand = nullptr;
328 
329  GDALRasterBand* RefUnderlyingRasterBand( bool bForceOpen );
330 
331  protected:
332  GDALRasterBand* RefUnderlyingRasterBand() override;
333  void UnrefUnderlyingRasterBand( GDALRasterBand* poUnderlyingRasterBand )
334  override;
335 
336  friend class GDALProxyPoolOverviewRasterBand;
337  friend class GDALProxyPoolMaskBand;
338 
339  public:
340  GDALProxyPoolRasterBand( GDALProxyPoolDataset* poDS, int nBand,
341  GDALDataType eDataType,
342  int nBlockXSize, int nBlockYSize );
343  GDALProxyPoolRasterBand( GDALProxyPoolDataset* poDS,
344  GDALRasterBand* poUnderlyingRasterBand );
345  ~GDALProxyPoolRasterBand() override;
346 
347  void AddSrcMaskBandDescription( GDALDataType eDataType, int nBlockXSize,
348  int nBlockYSize );
349 
350  void AddSrcMaskBandDescriptionFromUnderlying();
351 
352  // Special behavior for the following methods : they return a pointer
353  // data type, that must be cached by the proxy, so it doesn't become invalid
354  // when the underlying object get closed.
355  char **GetMetadata( const char * pszDomain ) override;
356  const char *GetMetadataItem( const char * pszName,
357  const char * pszDomain ) override;
358  char **GetCategoryNames() override;
359  const char *GetUnitType() override;
360  GDALColorTable *GetColorTable() override;
361  GDALRasterBand *GetOverview( int ) override;
362  GDALRasterBand *GetRasterSampleOverview( GUIntBig nDesiredSamples ) override; // TODO
363  GDALRasterBand *GetMaskBand() override;
364 
365  CPLErr FlushCache(bool bAtClosing) override;
366 
367  private:
368  CPL_DISALLOW_COPY_ASSIGN(GDALProxyPoolRasterBand)
369 };
370 
371 /* ******************************************************************** */
372 /* GDALProxyPoolOverviewRasterBand */
373 /* ******************************************************************** */
374 
375 class GDALProxyPoolOverviewRasterBand : public GDALProxyPoolRasterBand
376 {
377  private:
378  GDALProxyPoolRasterBand *poMainBand = nullptr;
379  int nOverviewBand = 0;
380 
381  GDALRasterBand *poUnderlyingMainRasterBand = nullptr;
382  int nRefCountUnderlyingMainRasterBand = 0;
383 
384  CPL_DISALLOW_COPY_ASSIGN(GDALProxyPoolOverviewRasterBand)
385 
386  protected:
387  GDALRasterBand* RefUnderlyingRasterBand() override;
388  void UnrefUnderlyingRasterBand( GDALRasterBand* poUnderlyingRasterBand )
389  override;
390 
391  public:
392  GDALProxyPoolOverviewRasterBand( GDALProxyPoolDataset* poDS,
393  GDALRasterBand* poUnderlyingOverviewBand,
394  GDALProxyPoolRasterBand* poMainBand,
395  int nOverviewBand );
396  ~GDALProxyPoolOverviewRasterBand() override;
397 };
398 
399 /* ******************************************************************** */
400 /* GDALProxyPoolMaskBand */
401 /* ******************************************************************** */
402 
403 class GDALProxyPoolMaskBand : public GDALProxyPoolRasterBand
404 {
405  private:
406  GDALProxyPoolRasterBand *poMainBand = nullptr;
407 
408  GDALRasterBand *poUnderlyingMainRasterBand = nullptr;
409  int nRefCountUnderlyingMainRasterBand = 0;
410 
411  CPL_DISALLOW_COPY_ASSIGN(GDALProxyPoolMaskBand)
412 
413  protected:
414  GDALRasterBand* RefUnderlyingRasterBand() override;
415  void UnrefUnderlyingRasterBand( GDALRasterBand* poUnderlyingRasterBand )
416  override;
417 
418  public:
419  GDALProxyPoolMaskBand( GDALProxyPoolDataset* poDS,
420  GDALRasterBand* poUnderlyingMaskBand,
421  GDALProxyPoolRasterBand* poMainBand );
422  GDALProxyPoolMaskBand( GDALProxyPoolDataset* poDS,
423  GDALProxyPoolRasterBand* poMainBand,
424  GDALDataType eDataType,
425  int nBlockXSize, int nBlockYSize );
426  ~GDALProxyPoolMaskBand() override;
427 };
428 
429 #endif
430 
431 /* ******************************************************************** */
432 /* C types and methods declarations */
433 /* ******************************************************************** */
434 
436 
437 typedef struct GDALProxyPoolDatasetHS *GDALProxyPoolDatasetH;
438 
439 GDALProxyPoolDatasetH CPL_DLL GDALProxyPoolDatasetCreate(const char* pszSourceDatasetDescription,
440  int nRasterXSize, int nRasterYSize,
441  GDALAccess eAccess, int bShared,
442  const char * pszProjectionRef,
443  double * padfGeoTransform);
444 
445 void CPL_DLL GDALProxyPoolDatasetDelete(GDALProxyPoolDatasetH hProxyPoolDataset);
446 
447 void CPL_DLL GDALProxyPoolDatasetAddSrcBandDescription( GDALProxyPoolDatasetH hProxyPoolDataset,
448  GDALDataType eDataType,
449  int nBlockXSize, int nBlockYSize);
450 
451 CPL_C_END
452 
453 #endif /* #ifndef DOXYGEN_SKIP */
454 
455 #endif /* GDAL_PROXY_H_INCLUDED */
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:1315
virtual CPLErr GetGeoTransform(double *padfTransform)
Fetch the affine transformation coefficients.
Definition: gdaldataset.cpp:1177
virtual CPLVirtualMem * GetVirtualMemAuto(GDALRWFlag eRWFlag, int *pnPixelSpace, GIntBig *pnLineSpace, char **papszOptions)
Create a CPLVirtualMem object from a GDAL raster band object.
Definition: gdalrasterband.cpp:6658
GDALDataType
Definition: gdal.h:62
virtual CPLErr SetCategoryNames(char **papszNames)
Set the category names for this band.
Definition: gdalrasterband.cpp:1573
virtual GDALRasterBand * GetMaskBand()
Return the mask band associated with the band.
Definition: gdalrasterband.cpp:5957
virtual char ** GetCategoryNames()
Fetch the list of category names for this raster.
Definition: gdalrasterband.cpp:1525
virtual int HasArbitraryOverviews()
Check for arbitrary overviews.
Definition: gdalrasterband.cpp:2157
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:329
virtual GDALRasterBand * GetOverview(int)
Fetch overview raster band object.
Definition: gdalrasterband.cpp:2236
virtual CPLErr GetDefaultHistogram(double *pdfMin, double *pdfMax, int *pnBuckets, GUIntBig **ppanHistogram, int bForce, GDALProgressFunc, void *pProgressData)
Fetch default raster histogram.
Definition: gdalrasterband.cpp:3479
C++ GDAL entry points.
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
virtual GDALColorInterp GetColorInterpretation()
How should this band be interpreted as color?
Definition: gdalrasterband.cpp:1968
virtual CPLErr SetDefaultRAT(const GDALRasterAttributeTable *poRAT)
Set default Raster Attribute Table.
Definition: gdalrasterband.cpp:5872
GDALRWFlag
Definition: gdal.h:121
virtual CPLErr SetStatistics(double dfMin, double dfMax, double dfMean, double dfStdDev)
Set statistics on band.
Definition: gdalrasterband.cpp:5423
virtual void * GetInternalHandle(const char *pszHandleName)
Fetch a format specific internally meaningful handle.
Definition: gdaldataset.cpp:1277
virtual int GetMaskFlags()
Return the status flags of the mask band associated with the band.
Definition: gdalrasterband.cpp:6222
virtual GDALRasterAttributeTable * GetDefaultRAT()
Fetch default Raster Attribute Table.
Definition: gdalrasterband.cpp:5824
virtual char ** GetMetadata(const char *pszDomain="")
Fetch metadata.
Definition: gdalmajorobject.cpp:249
virtual CPLErr BuildOverviews(const char *pszResampling, int nOverviews, int *panOverviewList, GDALProgressFunc pfnProgress, void *pProgressData)
Build raster overview(s)
Definition: gdalrasterband.cpp:2394
virtual CPLErr GetHistogram(double dfMin, double dfMax, int nBuckets, GUIntBig *panHistogram, int bIncludeOutOfRange, int bApproxOK, GDALProgressFunc, void *pProgressData)
Compute raster histogram.
Definition: gdalrasterband.cpp:2937
Hash set implementation.
virtual CPLErr ComputeStatistics(int bApproxOK, double *pdfMin, double *pdfMax, double *pdfMean, double *pdfStdDev, GDALProgressFunc, void *pProgressData)
Compute image statistics.
Definition: gdalrasterband.cpp:4927
virtual CPLErr SetOffset(double dfNewOffset)
Set scaling offset.
Definition: gdalrasterband.cpp:2484
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 static void char ** GetMetadata(const char *pszDomain="") override
Fetch metadata.
Definition: gdaldataset.cpp:4229
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(bool bAtClosing=false)
Flush raster data cache.
Definition: gdalrasterband.cpp:1022
GIntBig GSpacing
Type to express pixel, line or band spacing.
Definition: gdal.h:286
virtual CPLErr SetDefaultHistogram(double dfMin, double dfMax, int nBuckets, GUIntBig *panHistogram)
Set default histogram.
Definition: gdalrasterband.cpp:5725
virtual double GetScale(int *pbSuccess=nullptr)
Fetch the raster value scale.
Definition: gdalrasterband.cpp:2541
virtual const char * GetMetadataItem(const char *pszName, const char *pszDomain="")
Fetch single metadata item.
Definition: gdalmajorobject.cpp:344
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:3694
virtual const GDAL_GCP * GetGCPs()
Fetch GCPs.
Definition: gdaldataset.cpp:1729
virtual CPLErr SetGCPs(int nGCPCount, const GDAL_GCP *pasGCPList, const OGRSpatialReference *poGCP_SRS)
Assign GCPs.
Definition: gdaldataset.cpp:1834
Public (C callable) GDAL entry points.
virtual CPLErr DeleteNoDataValue()
Remove the no data value for this band.
Definition: gdalrasterband.cpp:1738
virtual CPLErr SetSpatialRef(const OGRSpatialReference *poSRS)
Set the spatial reference system for this dataset.
Definition: gdaldataset.cpp:1059
virtual const OGRSpatialReference * GetSpatialRef() const
Fetch the spatial reference for this dataset.
Definition: gdaldataset.cpp:928
virtual CPLErr SetGeoTransform(double *padfTransform)
Set the affine transformation coefficients.
Definition: gdaldataset.cpp:1232
virtual double GetNoDataValue(int *pbSuccess=nullptr)
Fetch the no data value for this band.
Definition: gdalrasterband.cpp:1625
virtual int GetGCPCount()
Get number of GCPs.
Definition: gdaldataset.cpp:1549
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1169
virtual void FlushCache(bool bAtClosing=false)
Flush all write cached data to disk.
Definition: gdaldataset.cpp:435
virtual CPLErr ComputeRasterMinMax(int, double *)
Compute the min/max values for a band.
Definition: gdalrasterband.cpp:5490
virtual CPLErr SetColorInterpretation(GDALColorInterp eColorInterp)
Set color interpretation of a band.
Definition: gdalrasterband.cpp:2013
Structure to pass extra arguments to RasterIO() method, must be initialized with INIT_RASTERIO_EXTRA_...
Definition: gdal.h:160
virtual const char * GetUnitType()
Return raster unit type.
Definition: gdalrasterband.cpp:2637
virtual const OGRSpatialReference * GetGCPSpatialRef() const
Get output spatial reference system for GCPs.
Definition: gdaldataset.cpp:1646
virtual CPLErr SetColorTable(GDALColorTable *poCT)
Set the raster color table.
Definition: gdalrasterband.cpp:2109
virtual double GetMinimum(int *pbSuccess=nullptr)
Fetch the minimum value for this band.
Definition: gdalrasterband.cpp:1881
virtual GDALColorTable * GetColorTable()
Fetch the color table associated with band.
Definition: gdalrasterband.cpp:2060
virtual CPLErr CreateMaskBand(int nFlagsIn)
Adds a mask band to the dataset.
Definition: gdaldataset.cpp:3147
unsigned long long GUIntBig
Large unsigned integer type (generally 64-bit unsigned integer type).
Definition: cpl_port.h:247
virtual char ** GetFileList(void)
Fetch files forming dataset.
Definition: gdaldataset.cpp:3026
This class represents an OpenGIS Spatial Reference System, and contains methods for converting betwee...
Definition: ogr_spatialref.h:157
virtual CPLErr SetScale(double dfNewScale)
Set scaling ratio.
Definition: gdalrasterband.cpp:2590
virtual CPLErr IWriteBlock(int nBlockXOff, int nBlockYOff, void *pData)
Write a block of data.
Definition: gdalrasterband.cpp:616
virtual double GetOffset(int *pbSuccess=nullptr)
Fetch the raster value offset.
Definition: gdalrasterband.cpp:2435
virtual int GetOverviewCount()
Return the number of overview layers available.
Definition: gdalrasterband.cpp:2194
CPLErr SetMetadataItem(const char *pszName, const char *pszValue, const char *pszDomain) override
Set single metadata item.
virtual CPLErr SetUnitType(const char *pszNewValue)
Set unit type.
Definition: gdalrasterband.cpp:2685
A single raster band (or channel).
Definition: gdal_priv.h:1133
GDALAccess
Definition: gdal.h:115
virtual CPLErr CreateMaskBand(int nFlagsIn)
Adds a mask band to the current band.
Definition: gdalrasterband.cpp:6303
A set of associated raster bands, usually from one file.
Definition: gdal_priv.h:339
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:331
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition: cpl_port.h:244
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 double GetMaximum(int *pbSuccess=nullptr)
Fetch the maximum value for this band.
Definition: gdalrasterband.cpp:1788
CPLErr SetMetadata(char **papszMetadata, const char *pszDomain) override
Set metadata.
virtual GDALRasterBand * GetRasterSampleOverview(GUIntBig)
Fetch best sampling overview.
Definition: gdalrasterband.cpp:2286
char ** GetMetadataDomainList() override
Fetch list of metadata domains.
Definition: gdaldataset.cpp:4330
GDALColorInterp
Definition: gdal.h:203
virtual CPLErr SetNoDataValue(double dfNoData)
Set the no data value for this band.
Definition: gdalrasterband.cpp:1684
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:3774
Definition: gdal.h:116
Format specific driver.
Definition: gdal_priv.h:1488
A color table / palette.
Definition: gdal_priv.h:1024
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:1379
Ground Control Point.
Definition: gdal.h:710
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:955