30 #ifndef GDAL_PAM_H_INCLUDED 31 #define GDAL_PAM_H_INCLUDED 41 #define GCIF_GEOTRANSFORM 0x01 42 #define GCIF_PROJECTION 0x02 43 #define GCIF_METADATA 0x04 44 #define GCIF_GCPS 0x08 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 58 #define GCIF_ONLY_IF_MISSING 0x10000000 59 #define GCIF_PROCESS_BANDS 0x20000000 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) 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. 87 class GDALDatasetPamInfo
94 int bHaveGeoTransform;
95 double adfGeoTransform[6];
99 char *pszGCPProjection;
119 int IsPamFilenameAPotentialSiblingFile();
126 GDALDatasetPamInfo *psPam;
128 virtual CPLXMLNode *SerializeToXML(
const char *);
131 virtual CPLErr TryLoadXML(
char **papszSiblingFiles = NULL);
132 virtual CPLErr TrySaveXML();
134 CPLErr TryLoadAux(
char **papszSiblingFiles = NULL);
137 virtual const char *BuildPamFilename();
139 void PamInitialize();
142 void SetPhysicalFilename(
const char * );
143 const char *GetPhysicalFilename();
144 void SetSubdatasetName(
const char *);
145 const char *GetSubdatasetName();
153 virtual const char *GetProjectionRef(
void)
CPL_OVERRIDE;
162 virtual CPLErr SetGCPs(
int nGCPCount,
const GDAL_GCP *pasGCPList,
168 const char * pszValue,
179 virtual CPLErr IBuildOverviews(
const char *pszResampling,
180 int nOverviews,
int *panOverviewList,
181 int nListBands,
int *panBandList,
182 GDALProgressFunc pfnProgress,
186 void MarkPamDirty() { nPamFlags |= GPF_DIRTY; }
187 GDALDatasetPamInfo *GetPamInfo() {
return psPam; }
188 int GetPamFlags() {
return nPamFlags; }
189 void SetPamFlags(
int nValue ) { nPamFlags = nValue; }
209 double dfNoDataValue;
216 char **papszCategoryNames;
233 } GDALRasterBandPamInfo;
246 virtual CPLXMLNode *SerializeToXML(
const char *pszVRTPath );
249 void PamInitialize();
252 GDALRasterBandPamInfo *psPam;
265 virtual double GetNoDataValue(
int *pbSuccess = NULL )
CPL_OVERRIDE;
280 virtual double GetOffset(
int *pbSuccess = NULL )
CPL_OVERRIDE;
282 virtual double GetScale(
int *pbSuccess = NULL )
CPL_OVERRIDE;
285 virtual CPLErr GetHistogram(
double dfMin,
double dfMax,
286 int nBuckets,
GUIntBig * panHistogram,
287 int bIncludeOutOfRange,
int bApproxOK,
290 virtual CPLErr GetDefaultHistogram(
double *pdfMin,
double *pdfMax,
291 int *pnBuckets,
GUIntBig ** ppanHistogram,
295 virtual CPLErr SetDefaultHistogram(
double dfMin,
double dfMax,
301 const char * pszValue,
312 GDALRasterBandPamInfo *GetPamInfo() {
return psPam; }
320 int CPL_DLL PamParseHistogram(
CPLXMLNode *psHistItem,
321 double *pdfMin,
double *pdfMax,
322 int *pnBuckets,
GUIntBig **ppanHistogram,
323 int *pbIncludeOutOfRange,
int *pbApproxOK );
325 PamFindMatchingHistogram(
CPLXMLNode *psSavedHistograms,
326 double dfMin,
double dfMax,
int nBuckets,
327 int bIncludeOutOfRange,
int bApproxOK );
329 PamHistogramToXMLTree(
double dfMin,
double dfMax,
330 int nBuckets,
GUIntBig * panHistogram,
331 int bIncludeOutOfRange,
int bApprox );
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 );
The GDALRasterAttributeTable (or RAT) class is used to encapsulate a table used to provide attribute ...
Definition: gdal_rat.h:46
Document node structure.
Definition: cpl_minixml.h:66
virtual void SetDescription(const char *)
Set object description.
Definition: gdalmajorobject.cpp:120
virtual CPLErr SetMetadata(char **papszMetadata, const char *pszDomain="") CPL_OVERRIDE
Set metadata.
Definition: gdalpamrasterband.cpp:688
#define CPL_OVERRIDE
To be used in public headers only.
Definition: cpl_port.h:1049
Convenient string class based on std::string.
Definition: cpl_string.h:338
virtual CPLErr FlushCache()
Flush raster data cache.
Definition: gdalrasterband.cpp:1026
PAM raster band.
Definition: gdal_pam.h:240
virtual char ** GetMetadata(const char *pszDomain="") CPL_OVERRIDE
Fetch metadata.
virtual const char * GetMetadataItem(const char *pszName, const char *pszDomain) CPL_OVERRIDE
Fetch single metadata item.
virtual CPLErr SetMetadataItem(const char *pszName, const char *pszValue, const char *pszDomain="") CPL_OVERRIDE
Set single metadata item.
Definition: gdalpamrasterband.cpp:704
virtual CPLErr SetMetadataItem(const char *pszName, const char *pszValue, const char *pszDomain="") CPL_OVERRIDE
Set single metadata item.
Definition: gdalpamdataset.cpp:1267
PAM dataset.
Definition: gdal_pam.h:114
unsigned long long GUIntBig
Large unsigned integer type (generally 64-bit unsigned integer type).
Definition: cpl_port.h:253
virtual CPLErr SetMetadata(char **papszMetadata, const char *pszDomain="") CPL_OVERRIDE
Set metadata.
Definition: gdalpamdataset.cpp:1248
A single raster band (or channel).
Definition: gdal_priv.h:829
A set of associated raster bands, usually from one file.
Definition: gdal_priv.h:322
GDALColorInterp
Definition: gdal.h:176
A color table / palette.
Definition: gdal_priv.h:749
Ground Control Point.
Definition: gdal.h:514
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:1073