30 #ifndef GDAL_PAM_H_INCLUDED
31 #define GDAL_PAM_H_INCLUDED
33 #include "gdal_priv.h"
39 #define GCIF_GEOTRANSFORM 0x01
40 #define GCIF_PROJECTION 0x02
41 #define GCIF_METADATA 0x04
42 #define GCIF_GCPS 0x08
44 #define GCIF_NODATA 0x001000
45 #define GCIF_CATEGORYNAMES 0x002000
46 #define GCIF_MINMAX 0x004000
47 #define GCIF_SCALEOFFSET 0x008000
48 #define GCIF_UNITTYPE 0x010000
49 #define GCIF_COLORTABLE 0x020000
50 #define GCIF_COLORINTERP 0x020000
51 #define GCIF_BAND_METADATA 0x040000
52 #define GCIF_RAT 0x080000
53 #define GCIF_MASK 0x100000
54 #define GCIF_BAND_DESCRIPTION 0x200000
56 #define GCIF_ONLY_IF_MISSING 0x10000000
57 #define GCIF_PROCESS_BANDS 0x20000000
59 #define GCIF_PAM_DEFAULT (GCIF_GEOTRANSFORM | GCIF_PROJECTION | \
60 GCIF_METADATA | GCIF_GCPS | \
61 GCIF_NODATA | GCIF_CATEGORYNAMES | \
62 GCIF_MINMAX | GCIF_SCALEOFFSET | \
63 GCIF_UNITTYPE | GCIF_COLORTABLE | \
64 GCIF_COLORINTERP | GCIF_BAND_METADATA | \
65 GCIF_RAT | GCIF_MASK | \
66 GCIF_ONLY_IF_MISSING | GCIF_PROCESS_BANDS|\
67 GCIF_BAND_DESCRIPTION)
71 #define GPF_DIRTY 0x01 // .pam file needs to be written on close
72 #define GPF_TRIED_READ_FAILED 0x02 // no need to keep trying to read .pam.
73 #define GPF_DISABLED 0x04 // do not try any PAM stuff.
74 #define GPF_AUXMODE 0x08 // store info in .aux (HFA) file.
75 #define GPF_NOSAVE 0x10 // do not try to save pam info.
92 int bHaveGeoTransform;
93 double adfGeoTransform[6];
97 char *pszGCPProjection;
113 int IsPamFilenameAPotentialSiblingFile();
121 virtual CPLXMLNode *SerializeToXML(
const char *);
122 virtual CPLErr XMLInit(
CPLXMLNode *,
const char * );
124 virtual CPLErr TryLoadXML(
char **papszSiblingFiles = NULL);
125 virtual CPLErr TrySaveXML();
127 CPLErr TryLoadAux(
char **papszSiblingFiles = NULL);
130 virtual const char *BuildPamFilename();
132 void PamInitialize();
135 void SetPhysicalFilename(
const char * );
136 const char *GetPhysicalFilename();
137 void SetSubdatasetName(
const char *);
138 const char *GetSubdatasetName();
155 const char *pszGCPProjection );
158 const char * pszDomain =
"" );
160 const char * pszValue,
161 const char * pszDomain =
"" );
162 virtual char **
GetMetadata(
const char * pszDomain =
"" );
164 const char * pszDomain =
"" );
168 virtual CPLErr CloneInfo(
GDALDataset *poSrcDS,
int nCloneInfoFlags );
170 virtual CPLErr IBuildOverviews(
const char *pszResampling,
171 int nOverviews,
int *panOverviewList,
172 int nListBands,
int *panBandList,
173 GDALProgressFunc pfnProgress,
174 void * pProgressData );
178 void MarkPamDirty() { nPamFlags |= GPF_DIRTY; }
180 int GetPamFlags() {
return nPamFlags; }
181 void SetPamFlags(
int nValue ) { nPamFlags = nValue; }
196 double dfNoDataValue;
203 char **papszCategoryNames;
231 virtual CPLXMLNode *SerializeToXML(
const char *pszVRTPath );
232 virtual CPLErr XMLInit(
CPLXMLNode *,
const char * );
234 void PamInitialize();
260 virtual double GetOffset(
int *pbSuccess = NULL );
262 virtual double GetScale(
int *pbSuccess = NULL );
265 virtual CPLErr
GetHistogram(
double dfMin,
double dfMax,
266 int nBuckets,
int * panHistogram,
267 int bIncludeOutOfRange,
int bApproxOK,
268 GDALProgressFunc,
void *pProgressData );
271 int *pnBuckets,
int ** ppanHistogram,
273 GDALProgressFunc,
void *pProgressData);
276 int nBuckets,
int *panHistogram );
279 const char * pszDomain =
"" );
281 const char * pszValue,
282 const char * pszDomain =
"" );
288 virtual CPLErr CloneInfo(
GDALRasterBand *poSrcBand,
int nCloneInfoFlags );
295 int CPL_DLL PamParseHistogram(
CPLXMLNode *psHistItem,
296 double *pdfMin,
double *pdfMax,
297 int *pnBuckets,
int **ppanHistogram,
298 int *pbIncludeOutOfRange,
int *pbApproxOK );
300 PamFindMatchingHistogram(
CPLXMLNode *psSavedHistograms,
301 double dfMin,
double dfMax,
int nBuckets,
302 int bIncludeOutOfRange,
int bApproxOK );
304 PamHistogramToXMLTree(
double dfMin,
double dfMax,
305 int nBuckets,
int * panHistogram,
306 int bIncludeOutOfRange,
int bApprox );
309 const char CPL_DLL * PamGetProxy(
const char * );
310 const char CPL_DLL * PamAllocateProxy(
const char * );
311 const char CPL_DLL * PamDeallocateProxy(
const char * );
312 void CPL_DLL PamCleanProxyDB(
void );
Raster Attribute Table container.
Definition: gdal_rat.h:61
Definition: gdal_pam.h:192
virtual CPLErr GetGeoTransform(double *)
Fetch the affine transformation coefficients.
Definition: gdaldataset.cpp:854
virtual double GetScale(int *pbSuccess=NULL)
Fetch the raster value scale.
Definition: gdalrasterband.cpp:2333
Document node structure.
Definition: cpl_minixml.h:65
virtual double GetNoDataValue(int *pbSuccess=NULL)
Fetch the no data value for this band.
Definition: gdalrasterband.cpp:1532
virtual char ** GetCategoryNames()
Fetch the list of category names for this raster.
Definition: gdalrasterband.cpp:1438
virtual void SetDescription(const char *)
Set object description.
Definition: gdalmajorobject.cpp:115
virtual void FlushCache(void)
Flush all write cached data to disk.
Definition: gdaldataset.cpp:330
virtual CPLErr GetDefaultHistogram(double *pdfMin, double *pdfMax, int *pnBuckets, int **ppanHistogram, int bForce, GDALProgressFunc, void *pProgressData)
Fetch default raster histogram.
Definition: gdalrasterband.cpp:3127
virtual CPLErr SetColorInterpretation(GDALColorInterp)
Set color interpretation of a band.
Definition: gdalrasterband.cpp:1844
virtual CPLErr SetProjection(const char *)
Set the projection reference string for this dataset.
Definition: gdaldataset.cpp:791
virtual GDALColorInterp GetColorInterpretation()
How should this band be interpreted as color?
Definition: gdalrasterband.cpp:1806
virtual CPLErr SetScale(double)
Set scaling ratio.
Definition: gdalrasterband.cpp:2376
virtual double GetOffset(int *pbSuccess=NULL)
Fetch the raster value offset.
Definition: gdalrasterband.cpp:2235
virtual const char * GetProjectionRef(void)
Fetch the projection definition string for this dataset.
Definition: gdaldataset.cpp:748
Definition: gdal_pam.h:85
virtual const GDALRasterAttributeTable * GetDefaultRAT()
Fetch default Raster Attribute Table.
Definition: gdalrasterband.cpp:4308
virtual char ** GetMetadata(const char *pszDomain="")
Fetch metadata.
Definition: gdalmajorobject.cpp:161
virtual CPLErr SetOffset(double)
Set scaling offset.
Definition: gdalrasterband.cpp:2278
Convenient string class based on std::string.
Definition: cpl_string.h:224
virtual CPLErr SetGCPs(int nGCPCount, const GDAL_GCP *pasGCPList, const char *pszGCPProjection)
Assign GCPs.
Definition: gdaldataset.cpp:1293
virtual CPLErr SetDefaultHistogram(double dfMin, double dfMax, int nBuckets, int *panHistogram)
Set default histogram.
Definition: gdalrasterband.cpp:4262
virtual CPLErr SetColorTable(GDALColorTable *)
Set the raster color table.
Definition: gdalrasterband.cpp:1936
virtual const char * GetMetadataItem(const char *pszName, const char *pszDomain="")
Fetch single metadata item.
Definition: gdalmajorobject.cpp:249
Definition: gdal_pam.h:225
virtual const GDAL_GCP * GetGCPs()
Fetch GCPs.
Definition: gdaldataset.cpp:1239
virtual CPLErr SetGeoTransform(double *)
Set the affine transformation coefficients.
Definition: gdaldataset.cpp:907
virtual CPLErr SetMetadata(char **papszMetadata, const char *pszDomain="")
Set metadata.
Definition: gdalmajorobject.cpp:204
virtual int GetGCPCount()
Get number of GCPs.
Definition: gdaldataset.cpp:1163
virtual CPLErr SetNoDataValue(double)
Set the no data value for this band.
Definition: gdalrasterband.cpp:1580
virtual const char * GetUnitType()
Return raster unit type.
Definition: gdalrasterband.cpp:2423
A subclass of GDALDataset which introduces the ability to save and restore auxilary information (coor...
Definition: gdal_pam.h:108
virtual GDALColorTable * GetColorTable()
Fetch the color table associated with band.
Definition: gdalrasterband.cpp:1891
virtual char ** GetFileList(void)
Fetch files forming dataset.
Definition: gdaldataset.cpp:1999
virtual const char * GetGCPProjection()
Get output projection for GCPs.
Definition: gdaldataset.cpp:1202
virtual CPLErr SetCategoryNames(char **)
Set the category names for this band.
Definition: gdalrasterband.cpp:1482
virtual CPLErr SetUnitType(const char *)
Set unit type.
Definition: gdalrasterband.cpp:2467
A single raster band (or channel).
Definition: gdal_priv.h:460
A set of associated raster bands, usually from one file.
Definition: gdal_priv.h:249
virtual CPLErr SetDefaultRAT(const GDALRasterAttributeTable *)
Set default Raster Attribute Table.
Definition: gdalrasterband.cpp:4350
GDALColorInterp
Definition: gdal.h:103
virtual CPLErr SetMetadataItem(const char *pszName, const char *pszValue, const char *pszDomain="")
Set single metadata item.
Definition: gdalmajorobject.cpp:292
virtual CPLErr GetHistogram(double dfMin, double dfMax, int nBuckets, int *panHistogram, int bIncludeOutOfRange, int bApproxOK, GDALProgressFunc, void *pProgressData)
Compute raster histogram.
Definition: gdalrasterband.cpp:2694
Definition: gdal_priv.h:432
Ground Control Point.
Definition: gdal.h:253