GDAL
gdal_pam.h
1 /******************************************************************************
2  * $Id: gdal_pam.h 4b46f534fed80d31c3e15c1517169f40694a4a3e 2021-10-14 19:17:37 +0200 Even Rouault $
3  *
4  * Project: GDAL Core
5  * Purpose: Declaration for Peristable Auxiliary Metadata classes.
6  * Author: Frank Warmerdam, warmerdam@pobox.com
7  *
8  ******************************************************************************
9  * Copyright (c) 2005, Frank Warmerdam <warmerdam@pobox.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_PAM_H_INCLUDED
31 #define GDAL_PAM_H_INCLUDED
32 
34 
35 #include "cpl_minixml.h"
36 #include "gdal_priv.h"
37 #include <map>
38 #include <vector>
39 
40 class GDALPamRasterBand;
41 
42 /* Clone Info Flags */
43 
44 #define GCIF_GEOTRANSFORM 0x01
45 #define GCIF_PROJECTION 0x02
46 #define GCIF_METADATA 0x04
47 #define GCIF_GCPS 0x08
48 
49 #define GCIF_NODATA 0x001000
50 #define GCIF_CATEGORYNAMES 0x002000
51 #define GCIF_MINMAX 0x004000
52 #define GCIF_SCALEOFFSET 0x008000
53 #define GCIF_UNITTYPE 0x010000
54 #define GCIF_COLORTABLE 0x020000
55 #define GCIF_COLORINTERP 0x020000
56 #define GCIF_BAND_METADATA 0x040000
57 #define GCIF_RAT 0x080000
58 #define GCIF_MASK 0x100000
59 #define GCIF_BAND_DESCRIPTION 0x200000
60 
61 #define GCIF_ONLY_IF_MISSING 0x10000000
62 #define GCIF_PROCESS_BANDS 0x20000000
63 
64 #define GCIF_PAM_DEFAULT (GCIF_GEOTRANSFORM | GCIF_PROJECTION | \
65  GCIF_METADATA | GCIF_GCPS | \
66  GCIF_NODATA | GCIF_CATEGORYNAMES | \
67  GCIF_MINMAX | GCIF_SCALEOFFSET | \
68  GCIF_UNITTYPE | GCIF_COLORTABLE | \
69  GCIF_COLORINTERP | GCIF_BAND_METADATA | \
70  GCIF_RAT | GCIF_MASK | \
71  GCIF_ONLY_IF_MISSING | GCIF_PROCESS_BANDS|\
72  GCIF_BAND_DESCRIPTION)
73 
74 /* GDAL PAM Flags */
75 /* ERO 2011/04/13 : GPF_AUXMODE seems to be unimplemented */
76 #define GPF_DIRTY 0x01 // .pam file needs to be written on close
77 #define GPF_TRIED_READ_FAILED 0x02 // no need to keep trying to read .pam.
78 #define GPF_DISABLED 0x04 // do not try any PAM stuff.
79 #define GPF_AUXMODE 0x08 // store info in .aux (HFA) file.
80 #define GPF_NOSAVE 0x10 // do not try to save pam info.
81 
82 /* ==================================================================== */
83 /* GDALDatasetPamInfo */
84 /* */
85 /* We make these things a separate structure of information */
86 /* primarily so we can modify it without altering the size of */
87 /* the GDALPamDataset. It is an effort to reduce ABI churn for */
88 /* driver plugins. */
89 /* ==================================================================== */
90 class GDALDatasetPamInfo
91 {
92 public:
93  char *pszPamFilename = nullptr;
94 
95  std::vector<CPLXMLTreeCloser> m_apoOtherNodes{};
96 
97  OGRSpatialReference* poSRS = nullptr;
98 
99  int bHaveGeoTransform = false;
100  double adfGeoTransform[6]{0,0,0,0,0,0};
101 
102  int nGCPCount = 0;
103  GDAL_GCP *pasGCPList = nullptr;
104  OGRSpatialReference* poGCP_SRS = nullptr;
105 
106  CPLString osPhysicalFilename{};
107  CPLString osSubdatasetName{};
108  CPLString osAuxFilename{};
109 
110  int bHasMetadata = false;
111 };
113 
114 /* ******************************************************************** */
115 /* GDALPamDataset */
116 /* ******************************************************************** */
117 
119 class CPL_DLL GDALPamDataset : public GDALDataset
120 {
121  friend class GDALPamRasterBand;
122 
123  private:
124  int IsPamFilenameAPotentialSiblingFile();
125 
126  protected:
127 
128  GDALPamDataset(void);
130  int nPamFlags = 0;
131  GDALDatasetPamInfo *psPam = nullptr;
132 
133  virtual const char *_GetProjectionRef() override;
134  virtual const char *_GetGCPProjection() override;
135  virtual CPLErr _SetProjection( const char * pszProjection ) override;
136  virtual CPLErr _SetGCPs( int nGCPCount, const GDAL_GCP *pasGCPList,
137  const char *pszGCPProjection ) override;
138 
139  virtual CPLXMLNode *SerializeToXML( const char *);
140  virtual CPLErr XMLInit( CPLXMLNode *, const char * );
141 
142  virtual CPLErr TryLoadXML(char **papszSiblingFiles = nullptr);
143  virtual CPLErr TrySaveXML();
144 
145  CPLErr TryLoadAux(char **papszSiblingFiles = nullptr);
146  CPLErr TrySaveAux();
147 
148  virtual const char *BuildPamFilename();
149 
150  void PamInitialize();
151  void PamClear();
152 
153  void SetPhysicalFilename( const char * );
154  const char *GetPhysicalFilename();
155  void SetSubdatasetName( const char *);
156  const char *GetSubdatasetName();
158 
159  public:
160  ~GDALPamDataset() override;
161 
162  void FlushCache(bool bAtClosing) override;
163 
164  const OGRSpatialReference* GetSpatialRef() const override;
165  CPLErr SetSpatialRef(const OGRSpatialReference* poSRS) override;
166 
167  CPLErr GetGeoTransform( double * ) override;
168  CPLErr SetGeoTransform( double * ) override;
169 
170  int GetGCPCount() override;
171  const OGRSpatialReference* GetGCPSpatialRef() const override;
172  const GDAL_GCP *GetGCPs() override;
173  using GDALDataset::SetGCPs;
174  CPLErr SetGCPs( int nGCPCount, const GDAL_GCP *pasGCPList,
175  const OGRSpatialReference* poSRS ) override;
176 
177  CPLErr SetMetadata( char ** papszMetadata,
178  const char * pszDomain = "" ) override;
179  CPLErr SetMetadataItem( const char * pszName,
180  const char * pszValue,
181  const char * pszDomain = "" ) override;
182  char **GetMetadata( const char * pszDomain = "" ) override;
183  const char *GetMetadataItem( const char * pszName,
184  const char * pszDomain = "" ) override;
185 
186  char **GetFileList(void) override;
187 
188  void ClearStatistics() override;
189 
191  virtual CPLErr CloneInfo( GDALDataset *poSrcDS, int nCloneInfoFlags );
192 
193  CPLErr IBuildOverviews( const char *pszResampling,
194  int nOverviews, int *panOverviewList,
195  int nListBands, int *panBandList,
196  GDALProgressFunc pfnProgress,
197  void * pProgressData ) override;
198 
199  // "semi private" methods.
200  void MarkPamDirty() { nPamFlags |= GPF_DIRTY; }
201  GDALDatasetPamInfo *GetPamInfo() { return psPam; }
202  int GetPamFlags() { return nPamFlags; }
203  void SetPamFlags(int nValue ) { nPamFlags = nValue; }
205 
206  private:
208 };
209 
211 /* ==================================================================== */
212 /* GDALRasterBandPamInfo */
213 /* */
214 /* We make these things a separate structure of information */
215 /* primarily so we can modify it without altering the size of */
216 /* the GDALPamDataset. It is an effort to reduce ABI churn for */
217 /* driver plugins. */
218 /* ==================================================================== */
219 typedef struct {
220  GDALPamDataset *poParentDS;
221 
222  int bNoDataValueSet;
223  double dfNoDataValue;
224 
225  GDALColorTable *poColorTable;
226 
227  GDALColorInterp eColorInterp;
228 
229  char *pszUnitType;
230  char **papszCategoryNames;
231 
232  double dfOffset;
233  double dfScale;
234 
235  int bHaveMinMax;
236  double dfMin;
237  double dfMax;
238 
239  int bHaveStats;
240  double dfMean;
241  double dfStdDev;
242 
243  CPLXMLNode *psSavedHistograms;
244 
245  GDALRasterAttributeTable *poDefaultRAT;
246 
247  bool bOffsetSet;
248  bool bScaleSet;
249 } GDALRasterBandPamInfo;
251 /* ******************************************************************** */
252 /* GDALPamRasterBand */
253 /* ******************************************************************** */
254 
256 class CPL_DLL GDALPamRasterBand : public GDALRasterBand
257 {
258  friend class GDALPamDataset;
259 
260  protected:
262  virtual CPLXMLNode *SerializeToXML( const char *pszVRTPath );
263  virtual CPLErr XMLInit( CPLXMLNode *, const char * );
264 
265  void PamInitialize();
266  void PamClear();
267 
268  GDALRasterBandPamInfo *psPam = nullptr;
270 
271  public:
274  explicit GDALPamRasterBand(int bForceCachedIO);
276  ~GDALPamRasterBand() override;
277 
278  void SetDescription( const char * ) override;
279 
280  CPLErr SetNoDataValue( double ) override;
281  double GetNoDataValue( int *pbSuccess = nullptr ) override;
282  CPLErr DeleteNoDataValue() override;
283 
284  CPLErr SetColorTable( GDALColorTable * ) override;
285  GDALColorTable *GetColorTable() override;
286 
287  CPLErr SetColorInterpretation( GDALColorInterp ) override;
288  GDALColorInterp GetColorInterpretation() override;
289 
290  const char *GetUnitType() override;
291  CPLErr SetUnitType( const char * ) override;
292 
293  char **GetCategoryNames() override;
294  CPLErr SetCategoryNames( char ** ) override;
295 
296  double GetOffset( int *pbSuccess = nullptr ) override;
297  CPLErr SetOffset( double ) override;
298  double GetScale( int *pbSuccess = nullptr ) override;
299  CPLErr SetScale( double ) override;
300 
301  CPLErr GetHistogram( double dfMin, double dfMax,
302  int nBuckets, GUIntBig * panHistogram,
303  int bIncludeOutOfRange, int bApproxOK,
304  GDALProgressFunc, void *pProgressData ) override;
305 
306  CPLErr GetDefaultHistogram( double *pdfMin, double *pdfMax,
307  int *pnBuckets, GUIntBig ** ppanHistogram,
308  int bForce,
309  GDALProgressFunc, void *pProgressData) override;
310 
311  CPLErr SetDefaultHistogram( double dfMin, double dfMax,
312  int nBuckets, GUIntBig *panHistogram ) override;
313 
314  CPLErr SetMetadata( char ** papszMetadata,
315  const char * pszDomain = "" ) override;
316  CPLErr SetMetadataItem( const char * pszName,
317  const char * pszValue,
318  const char * pszDomain = "" ) override;
319 
320  GDALRasterAttributeTable *GetDefaultRAT() override;
321  CPLErr SetDefaultRAT( const GDALRasterAttributeTable * ) override;
322 
324  // new in GDALPamRasterBand.
325  virtual CPLErr CloneInfo( GDALRasterBand *poSrcBand, int nCloneInfoFlags );
326 
327  // "semi private" methods.
328  GDALRasterBandPamInfo *GetPamInfo() { return psPam; }
330  private:
332 };
333 
335 
336 /* ******************************************************************** */
337 /* GDALPamMultiDim */
338 /* ******************************************************************** */
339 
343 class CPL_DLL GDALPamMultiDim
344 {
345  struct Private;
346  std::unique_ptr<Private> d;
347 
348  void Load();
349  void Save();
350 
351 public:
352  explicit GDALPamMultiDim(const std::string& osFilename);
353  virtual ~GDALPamMultiDim();
354 
355  std::shared_ptr<OGRSpatialReference> GetSpatialRef(const std::string& osArrayFullName);
356 
357  void SetSpatialRef(const std::string& osArrayFullName,
358  const OGRSpatialReference* poSRS);
359 
360  CPLErr GetStatistics( const std::string& osArrayFullName,
361  bool bApproxOK,
362  double *pdfMin, double *pdfMax,
363  double *pdfMean, double *pdfStdDev,
364  GUInt64* pnValidCount);
365 
366  void SetStatistics( const std::string& osArrayFullName,
367  bool bApproxStats,
368  double dfMin, double dfMax,
369  double dfMean, double dfStdDev,
370  GUInt64 nValidCount );
371 
372  void ClearStatistics();
373 
374  void ClearStatistics( const std::string& osArrayFullName );
375 };
376 
377 /* ******************************************************************** */
378 /* GDALPamMDArray */
379 /* ******************************************************************** */
380 
382 class CPL_DLL GDALPamMDArray: public GDALMDArray
383 {
384  std::shared_ptr<GDALPamMultiDim> m_poPam;
385 
386 protected:
387  GDALPamMDArray(const std::string& osParentName,
388  const std::string& osName,
389  const std::shared_ptr<GDALPamMultiDim>& poPam);
390 
391  bool SetStatistics( bool bApproxStats,
392  double dfMin, double dfMax,
393  double dfMean, double dfStdDev,
394  GUInt64 nValidCount ) override;
395 
396 public:
397  const std::shared_ptr<GDALPamMultiDim>& GetPAM() const { return m_poPam; }
398 
399  CPLErr GetStatistics( bool bApproxOK, bool bForce,
400  double *pdfMin, double *pdfMax,
401  double *pdfMean, double *padfStdDev,
402  GUInt64* pnValidCount,
403  GDALProgressFunc pfnProgress, void *pProgressData ) override;
404 
405  void ClearStatistics() override;
406 
407  bool SetSpatialRef(const OGRSpatialReference* poSRS) override;
408 
409  std::shared_ptr<OGRSpatialReference> GetSpatialRef() const override;
410 };
411 
412 // These are mainly helper functions for internal use.
413 int CPL_DLL PamParseHistogram( CPLXMLNode *psHistItem,
414  double *pdfMin, double *pdfMax,
415  int *pnBuckets, GUIntBig **ppanHistogram,
416  int *pbIncludeOutOfRange, int *pbApproxOK );
417 CPLXMLNode CPL_DLL *
418 PamFindMatchingHistogram( CPLXMLNode *psSavedHistograms,
419  double dfMin, double dfMax, int nBuckets,
420  int bIncludeOutOfRange, int bApproxOK );
421 CPLXMLNode CPL_DLL *
422 PamHistogramToXMLTree( double dfMin, double dfMax,
423  int nBuckets, GUIntBig * panHistogram,
424  int bIncludeOutOfRange, int bApprox );
425 
426 // For managing the proxy file database.
427 const char CPL_DLL * PamGetProxy( const char * );
428 const char CPL_DLL * PamAllocateProxy( const char * );
429 const char CPL_DLL * PamDeallocateProxy( const char * );
430 void CPL_DLL PamCleanProxyDB( void );
431 
433 
434 #endif /* ndef GDAL_PAM_H_INCLUDED */
Convenient string class based on std::string.
Definition: cpl_string.h:333
A color table / palette.
Definition: gdal_priv.h:1023
A set of associated raster bands, usually from one file.
Definition: gdal_priv.h:340
virtual void FlushCache(bool bAtClosing=false)
Flush all write cached data to disk.
Definition: gdaldataset.cpp:435
virtual int GetGCPCount()
Get number of GCPs.
Definition: gdaldataset.cpp:1519
virtual CPLErr GetGeoTransform(double *padfTransform)
Fetch the affine transformation coefficients.
Definition: gdaldataset.cpp:1177
virtual const OGRSpatialReference * GetGCPSpatialRef() const
Get output spatial reference system for GCPs.
Definition: gdaldataset.cpp:1616
virtual void ClearStatistics()
Clear statistics.
Definition: gdaldataset.cpp:8385
CPLErr SetMetadata(char **papszMetadata, const char *pszDomain) override
Set metadata.
virtual CPLErr SetSpatialRef(const OGRSpatialReference *poSRS)
Set the spatial reference system for this dataset.
Definition: gdaldataset.cpp:1059
virtual CPLErr SetGeoTransform(double *padfTransform)
Set the affine transformation coefficients.
Definition: gdaldataset.cpp:1232
virtual CPLErr SetGCPs(int nGCPCount, const GDAL_GCP *pasGCPList, const OGRSpatialReference *poGCP_SRS)
Assign GCPs.
Definition: gdaldataset.cpp:1804
virtual const OGRSpatialReference * GetSpatialRef() const
Fetch the spatial reference for this dataset.
Definition: gdaldataset.cpp:928
CPLErr SetMetadataItem(const char *pszName, const char *pszValue, const char *pszDomain) override
Set single metadata item.
void static void char ** GetMetadata(const char *pszDomain="") override
Fetch metadata.
Definition: gdaldataset.cpp:4199
virtual const GDAL_GCP * GetGCPs()
Fetch GCPs.
Definition: gdaldataset.cpp:1699
virtual char ** GetFileList(void)
Fetch files forming dataset.
Definition: gdaldataset.cpp:2996
Class modeling a multi-dimensional array.
Definition: gdal_priv.h:2373
virtual const char * GetMetadataItem(const char *pszName, const char *pszDomain="")
Fetch single metadata item.
Definition: gdalmajorobject.cpp:344
virtual void SetDescription(const char *)
Set object description.
Definition: gdalmajorobject.cpp:120
PAM dataset.
Definition: gdal_pam.h:120
PAM raster band.
Definition: gdal_pam.h:257
The GDALRasterAttributeTable (or RAT) class is used to encapsulate a table used to provide attribute ...
Definition: gdal_rat.h:48
A single raster band (or channel).
Definition: gdal_priv.h:1131
This class represents an OpenGIS Spatial Reference System, and contains methods for converting betwee...
Definition: ogr_spatialref.h:158
CPLErr
Error category.
Definition: cpl_error.h:53
Definitions for CPL mini XML Parser/Serializer.
unsigned long long GUIntBig
Large unsigned integer type (generally 64-bit unsigned integer type).
Definition: cpl_port.h:247
#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
GUIntBig GUInt64
Unsigned 64 bit integer type.
Definition: cpl_port.h:265
GDALColorInterp
Definition: gdal.h:204
C++ GDAL entry points.
Document node structure.
Definition: cpl_minixml.h:70
Ground Control Point.
Definition: gdal.h:711