30 #ifndef GDAL_PAM_H_INCLUDED
31 #define GDAL_PAM_H_INCLUDED
45 #define GCIF_GEOTRANSFORM 0x01
46 #define GCIF_PROJECTION 0x02
47 #define GCIF_METADATA 0x04
48 #define GCIF_GCPS 0x08
50 #define GCIF_NODATA 0x001000
51 #define GCIF_CATEGORYNAMES 0x002000
52 #define GCIF_MINMAX 0x004000
53 #define GCIF_SCALEOFFSET 0x008000
54 #define GCIF_UNITTYPE 0x010000
55 #define GCIF_COLORTABLE 0x020000
56 #define GCIF_COLORINTERP 0x020000
57 #define GCIF_BAND_METADATA 0x040000
58 #define GCIF_RAT 0x080000
59 #define GCIF_MASK 0x100000
60 #define GCIF_BAND_DESCRIPTION 0x200000
62 #define GCIF_ONLY_IF_MISSING 0x10000000
63 #define GCIF_PROCESS_BANDS 0x20000000
65 #define GCIF_PAM_DEFAULT \
66 (GCIF_GEOTRANSFORM | GCIF_PROJECTION | GCIF_METADATA | GCIF_GCPS | \
67 GCIF_NODATA | GCIF_CATEGORYNAMES | GCIF_MINMAX | GCIF_SCALEOFFSET | \
68 GCIF_UNITTYPE | GCIF_COLORTABLE | GCIF_COLORINTERP | GCIF_BAND_METADATA | \
69 GCIF_RAT | GCIF_MASK | GCIF_ONLY_IF_MISSING | GCIF_PROCESS_BANDS | \
70 GCIF_BAND_DESCRIPTION)
74 #define GPF_DIRTY 0x01 // .pam file needs to be written on close
75 #define GPF_TRIED_READ_FAILED 0x02 // no need to keep trying to read .pam.
76 #define GPF_DISABLED 0x04 // do not try any PAM stuff.
77 #define GPF_AUXMODE 0x08 // store info in .aux (HFA) file.
78 #define GPF_NOSAVE 0x10 // do not try to save pam info.
88 class GDALDatasetPamInfo
91 char *pszPamFilename =
nullptr;
93 std::vector<CPLXMLTreeCloser> m_apoOtherNodes{};
97 int bHaveGeoTransform =
false;
98 double adfGeoTransform[6]{0, 0, 0, 0, 0, 0};
108 int bHasMetadata =
false;
122 int IsPamFilenameAPotentialSiblingFile();
128 GDALDatasetPamInfo *psPam =
nullptr;
130 virtual CPLXMLNode *SerializeToXML(
const char *);
133 virtual CPLErr TryLoadXML(
char **papszSiblingFiles =
nullptr);
134 virtual CPLErr TrySaveXML();
136 CPLErr TryLoadAux(
char **papszSiblingFiles =
nullptr);
139 virtual const char *BuildPamFilename();
141 void PamInitialize();
144 void SetPhysicalFilename(
const char *);
145 const char *GetPhysicalFilename();
146 void SetSubdatasetName(
const char *);
147 const char *GetSubdatasetName();
160 void DeleteGeoTransform();
170 const char *pszDomain =
"")
override;
172 const char *pszDomain =
"")
override;
173 char **
GetMetadata(
const char *pszDomain =
"")
override;
175 const char *pszDomain =
"")
override;
184 CPLErr IBuildOverviews(
const char *pszResampling,
int nOverviews,
185 const int *panOverviewList,
int nListBands,
186 const int *panBandList, GDALProgressFunc pfnProgress,
193 nPamFlags |= GPF_DIRTY;
195 GDALDatasetPamInfo *GetPamInfo()
203 void SetPamFlags(
int nValue)
215 constexpr
double GDAL_PAM_DEFAULT_NODATA_VALUE = 0;
219 constexpr int64_t GDAL_PAM_DEFAULT_NODATA_VALUE_INT64 =
220 (std::numeric_limits<int64_t>::min)();
221 constexpr uint64_t GDAL_PAM_DEFAULT_NODATA_VALUE_UINT64 =
222 (std::numeric_limits<uint64_t>::max)();
232 struct GDALRasterBandPamInfo
236 bool bNoDataValueSet =
false;
237 bool bNoDataValueSetAsInt64 =
false;
238 bool bNoDataValueSetAsUInt64 =
false;
240 double dfNoDataValue = GDAL_PAM_DEFAULT_NODATA_VALUE;
241 int64_t nNoDataValueInt64 = GDAL_PAM_DEFAULT_NODATA_VALUE_INT64;
242 uint64_t nNoDataValueUInt64 = GDAL_PAM_DEFAULT_NODATA_VALUE_UINT64;
248 char *pszUnitType =
nullptr;
249 char **papszCategoryNames =
nullptr;
251 double dfOffset = 0.0;
252 double dfScale = 1.0;
254 int bHaveMinMax = FALSE;
258 int bHaveStats = FALSE;
266 bool bOffsetSet =
false;
267 bool bScaleSet =
false;
281 virtual CPLXMLNode *SerializeToXML(
const char *pszVRTPath);
284 void PamInitialize();
286 void PamInitializeNoParent();
289 GDALRasterBandPamInfo *psPam =
nullptr;
321 double GetOffset(
int *pbSuccess =
nullptr)
override;
323 double GetScale(
int *pbSuccess =
nullptr)
override;
327 GUIntBig *panHistogram,
int bIncludeOutOfRange,
328 int bApproxOK, GDALProgressFunc,
329 void *pProgressData)
override;
332 GUIntBig **ppanHistogram,
int bForce,
333 GDALProgressFunc,
void *pProgressData)
override;
339 const char *pszDomain =
"")
override;
341 const char *pszDomain =
"")
override;
351 GDALRasterBandPamInfo *GetPamInfo()
359 void ResetNoDataValues();
371 class CPL_DLL GDALPamMultiDim
374 std::unique_ptr<Private> d;
380 explicit GDALPamMultiDim(
const std::string &osFilename);
381 virtual ~GDALPamMultiDim();
383 std::shared_ptr<OGRSpatialReference>
384 GetSpatialRef(
const std::string &osArrayFullName);
386 void SetSpatialRef(
const std::string &osArrayFullName,
389 CPLErr GetStatistics(
const std::string &osArrayFullName,
bool bApproxOK,
390 double *pdfMin,
double *pdfMax,
double *pdfMean,
391 double *pdfStdDev,
GUInt64 *pnValidCount);
393 void SetStatistics(
const std::string &osArrayFullName,
bool bApproxStats,
394 double dfMin,
double dfMax,
double dfMean,
395 double dfStdDev,
GUInt64 nValidCount);
397 void ClearStatistics();
399 void ClearStatistics(
const std::string &osArrayFullName);
409 std::shared_ptr<GDALPamMultiDim> m_poPam;
412 GDALPamMDArray(
const std::string &osParentName,
const std::string &osName,
413 const std::shared_ptr<GDALPamMultiDim> &poPam);
415 bool SetStatistics(
bool bApproxStats,
double dfMin,
double dfMax,
416 double dfMean,
double dfStdDev,
420 const std::shared_ptr<GDALPamMultiDim> &GetPAM()
const
426 double *pdfMax,
double *pdfMean,
double *padfStdDev,
427 GUInt64 *pnValidCount, GDALProgressFunc pfnProgress,
428 void *pProgressData)
override;
434 std::shared_ptr<OGRSpatialReference>
GetSpatialRef()
const override;
438 int CPL_DLL PamParseHistogram(
CPLXMLNode *psHistItem,
double *pdfMin,
439 double *pdfMax,
int *pnBuckets,
441 int *pbIncludeOutOfRange,
int *pbApproxOK);
443 double dfMin,
double dfMax,
445 int bIncludeOutOfRange,
447 CPLXMLNode CPL_DLL *PamHistogramToXMLTree(
double dfMin,
double dfMax,
448 int nBuckets,
GUIntBig *panHistogram,
449 int bIncludeOutOfRange,
int bApprox);
452 const char CPL_DLL *PamGetProxy(
const char *);
453 const char CPL_DLL *PamAllocateProxy(
const char *);
454 const char CPL_DLL *PamDeallocateProxy(
const char *);
455 void CPL_DLL PamCleanProxyDB(
void);
virtual CPLErr SetNoDataValue(double dfNoData)
Set the no data value for this band.
Definition: gdalrasterband.cpp:1875
virtual std::shared_ptr< OGRSpatialReference > GetSpatialRef() const
Return the spatial reference system object associated with the array.
Definition: gdalmultidim.cpp:2262
virtual GDALColorTable * GetColorTable()
Fetch the color table associated with band.
Definition: gdalrasterband.cpp:2424
GUIntBig GUInt64
Unsigned 64 bit integer type.
Definition: cpl_port.h:258
virtual const char * GetUnitType()
Return raster unit type.
Definition: gdalrasterband.cpp:3005
virtual CPLErr DeleteNoDataValue()
Remove the no data value for this band.
Definition: gdalrasterband.cpp:2077
virtual double GetOffset(int *pbSuccess=nullptr)
Fetch the raster value offset.
Definition: gdalrasterband.cpp:2804
virtual CPLErr SetColorTable(GDALColorTable *poCT)
Set the raster color table.
Definition: gdalrasterband.cpp:2473
virtual CPLErr GetDefaultHistogram(double *pdfMin, double *pdfMax, int *pnBuckets, GUIntBig **ppanHistogram, int bForce, GDALProgressFunc, void *pProgressData)
Fetch default raster histogram.
Definition: gdalrasterband.cpp:3969
virtual CPLErr GetStatistics(bool bApproxOK, bool bForce, double *pdfMin, double *pdfMax, double *pdfMean, double *padfStdDev, GUInt64 *pnValidCount, GDALProgressFunc pfnProgress, void *pProgressData)
Fetch statistics.
Definition: gdalmultidim.cpp:8132
PAM dataset.
Definition: gdal_pam.h:117
PAM raster band.
Definition: gdal_pam.h:275
This class represents an OpenGIS Spatial Reference System, and contains methods for converting betwee...
Definition: ogr_spatialref.h:166
virtual CPLErr SetDefaultHistogram(double dfMin, double dfMax, int nBuckets, GUIntBig *panHistogram)
Set default histogram.
Definition: gdalrasterband.cpp:6791
virtual CPLErr SetUnitType(const char *pszNewValue)
Set unit type.
Definition: gdalrasterband.cpp:3053
virtual GDALColorInterp GetColorInterpretation()
How should this band be interpreted as color?
Definition: gdalrasterband.cpp:2335
virtual char ** GetCategoryNames()
Fetch the list of category names for this raster.
Definition: gdalrasterband.cpp:1586
GDALColorInterp
Definition: gdal.h:226
virtual void SetDescription(const char *)
Set object description.
Definition: gdalmajorobject.cpp:118
Convenient string class based on std::string.
Definition: cpl_string.h:311
A single raster band (or channel).
Definition: gdal_priv.h:1269
void static void char ** GetMetadata(const char *pszDomain="") override
Fetch metadata.
Definition: gdaldataset.cpp:4280
Document node structure.
Definition: cpl_minixml.h:69
virtual const char * GetMetadataItem(const char *pszName, const char *pszDomain="")
Fetch single metadata item.
Definition: gdalmajorobject.cpp:341
virtual CPLErr SetGCPs(int nGCPCount, const GDAL_GCP *pasGCPList, const OGRSpatialReference *poGCP_SRS)
Assign GCPs.
Definition: gdaldataset.cpp:1874
virtual const GDAL_GCP * GetGCPs()
Fetch GCPs.
Definition: gdaldataset.cpp:1767
A set of associated raster bands, usually from one file.
Definition: gdal_priv.h:347
virtual CPLErr SetNoDataValueAsInt64(int64_t nNoData)
Set the no data value for this band.
Definition: gdalrasterband.cpp:1947
Class modeling a multi-dimensional array.
Definition: gdal_priv.h:2697
virtual CPLErr SetDefaultRAT(const GDALRasterAttributeTable *poRAT)
Set default Raster Attribute Table.
Definition: gdalrasterband.cpp:6938
virtual bool SetSpatialRef(const OGRSpatialReference *poSRS)
Assign a spatial reference system object to the array.
Definition: gdalmultidim.cpp:2248
virtual void ClearStatistics()
Clear statistics.
Definition: gdaldataset.cpp:8500
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1195
unsigned long long GUIntBig
Large unsigned integer type (generally 64-bit unsigned integer type).
Definition: cpl_port.h:238
virtual const OGRSpatialReference * GetGCPSpatialRef() const
Get output spatial reference system for GCPs.
Definition: gdaldataset.cpp:1710
virtual CPLErr SetSpatialRef(const OGRSpatialReference *poSRS)
Set the spatial reference system for this dataset.
Definition: gdaldataset.cpp:1165
Ground Control Point.
Definition: gdal.h:1036
virtual int GetGCPCount()
Get number of GCPs.
Definition: gdaldataset.cpp:1625
@ GCI_Undefined
Definition: gdal.h:228
virtual CPLErr SetScale(double dfNewScale)
Set scaling ratio.
Definition: gdalrasterband.cpp:2959
virtual double GetNoDataValue(int *pbSuccess=nullptr)
Fetch the no data value for this band.
Definition: gdalrasterband.cpp:1690
virtual int64_t GetNoDataValueAsInt64(int *pbSuccess=nullptr)
Fetch the no data value for this band.
Definition: gdalrasterband.cpp:1746
virtual CPLErr SetNoDataValueAsUInt64(uint64_t nNoData)
Set the no data value for this band.
Definition: gdalrasterband.cpp:2019
virtual const OGRSpatialReference * GetSpatialRef() const
Fetch the spatial reference for this dataset.
Definition: gdaldataset.cpp:1060
virtual CPLErr SetGeoTransform(double *padfTransform)
Set the affine transformation coefficients.
Definition: gdaldataset.cpp:1298
virtual char ** GetFileList(void)
Fetch files forming dataset.
Definition: gdaldataset.cpp:3058
virtual GDALRasterAttributeTable * GetDefaultRAT()
Fetch default Raster Attribute Table.
Definition: gdalrasterband.cpp:6889
virtual double GetScale(int *pbSuccess=nullptr)
Fetch the raster value scale.
Definition: gdalrasterband.cpp:2910
virtual CPLErr SetColorInterpretation(GDALColorInterp eColorInterp)
Set color interpretation of a band.
Definition: gdalrasterband.cpp:2379
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:1634
virtual CPLErr GetHistogram(double dfMin, double dfMax, int nBuckets, GUIntBig *panHistogram, int bIncludeOutOfRange, int bApproxOK, GDALProgressFunc, void *pProgressData)
Compute raster histogram.
Definition: gdalrasterband.cpp:3306
virtual CPLErr GetGeoTransform(double *padfTransform)
Fetch the affine transformation coefficients.
Definition: gdaldataset.cpp:1244
CPLErr SetMetadata(char **papszMetadata, const char *pszDomain) override
Definition: gdal_rat.h:47
CPLErr SetMetadataItem(const char *pszName, const char *pszValue, const char *pszDomain) override
virtual CPLErr SetOffset(double dfNewOffset)
Set scaling offset.
Definition: gdalrasterband.cpp:2853
#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:1051
virtual uint64_t GetNoDataValueAsUInt64(int *pbSuccess=nullptr)
Fetch the no data value for this band.
Definition: gdalrasterband.cpp:1807
A color table / palette.
Definition: gdal_priv.h:1120
virtual CPLErr FlushCache(bool bAtClosing=false)
Flush all write cached data to disk.
Definition: gdaldataset.cpp:519
virtual void ClearStatistics()
Clear statistics.
Definition: gdalmultidim.cpp:8372