GDAL
gdal_proxy.h
1 /******************************************************************************
2  * $Id$
3  *
4  * Project: GDAL Core
5  * Purpose: GDAL Core C++/Private declarations
6  * Author: Even Rouault <even dot rouault at mines dash paris dot org>
7  *
8  ******************************************************************************
9  * Copyright (c) 2008-2014, Even Rouault <even dot rouault at mines-paris dot org>
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() 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() 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  protected:
239  GDALDataset *RefUnderlyingDataset() const override;
240  void UnrefUnderlyingDataset(GDALDataset* poUnderlyingDataset) const override;
241 
242  friend class GDALProxyPoolRasterBand;
243 
244  public:
245  GDALProxyPoolDataset( const char* pszSourceDatasetDescription,
246  int nRasterXSize, int nRasterYSize,
247  GDALAccess eAccess = GA_ReadOnly,
248  int bShared = FALSE,
249  const char * pszProjectionRef = nullptr,
250  double * padfGeoTransform = nullptr,
251  const char* pszOwner = nullptr );
252  ~GDALProxyPoolDataset() override;
253 
254  void SetOpenOptions( char** papszOpenOptions );
255  void AddSrcBandDescription( GDALDataType eDataType, int nBlockXSize,
256  int nBlockYSize );
257 
258  // Used by VRT SimpleSource to add a single GDALProxyPoolRasterBand while
259  // keeping all other bands initialized to a nullptr. This is under the assumption,
260  // VRT SimpleSource will not have to access any other bands than the one added.
261  void AddSrcBand(int nBand, GDALDataType eDataType, int nBlockXSize,
262  int nBlockYSize );
263  void FlushCache() override;
264 
265  const OGRSpatialReference* GetSpatialRef() const override;
266  CPLErr SetSpatialRef(const OGRSpatialReference* poSRS) override;
267 
268  const char *_GetProjectionRef() override;
269  CPLErr _SetProjection( const char * ) override;
270 
271  CPLErr GetGeoTransform( double * ) override;
272  CPLErr SetGeoTransform( double * ) override;
273 
274  // Special behaviour for the following methods : they return a pointer
275  // data type, that must be cached by the proxy, so it doesn't become invalid
276  // when the underlying object get closed.
277  char **GetMetadata( const char * pszDomain ) override;
278  const char *GetMetadataItem( const char * pszName,
279  const char * pszDomain ) override;
280 
281  void *GetInternalHandle( const char * pszRequest ) override;
282 
283  const char *_GetGCPProjection() override;
284  const OGRSpatialReference* GetGCPSpatialRef() const override;
285  const GDAL_GCP *GetGCPs() override;
286 
287  private:
288  CPL_DISALLOW_COPY_ASSIGN(GDALProxyPoolDataset)
289 };
290 
291 /* ******************************************************************** */
292 /* GDALProxyPoolRasterBand */
293 /* ******************************************************************** */
294 
295 class GDALProxyPoolOverviewRasterBand;
296 class GDALProxyPoolMaskBand;
297 
298 class CPL_DLL GDALProxyPoolRasterBand : public GDALProxyRasterBand
299 {
300  private:
301  CPLHashSet *metadataSet = nullptr;
302  CPLHashSet *metadataItemSet = nullptr;
303  char *pszUnitType = nullptr;
304  char **papszCategoryNames = nullptr;
305  GDALColorTable *poColorTable = nullptr;
306 
307  int nSizeProxyOverviewRasterBand = 0;
308  GDALProxyPoolOverviewRasterBand **papoProxyOverviewRasterBand = nullptr;
309  GDALProxyPoolMaskBand *poProxyMaskBand = nullptr;
310 
311  GDALRasterBand* RefUnderlyingRasterBand( bool bForceOpen );
312 
313  protected:
314  GDALRasterBand* RefUnderlyingRasterBand() override;
315  void UnrefUnderlyingRasterBand( GDALRasterBand* poUnderlyingRasterBand )
316  override;
317 
318  friend class GDALProxyPoolOverviewRasterBand;
319  friend class GDALProxyPoolMaskBand;
320 
321  public:
322  GDALProxyPoolRasterBand( GDALProxyPoolDataset* poDS, int nBand,
323  GDALDataType eDataType,
324  int nBlockXSize, int nBlockYSize );
325  GDALProxyPoolRasterBand( GDALProxyPoolDataset* poDS,
326  GDALRasterBand* poUnderlyingRasterBand );
327  ~GDALProxyPoolRasterBand() override;
328 
329  void AddSrcMaskBandDescription( GDALDataType eDataType, int nBlockXSize,
330  int nBlockYSize );
331 
332  // Special behaviour for the following methods : they return a pointer
333  // data type, that must be cached by the proxy, so it doesn't become invalid
334  // when the underlying object get closed.
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;
340  GDALColorTable *GetColorTable() override;
341  GDALRasterBand *GetOverview( int ) override;
342  GDALRasterBand *GetRasterSampleOverview( GUIntBig nDesiredSamples ) override; // TODO
343  GDALRasterBand *GetMaskBand() override;
344 
345  CPLErr FlushCache() override;
346 
347  private:
348  CPL_DISALLOW_COPY_ASSIGN(GDALProxyPoolRasterBand)
349 };
350 
351 /* ******************************************************************** */
352 /* GDALProxyPoolOverviewRasterBand */
353 /* ******************************************************************** */
354 
355 class GDALProxyPoolOverviewRasterBand : public GDALProxyPoolRasterBand
356 {
357  private:
358  GDALProxyPoolRasterBand *poMainBand = nullptr;
359  int nOverviewBand = 0;
360 
361  GDALRasterBand *poUnderlyingMainRasterBand = nullptr;
362  int nRefCountUnderlyingMainRasterBand = 0;
363 
364  CPL_DISALLOW_COPY_ASSIGN(GDALProxyPoolOverviewRasterBand)
365 
366  protected:
367  GDALRasterBand* RefUnderlyingRasterBand() override;
368  void UnrefUnderlyingRasterBand( GDALRasterBand* poUnderlyingRasterBand )
369  override;
370 
371  public:
372  GDALProxyPoolOverviewRasterBand( GDALProxyPoolDataset* poDS,
373  GDALRasterBand* poUnderlyingOverviewBand,
374  GDALProxyPoolRasterBand* poMainBand,
375  int nOverviewBand );
376  ~GDALProxyPoolOverviewRasterBand() override;
377 };
378 
379 /* ******************************************************************** */
380 /* GDALProxyPoolMaskBand */
381 /* ******************************************************************** */
382 
383 class GDALProxyPoolMaskBand : public GDALProxyPoolRasterBand
384 {
385  private:
386  GDALProxyPoolRasterBand *poMainBand = nullptr;
387 
388  GDALRasterBand *poUnderlyingMainRasterBand = nullptr;
389  int nRefCountUnderlyingMainRasterBand = 0;
390 
391  CPL_DISALLOW_COPY_ASSIGN(GDALProxyPoolMaskBand)
392 
393  protected:
394  GDALRasterBand* RefUnderlyingRasterBand() override;
395  void UnrefUnderlyingRasterBand( GDALRasterBand* poUnderlyingRasterBand )
396  override;
397 
398  public:
399  GDALProxyPoolMaskBand( GDALProxyPoolDataset* poDS,
400  GDALRasterBand* poUnderlyingMaskBand,
401  GDALProxyPoolRasterBand* poMainBand );
402  GDALProxyPoolMaskBand( GDALProxyPoolDataset* poDS,
403  GDALProxyPoolRasterBand* poMainBand,
404  GDALDataType eDataType,
405  int nBlockXSize, int nBlockYSize );
406  ~GDALProxyPoolMaskBand() override;
407 };
408 
409 #endif
410 
411 /* ******************************************************************** */
412 /* C types and methods declarations */
413 /* ******************************************************************** */
414 
416 
417 typedef struct GDALProxyPoolDatasetHS *GDALProxyPoolDatasetH;
418 
419 GDALProxyPoolDatasetH CPL_DLL GDALProxyPoolDatasetCreate(const char* pszSourceDatasetDescription,
420  int nRasterXSize, int nRasterYSize,
421  GDALAccess eAccess, int bShared,
422  const char * pszProjectionRef,
423  double * padfGeoTransform);
424 
425 void CPL_DLL GDALProxyPoolDatasetDelete(GDALProxyPoolDatasetH hProxyPoolDataset);
426 
427 void CPL_DLL GDALProxyPoolDatasetAddSrcBandDescription( GDALProxyPoolDatasetH hProxyPoolDataset,
428  GDALDataType eDataType,
429  int nBlockXSize, int nBlockYSize);
430 
431 CPL_C_END
432 
433 #endif /* #ifndef DOXYGEN_SKIP */
434 
435 #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: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
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: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
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: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
Structure to pass extra arguments to RasterIO() method.
Definition: gdal.h:147
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
Definition: gdal.h:114
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

Generated for GDAL by doxygen 1.8.8.