GDAL

- Main Page
- Related Pages
- Classes
- Files
- Download
- Issue Tracker

- File List
- File Members

gdal_pam.h
1 /******************************************************************************
2 * $Id$
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 "gdal_priv.h"
36
37 class GDALPamRasterBand;
38
39 /* Clone Info Flags */
40
41 #define GCIF_GEOTRANSFORM 0x01
42 #define GCIF_PROJECTION 0x02
43 #define GCIF_METADATA 0x04
44 #define GCIF_GCPS 0x08
45
46 #define GCIF_NODATA 0x001000
47 #define GCIF_CATEGORYNAMES 0x002000
48 #define GCIF_MINMAX 0x004000
49 #define GCIF_SCALEOFFSET 0x008000
50 #define GCIF_UNITTYPE 0x010000
51 #define GCIF_COLORTABLE 0x020000
52 #define GCIF_COLORINTERP 0x020000
53 #define GCIF_BAND_METADATA 0x040000
54 #define GCIF_RAT 0x080000
55 #define GCIF_MASK 0x100000
56 #define GCIF_BAND_DESCRIPTION 0x200000
57
58 #define GCIF_ONLY_IF_MISSING 0x10000000
59 #define GCIF_PROCESS_BANDS 0x20000000
60
61 #define GCIF_PAM_DEFAULT (GCIF_GEOTRANSFORM | GCIF_PROJECTION | \
62 GCIF_METADATA | GCIF_GCPS | \
63 GCIF_NODATA | GCIF_CATEGORYNAMES | \
64 GCIF_MINMAX | GCIF_SCALEOFFSET | \
65 GCIF_UNITTYPE | GCIF_COLORTABLE | \
66 GCIF_COLORINTERP | GCIF_BAND_METADATA | \
67 GCIF_RAT | GCIF_MASK | \
68 GCIF_ONLY_IF_MISSING | GCIF_PROCESS_BANDS|\
69 GCIF_BAND_DESCRIPTION)
70
71 /* GDAL PAM Flags */
72 /* ERO 2011/04/13 : GPF_AUXMODE seems to be unimplemented */
73 #define GPF_DIRTY 0x01 // .pam file needs to be written on close
74 #define GPF_TRIED_READ_FAILED 0x02 // no need to keep trying to read .pam.
75 #define GPF_DISABLED 0x04 // do not try any PAM stuff.
76 #define GPF_AUXMODE 0x08 // store info in .aux (HFA) file.
77 #define GPF_NOSAVE 0x10 // do not try to save pam info.
78
79 /* ==================================================================== */
80 /* GDALDatasetPamInfo */
81 /* */
82 /* We make these things a separate structure of information */
83 /* primarily so we can modify it without altering the size of */
84 /* the GDALPamDataset. It is an effort to reduce ABI churn for */
85 /* driver plugins. */
86 /* ==================================================================== */
87 class GDALDatasetPamInfo
88 {
89 public:
90 char *pszPamFilename = nullptr;
91
92 char *pszProjection = nullptr;
93
94 int bHaveGeoTransform = false;
95 double adfGeoTransform[6]{0,0,0,0,0,0};
96
97 int nGCPCount = 0;
98 GDAL_GCP *pasGCPList = nullptr;
99 char *pszGCPProjection = nullptr;
100
101 CPLString osPhysicalFilename{};
102 CPLString osSubdatasetName{};
103 CPLString osAuxFilename{};
104
105 int bHasMetadata = false;
106 };
108
109 /* ******************************************************************** */
110 /* GDALPamDataset */
111 /* ******************************************************************** */
112
114 class CPL_DLL GDALPamDataset : public GDALDataset
115 {
116 friend class GDALPamRasterBand;
117
118 private:
119 int IsPamFilenameAPotentialSiblingFile();
120
121 protected:
122
123 GDALPamDataset(void);
125 int nPamFlags = 0;
126 GDALDatasetPamInfo *psPam = nullptr;
127
128 virtual CPLXMLNode *SerializeToXML( const char *);
129 virtual CPLErr XMLInit( CPLXMLNode *, const char * );
130
131 virtual CPLErr TryLoadXML(char **papszSiblingFiles = nullptr);
132 virtual CPLErr TrySaveXML();
133
134 CPLErr TryLoadAux(char **papszSiblingFiles = nullptr);
135 CPLErr TrySaveAux();
136
137 virtual const char *BuildPamFilename();
138
139 void PamInitialize();
140 void PamClear();
141
142 void SetPhysicalFilename( const char * );
143 const char *GetPhysicalFilename();
144 void SetSubdatasetName( const char *);
145 const char *GetSubdatasetName();
147
148 public:
149 ~GDALPamDataset() override;
150
151 void FlushCache(void) override;
152
153 const char *GetProjectionRef(void) override;
154 CPLErr SetProjection( const char * ) override;
155
156 CPLErr GetGeoTransform( double * ) override;
157 CPLErr SetGeoTransform( double * ) override;
158
159 int GetGCPCount() override;
160 const char *GetGCPProjection() override;
161 const GDAL_GCP *GetGCPs() override;
162 CPLErr SetGCPs( int nGCPCount, const GDAL_GCP *pasGCPList,
163 const char *pszGCPProjection ) override;
164
165 CPLErr SetMetadata( char ** papszMetadata,
166 const char * pszDomain = "" ) override;
167 CPLErr SetMetadataItem( const char * pszName,
168 const char * pszValue,
169 const char * pszDomain = "" ) override;
170 char **GetMetadata( const char * pszDomain = "" ) override;
171 const char *GetMetadataItem( const char * pszName,
172 const char * pszDomain = "" ) override;
173
174 char **GetFileList(void) override;
175
177 virtual CPLErr CloneInfo( GDALDataset *poSrcDS, int nCloneInfoFlags );
178
179 CPLErr IBuildOverviews( const char *pszResampling,
180 int nOverviews, int *panOverviewList,
181 int nListBands, int *panBandList,
182 GDALProgressFunc pfnProgress,
183 void * pProgressData ) override;
184
185 // "semi private" methods.
186 void MarkPamDirty() { nPamFlags |= GPF_DIRTY; }
187 GDALDatasetPamInfo *GetPamInfo() { return psPam; }
188 int GetPamFlags() { return nPamFlags; }
189 void SetPamFlags(int nValue ) { nPamFlags = nValue; }
191
192 private:
193 CPL_DISALLOW_COPY_ASSIGN(GDALPamDataset)
194 };
195
197 /* ==================================================================== */
198 /* GDALRasterBandPamInfo */
199 /* */
200 /* We make these things a separate structure of information */
201 /* primarily so we can modify it without altering the size of */
202 /* the GDALPamDataset. It is an effort to reduce ABI churn for */
203 /* driver plugins. */
204 /* ==================================================================== */
205 typedef struct {
206 GDALPamDataset *poParentDS;
207
208 int bNoDataValueSet;
209 double dfNoDataValue;
210
211 GDALColorTable *poColorTable;
212
213 GDALColorInterp eColorInterp;
214
215 char *pszUnitType;
216 char **papszCategoryNames;
217
218 double dfOffset;
219 double dfScale;
220
221 int bHaveMinMax;
222 double dfMin;
223 double dfMax;
224
225 int bHaveStats;
226 double dfMean;
227 double dfStdDev;
228
229 CPLXMLNode *psSavedHistograms;
230
231 GDALRasterAttributeTable *poDefaultRAT;
232
233 } GDALRasterBandPamInfo;
235 /* ******************************************************************** */
236 /* GDALPamRasterBand */
237 /* ******************************************************************** */
238
240 class CPL_DLL GDALPamRasterBand : public GDALRasterBand
241 {
242 friend class GDALPamDataset;
243
244 protected:
246 virtual CPLXMLNode *SerializeToXML( const char *pszVRTPath );
247 virtual CPLErr XMLInit( CPLXMLNode *, const char * );
248
249 void PamInitialize();
250 void PamClear();
251
252 GDALRasterBandPamInfo *psPam = nullptr;
254
255 public:
256 GDALPamRasterBand();
258 explicit GDALPamRasterBand(int bForceCachedIO);
260 ~GDALPamRasterBand() override;
261
262 void SetDescription( const char * ) override;
263
264 CPLErr SetNoDataValue( double ) override;
265 double GetNoDataValue( int *pbSuccess = nullptr ) override;
266 CPLErr DeleteNoDataValue() override;
267
268 CPLErr SetColorTable( GDALColorTable * ) override;
269 GDALColorTable *GetColorTable() override;
270
271 CPLErr SetColorInterpretation( GDALColorInterp ) override;
272 GDALColorInterp GetColorInterpretation() override;
273
274 const char *GetUnitType() override;
275 CPLErr SetUnitType( const char * ) override;
276
277 char **GetCategoryNames() override;
278 CPLErr SetCategoryNames( char ** ) override;
279
280 double GetOffset( int *pbSuccess = nullptr ) override;
281 CPLErr SetOffset( double ) override;
282 double GetScale( int *pbSuccess = nullptr ) override;
283 CPLErr SetScale( double ) override;
284
285 CPLErr GetHistogram( double dfMin, double dfMax,
286 int nBuckets, GUIntBig * panHistogram,
287 int bIncludeOutOfRange, int bApproxOK,
288 GDALProgressFunc, void *pProgressData ) override;
289
290 CPLErr GetDefaultHistogram( double *pdfMin, double *pdfMax,
291 int *pnBuckets, GUIntBig ** ppanHistogram,
292 int bForce,
293 GDALProgressFunc, void *pProgressData) override;
294
295 CPLErr SetDefaultHistogram( double dfMin, double dfMax,
296 int nBuckets, GUIntBig *panHistogram ) override;
297
298 CPLErr SetMetadata( char ** papszMetadata,
299 const char * pszDomain = "" ) override;
300 CPLErr SetMetadataItem( const char * pszName,
301 const char * pszValue,
302 const char * pszDomain = "" ) override;
303
304 GDALRasterAttributeTable *GetDefaultRAT() override;
305 CPLErr SetDefaultRAT( const GDALRasterAttributeTable * ) override;
306
308 // new in GDALPamRasterBand.
309 virtual CPLErr CloneInfo( GDALRasterBand *poSrcBand, int nCloneInfoFlags );
310
311 // "semi private" methods.
312 GDALRasterBandPamInfo *GetPamInfo() { return psPam; }
314 private:
315 CPL_DISALLOW_COPY_ASSIGN(GDALPamRasterBand)
316 };
317
319 // These are mainly helper functions for internal use.
320 int CPL_DLL PamParseHistogram( CPLXMLNode *psHistItem,
321 double *pdfMin, double *pdfMax,
322 int *pnBuckets, GUIntBig **ppanHistogram,
323 int *pbIncludeOutOfRange, int *pbApproxOK );
324 CPLXMLNode CPL_DLL *
325 PamFindMatchingHistogram( CPLXMLNode *psSavedHistograms,
326 double dfMin, double dfMax, int nBuckets,
327 int bIncludeOutOfRange, int bApproxOK );
328 CPLXMLNode CPL_DLL *
329 PamHistogramToXMLTree( double dfMin, double dfMax,
330 int nBuckets, GUIntBig * panHistogram,
331 int bIncludeOutOfRange, int bApprox );
332
333 // For managing the proxy file database.
334 const char CPL_DLL * PamGetProxy( const char * );
335 const char CPL_DLL * PamAllocateProxy( const char * );
336 const char CPL_DLL * PamDeallocateProxy( const char * );
337 void CPL_DLL PamCleanProxyDB( void );
338
340
341 #endif /* ndef GDAL_PAM_H_INCLUDED */
GDALRasterAttributeTable
The GDALRasterAttributeTable (or RAT) class is used to encapsulate a table used to provide attribute ...
Definition: gdal_rat.h:47
GDALDataset::GetGeoTransform
virtual CPLErr GetGeoTransform(double *padfTransform)
Fetch the affine transformation coefficients.
Definition: gdaldataset.cpp:922
GDALRasterBand::SetCategoryNames
virtual CPLErr SetCategoryNames(char **papszNames)
Set the category names for this band.
Definition: gdalrasterband.cpp:1552
CPLXMLNode
Document node structure.
Definition: cpl_minixml.h:66
GDALRasterBand::GetCategoryNames
virtual char ** GetCategoryNames()
Fetch the list of category names for this raster.
Definition: gdalrasterband.cpp:1504
GDALMajorObject::SetDescription
virtual void SetDescription(const char *)
Set object description.
Definition: gdalmajorobject.cpp:120
GDALDataset::FlushCache
virtual void FlushCache(void)
Flush all write cached data to disk.
Definition: gdaldataset.cpp:396
GDALRasterBand::GetDefaultHistogram
virtual CPLErr GetDefaultHistogram(double *pdfMin, double *pdfMax, int *pnBuckets, GUIntBig **ppanHistogram, int bForce, GDALProgressFunc, void *pProgressData)
Fetch default raster histogram.
Definition: gdalrasterband.cpp:3458
gdal_priv.h
C++ GDAL entry points.
GDALRasterBand::GetColorInterpretation
virtual GDALColorInterp GetColorInterpretation()
How should this band be interpreted as color?
Definition: gdalrasterband.cpp:1947
GDALDataset::GetProjectionRef
virtual const char * GetProjectionRef(void)
Fetch the projection definition string for this dataset.
Definition: gdaldataset.cpp:824
GDALRasterBand::SetDefaultRAT
virtual CPLErr SetDefaultRAT(const GDALRasterAttributeTable *poRAT)
Set default Raster Attribute Table.
Definition: gdalrasterband.cpp:5861
GDALRasterBand::GetDefaultRAT
virtual GDALRasterAttributeTable * GetDefaultRAT()
Fetch default Raster Attribute Table.
Definition: gdalrasterband.cpp:5813
GDALRasterBand::GetHistogram
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
CPLString
Convenient string class based on std::string.
Definition: cpl_string.h:329
GDALDataset::SetGCPs
virtual CPLErr SetGCPs(int nGCPCount, const GDAL_GCP *pasGCPList, const char *pszGCPProjection)
Assign GCPs.
Definition: gdaldataset.cpp:1382
GDALRasterBand::SetOffset
virtual CPLErr SetOffset(double dfNewOffset)
Set scaling offset.
Definition: gdalrasterband.cpp:2463
GDALRasterBand::SetMetadata
CPLErr SetMetadata(char **papszMetadata, const char *pszDomain) override
Set metadata.
GDALDataset::GetMetadata
void char ** GetMetadata(const char *pszDomain="") override
Fetch metadata.
Definition: gdaldataset.cpp:3484
GDALRasterBand::SetMetadataItem
CPLErr SetMetadataItem(const char *pszName, const char *pszValue, const char *pszDomain) override
Set single metadata item.
GDALRasterBand::SetDefaultHistogram
virtual CPLErr SetDefaultHistogram(double dfMin, double dfMax, int nBuckets, GUIntBig *panHistogram)
Set default histogram.
Definition: gdalrasterband.cpp:5714
GDALRasterBand::GetScale
virtual double GetScale(int *pbSuccess=nullptr)
Fetch the raster value scale.
Definition: gdalrasterband.cpp:2520
GDALPamRasterBand
PAM raster band.
Definition: gdal_pam.h:240
GDALDataset::GetGCPs
virtual const GDAL_GCP * GetGCPs()
Fetch GCPs.
Definition: gdaldataset.cpp:1332
GDALRasterBand::DeleteNoDataValue
virtual CPLErr DeleteNoDataValue()
Remove the no data value for this band.
Definition: gdalrasterband.cpp:1717
GDALDataset::SetGeoTransform
virtual CPLErr SetGeoTransform(double *padfTransform)
Set the affine transformation coefficients.
Definition: gdaldataset.cpp:977
GDALRasterBand::GetNoDataValue
virtual double GetNoDataValue(int *pbSuccess=nullptr)
Fetch the no data value for this band.
Definition: gdalrasterband.cpp:1604
GDALDataset::GetGCPCount
virtual int GetGCPCount()
Get number of GCPs.
Definition: gdaldataset.cpp:1264
GDALRasterBand::SetColorInterpretation
virtual CPLErr SetColorInterpretation(GDALColorInterp eColorInterp)
Set color interpretation of a band.
Definition: gdalrasterband.cpp:1992
GDALRasterBand::GetUnitType
virtual const char * GetUnitType()
Return raster unit type.
Definition: gdalrasterband.cpp:2616
GDALPamDataset
PAM dataset.
Definition: gdal_pam.h:114
GDALRasterBand::SetColorTable
virtual CPLErr SetColorTable(GDALColorTable *poCT)
Set the raster color table.
Definition: gdalrasterband.cpp:2088
GDALRasterBand::GetColorTable
virtual GDALColorTable * GetColorTable()
Fetch the color table associated with band.
Definition: gdalrasterband.cpp:2039
GUIntBig
unsigned long long GUIntBig
Large unsigned integer type (generally 64-bit unsigned integer type).
Definition: cpl_port.h:251
GDALDataset::GetFileList
virtual char ** GetFileList(void)
Fetch files forming dataset.
Definition: gdaldataset.cpp:2360
GDALDataset::SetProjection
virtual CPLErr SetProjection(const char *pszProjection)
Set the projection reference string for this dataset.
Definition: gdaldataset.cpp:864
GDALDataset::GetGCPProjection
virtual const char * GetGCPProjection()
Get output projection for GCPs.
Definition: gdaldataset.cpp:1299
GDALRasterBand::SetScale
virtual CPLErr SetScale(double dfNewScale)
Set scaling ratio.
Definition: gdalrasterband.cpp:2569
GDALRasterBand::GetOffset
virtual double GetOffset(int *pbSuccess=nullptr)
Fetch the raster value offset.
Definition: gdalrasterband.cpp:2414
GDALDataset::SetMetadataItem
CPLErr SetMetadataItem(const char *pszName, const char *pszValue, const char *pszDomain) override
Set single metadata item.
GDALRasterBand::SetUnitType
virtual CPLErr SetUnitType(const char *pszNewValue)
Set unit type.
Definition: gdalrasterband.cpp:2664
GDALRasterBand
A single raster band (or channel).
Definition: gdal_priv.h:1032
GDALDataset
A set of associated raster bands, usually from one file.
Definition: gdal_priv.h:335
GDALDataset::SetMetadata
CPLErr SetMetadata(char **papszMetadata, const char *pszDomain) override
Set metadata.
GDALColorInterp
GDALColorInterp
Definition: gdal.h:190
GDALRasterBand::SetNoDataValue
virtual CPLErr SetNoDataValue(double dfNoData)
Set the no data value for this band.
Definition: gdalrasterband.cpp:1663
GDALDataset::GetMetadataItem
const char * GetMetadataItem(const char *pszName, const char *pszDomain) override
Fetch single metadata item.
GDALColorTable
A color table / palette.
Definition: gdal_priv.h:937
GDAL_GCP
Ground Control Point.
Definition: gdal.h:560
CPLErr
CPLErr
Error category.
Definition: cpl_error.h:52
CPL_DISALLOW_COPY_ASSIGN
#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 1.8.8.