325 lines
12 KiB
C
325 lines
12 KiB
C
|
/******************************************************************************
|
||
|
|
* $Id: gdal_pam.h 33694 2016-03-10 17:54:30Z goatbar $
|
||
|
|
*
|
||
|
|
* Project: GDAL Core
|
||
|
|
* Purpose: Declaration for Peristable Auxiliary Metadata classes.
|
||
|
|
* Author: Frank Warmerdam, warmerdam@pobox.com
|
||
|
|
*
|
||
|
|
******************************************************************************
|
||
|
|
* Copyright (c) 2005, Frank Warmerdam <warmerdam@pobox.com>
|
||
|
|
*
|
||
|
|
* Permission is hereby granted, free of charge, to any person obtaining a
|
||
|
|
* copy of this software and associated documentation files (the "Software"),
|
||
|
|
* to deal in the Software without restriction, including without limitation
|
||
|
|
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
||
|
|
* and/or sell copies of the Software, and to permit persons to whom the
|
||
|
|
* Software is furnished to do so, subject to the following conditions:
|
||
|
|
*
|
||
|
|
* The above copyright notice and this permission notice shall be included
|
||
|
|
* in all copies or substantial portions of the Software.
|
||
|
|
*
|
||
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
||
|
|
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
|
||
|
|
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||
|
|
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
||
|
|
* DEALINGS IN THE SOFTWARE.
|
||
|
|
****************************************************************************/
|
||
|
|
|
||
|
|
#ifndef GDAL_PAM_H_INCLUDED
|
||
|
|
#define GDAL_PAM_H_INCLUDED
|
||
|
|
|
||
|
|
#include "gdal_priv.h"
|
||
|
|
|
||
|
|
class GDALPamRasterBand;
|
||
|
|
|
||
|
|
/* Clone Info Flags */
|
||
|
|
|
||
|
|
#define GCIF_GEOTRANSFORM 0x01
|
||
|
|
#define GCIF_PROJECTION 0x02
|
||
|
|
#define GCIF_METADATA 0x04
|
||
|
|
#define GCIF_GCPS 0x08
|
||
|
|
|
||
|
|
#define GCIF_NODATA 0x001000
|
||
|
|
#define GCIF_CATEGORYNAMES 0x002000
|
||
|
|
#define GCIF_MINMAX 0x004000
|
||
|
|
#define GCIF_SCALEOFFSET 0x008000
|
||
|
|
#define GCIF_UNITTYPE 0x010000
|
||
|
|
#define GCIF_COLORTABLE 0x020000
|
||
|
|
#define GCIF_COLORINTERP 0x020000
|
||
|
|
#define GCIF_BAND_METADATA 0x040000
|
||
|
|
#define GCIF_RAT 0x080000
|
||
|
|
#define GCIF_MASK 0x100000
|
||
|
|
#define GCIF_BAND_DESCRIPTION 0x200000
|
||
|
|
|
||
|
|
#define GCIF_ONLY_IF_MISSING 0x10000000
|
||
|
|
#define GCIF_PROCESS_BANDS 0x20000000
|
||
|
|
|
||
|
|
#define GCIF_PAM_DEFAULT (GCIF_GEOTRANSFORM | GCIF_PROJECTION | \
|
||
|
|
GCIF_METADATA | GCIF_GCPS | \
|
||
|
|
GCIF_NODATA | GCIF_CATEGORYNAMES | \
|
||
|
|
GCIF_MINMAX | GCIF_SCALEOFFSET | \
|
||
|
|
GCIF_UNITTYPE | GCIF_COLORTABLE | \
|
||
|
|
GCIF_COLORINTERP | GCIF_BAND_METADATA | \
|
||
|
|
GCIF_RAT | GCIF_MASK | \
|
||
|
|
GCIF_ONLY_IF_MISSING | GCIF_PROCESS_BANDS|\
|
||
|
|
GCIF_BAND_DESCRIPTION)
|
||
|
|
|
||
|
|
/* GDAL PAM Flags */
|
||
|
|
/* ERO 2011/04/13 : GPF_AUXMODE seems to be unimplemented */
|
||
|
|
#define GPF_DIRTY 0x01 // .pam file needs to be written on close
|
||
|
|
#define GPF_TRIED_READ_FAILED 0x02 // no need to keep trying to read .pam.
|
||
|
|
#define GPF_DISABLED 0x04 // do not try any PAM stuff.
|
||
|
|
#define GPF_AUXMODE 0x08 // store info in .aux (HFA) file.
|
||
|
|
#define GPF_NOSAVE 0x10 // do not try to save pam info.
|
||
|
|
|
||
|
|
/* ==================================================================== */
|
||
|
|
/* GDALDatasetPamInfo */
|
||
|
|
/* */
|
||
|
|
/* We make these things a separate structure of information */
|
||
|
|
/* primarily so we can modify it without altering the size of */
|
||
|
|
/* the GDALPamDataset. It is an effort to reduce ABI churn for */
|
||
|
|
/* driver plugins. */
|
||
|
|
/* ==================================================================== */
|
||
|
|
class GDALDatasetPamInfo
|
||
|
|
{
|
||
|
|
public:
|
||
|
|
char *pszPamFilename;
|
||
|
|
|
||
|
|
char *pszProjection;
|
||
|
|
|
||
|
|
int bHaveGeoTransform;
|
||
|
|
double adfGeoTransform[6];
|
||
|
|
|
||
|
|
int nGCPCount;
|
||
|
|
GDAL_GCP *pasGCPList;
|
||
|
|
char *pszGCPProjection;
|
||
|
|
|
||
|
|
CPLString osPhysicalFilename;
|
||
|
|
CPLString osSubdatasetName;
|
||
|
|
CPLString osAuxFilename;
|
||
|
|
|
||
|
|
int bHasMetadata;
|
||
|
|
};
|
||
|
|
|
||
|
|
/* ******************************************************************** */
|
||
|
|
/* GDALPamDataset */
|
||
|
|
/* ******************************************************************** */
|
||
|
|
|
||
|
|
class CPL_DLL GDALPamDataset : public GDALDataset
|
||
|
|
{
|
||
|
|
friend class GDALPamRasterBand;
|
||
|
|
|
||
|
|
private:
|
||
|
|
int IsPamFilenameAPotentialSiblingFile();
|
||
|
|
|
||
|
|
protected:
|
||
|
|
GDALPamDataset(void);
|
||
|
|
|
||
|
|
int nPamFlags;
|
||
|
|
GDALDatasetPamInfo *psPam;
|
||
|
|
|
||
|
|
virtual CPLXMLNode *SerializeToXML( const char *);
|
||
|
|
virtual CPLErr XMLInit( CPLXMLNode *, const char * );
|
||
|
|
|
||
|
|
virtual CPLErr TryLoadXML(char **papszSiblingFiles = NULL);
|
||
|
|
virtual CPLErr TrySaveXML();
|
||
|
|
|
||
|
|
CPLErr TryLoadAux(char **papszSiblingFiles = NULL);
|
||
|
|
CPLErr TrySaveAux();
|
||
|
|
|
||
|
|
virtual const char *BuildPamFilename();
|
||
|
|
|
||
|
|
void PamInitialize();
|
||
|
|
void PamClear();
|
||
|
|
|
||
|
|
void SetPhysicalFilename( const char * );
|
||
|
|
const char *GetPhysicalFilename();
|
||
|
|
void SetSubdatasetName( const char *);
|
||
|
|
const char *GetSubdatasetName();
|
||
|
|
|
||
|
|
public:
|
||
|
|
virtual ~GDALPamDataset();
|
||
|
|
|
||
|
|
virtual void FlushCache(void);
|
||
|
|
|
||
|
|
virtual const char *GetProjectionRef(void);
|
||
|
|
virtual CPLErr SetProjection( const char * );
|
||
|
|
|
||
|
|
virtual CPLErr GetGeoTransform( double * );
|
||
|
|
virtual CPLErr SetGeoTransform( double * );
|
||
|
|
|
||
|
|
virtual int GetGCPCount();
|
||
|
|
virtual const char *GetGCPProjection();
|
||
|
|
virtual const GDAL_GCP *GetGCPs();
|
||
|
|
virtual CPLErr SetGCPs( int nGCPCount, const GDAL_GCP *pasGCPList,
|
||
|
|
const char *pszGCPProjection );
|
||
|
|
|
||
|
|
virtual CPLErr SetMetadata( char ** papszMetadata,
|
||
|
|
const char * pszDomain = "" );
|
||
|
|
virtual CPLErr SetMetadataItem( const char * pszName,
|
||
|
|
const char * pszValue,
|
||
|
|
const char * pszDomain = "" );
|
||
|
|
virtual char **GetMetadata( const char * pszDomain = "" );
|
||
|
|
virtual const char *GetMetadataItem( const char * pszName,
|
||
|
|
const char * pszDomain = "" );
|
||
|
|
|
||
|
|
virtual char **GetFileList(void);
|
||
|
|
|
||
|
|
virtual CPLErr CloneInfo( GDALDataset *poSrcDS, int nCloneInfoFlags );
|
||
|
|
|
||
|
|
virtual CPLErr IBuildOverviews( const char *pszResampling,
|
||
|
|
int nOverviews, int *panOverviewList,
|
||
|
|
int nListBands, int *panBandList,
|
||
|
|
GDALProgressFunc pfnProgress,
|
||
|
|
void * pProgressData );
|
||
|
|
|
||
|
|
|
||
|
|
// "semi private" methods.
|
||
|
|
void MarkPamDirty() { nPamFlags |= GPF_DIRTY; }
|
||
|
|
GDALDatasetPamInfo *GetPamInfo() { return psPam; }
|
||
|
|
int GetPamFlags() { return nPamFlags; }
|
||
|
|
void SetPamFlags(int nValue ) { nPamFlags = nValue; }
|
||
|
|
|
||
|
|
private:
|
||
|
|
CPL_DISALLOW_COPY_ASSIGN(GDALPamDataset);
|
||
|
|
};
|
||
|
|
|
||
|
|
/* ==================================================================== */
|
||
|
|
/* GDALRasterBandPamInfo */
|
||
|
|
/* */
|
||
|
|
/* We make these things a separate structure of information */
|
||
|
|
/* primarily so we can modify it without altering the size of */
|
||
|
|
/* the GDALPamDataset. It is an effort to reduce ABI churn for */
|
||
|
|
/* driver plugins. */
|
||
|
|
/* ==================================================================== */
|
||
|
|
typedef struct {
|
||
|
|
GDALPamDataset *poParentDS;
|
||
|
|
|
||
|
|
int bNoDataValueSet;
|
||
|
|
double dfNoDataValue;
|
||
|
|
|
||
|
|
GDALColorTable *poColorTable;
|
||
|
|
|
||
|
|
GDALColorInterp eColorInterp;
|
||
|
|
|
||
|
|
char *pszUnitType;
|
||
|
|
char **papszCategoryNames;
|
||
|
|
|
||
|
|
double dfOffset;
|
||
|
|
double dfScale;
|
||
|
|
|
||
|
|
int bHaveMinMax;
|
||
|
|
double dfMin;
|
||
|
|
double dfMax;
|
||
|
|
|
||
|
|
int bHaveStats;
|
||
|
|
double dfMean;
|
||
|
|
double dfStdDev;
|
||
|
|
|
||
|
|
CPLXMLNode *psSavedHistograms;
|
||
|
|
|
||
|
|
GDALRasterAttributeTable *poDefaultRAT;
|
||
|
|
|
||
|
|
} GDALRasterBandPamInfo;
|
||
|
|
|
||
|
|
/* ******************************************************************** */
|
||
|
|
/* GDALPamRasterBand */
|
||
|
|
/* ******************************************************************** */
|
||
|
|
class CPL_DLL GDALPamRasterBand : public GDALRasterBand
|
||
|
|
{
|
||
|
|
friend class GDALPamDataset;
|
||
|
|
|
||
|
|
protected:
|
||
|
|
|
||
|
|
virtual CPLXMLNode *SerializeToXML( const char *pszVRTPath );
|
||
|
|
virtual CPLErr XMLInit( CPLXMLNode *, const char * );
|
||
|
|
|
||
|
|
void PamInitialize();
|
||
|
|
void PamClear();
|
||
|
|
|
||
|
|
GDALRasterBandPamInfo *psPam;
|
||
|
|
|
||
|
|
public:
|
||
|
|
GDALPamRasterBand();
|
||
|
|
GDALPamRasterBand(int bForceCachedIO);
|
||
|
|
virtual ~GDALPamRasterBand();
|
||
|
|
|
||
|
|
virtual void SetDescription( const char * );
|
||
|
|
|
||
|
|
virtual CPLErr SetNoDataValue( double );
|
||
|
|
virtual double GetNoDataValue( int *pbSuccess = NULL );
|
||
|
|
virtual CPLErr DeleteNoDataValue();
|
||
|
|
|
||
|
|
virtual CPLErr SetColorTable( GDALColorTable * );
|
||
|
|
virtual GDALColorTable *GetColorTable();
|
||
|
|
|
||
|
|
virtual CPLErr SetColorInterpretation( GDALColorInterp );
|
||
|
|
virtual GDALColorInterp GetColorInterpretation();
|
||
|
|
|
||
|
|
virtual const char *GetUnitType();
|
||
|
|
CPLErr SetUnitType( const char * );
|
||
|
|
|
||
|
|
virtual char **GetCategoryNames();
|
||
|
|
virtual CPLErr SetCategoryNames( char ** );
|
||
|
|
|
||
|
|
virtual double GetOffset( int *pbSuccess = NULL );
|
||
|
|
CPLErr SetOffset( double );
|
||
|
|
virtual double GetScale( int *pbSuccess = NULL );
|
||
|
|
CPLErr SetScale( double );
|
||
|
|
|
||
|
|
virtual CPLErr GetHistogram( double dfMin, double dfMax,
|
||
|
|
int nBuckets, GUIntBig * panHistogram,
|
||
|
|
int bIncludeOutOfRange, int bApproxOK,
|
||
|
|
GDALProgressFunc, void *pProgressData );
|
||
|
|
|
||
|
|
virtual CPLErr GetDefaultHistogram( double *pdfMin, double *pdfMax,
|
||
|
|
int *pnBuckets, GUIntBig ** ppanHistogram,
|
||
|
|
int bForce,
|
||
|
|
GDALProgressFunc, void *pProgressData);
|
||
|
|
|
||
|
|
virtual CPLErr SetDefaultHistogram( double dfMin, double dfMax,
|
||
|
|
int nBuckets, GUIntBig *panHistogram );
|
||
|
|
|
||
|
|
virtual CPLErr SetMetadata( char ** papszMetadata,
|
||
|
|
const char * pszDomain = "" );
|
||
|
|
virtual CPLErr SetMetadataItem( const char * pszName,
|
||
|
|
const char * pszValue,
|
||
|
|
const char * pszDomain = "" );
|
||
|
|
|
||
|
|
virtual GDALRasterAttributeTable *GetDefaultRAT();
|
||
|
|
virtual CPLErr SetDefaultRAT( const GDALRasterAttributeTable * );
|
||
|
|
|
||
|
|
// new in GDALPamRasterBand.
|
||
|
|
virtual CPLErr CloneInfo( GDALRasterBand *poSrcBand, int nCloneInfoFlags );
|
||
|
|
|
||
|
|
// "semi private" methods.
|
||
|
|
GDALRasterBandPamInfo *GetPamInfo() { return psPam; }
|
||
|
|
|
||
|
|
private:
|
||
|
|
CPL_DISALLOW_COPY_ASSIGN(GDALPamRasterBand);
|
||
|
|
};
|
||
|
|
|
||
|
|
// These are mainly helper functions for internal use.
|
||
|
|
int CPL_DLL PamParseHistogram( CPLXMLNode *psHistItem,
|
||
|
|
double *pdfMin, double *pdfMax,
|
||
|
|
int *pnBuckets, GUIntBig **ppanHistogram,
|
||
|
|
int *pbIncludeOutOfRange, int *pbApproxOK );
|
||
|
|
CPLXMLNode CPL_DLL *
|
||
|
|
PamFindMatchingHistogram( CPLXMLNode *psSavedHistograms,
|
||
|
|
double dfMin, double dfMax, int nBuckets,
|
||
|
|
int bIncludeOutOfRange, int bApproxOK );
|
||
|
|
CPLXMLNode CPL_DLL *
|
||
|
|
PamHistogramToXMLTree( double dfMin, double dfMax,
|
||
|
|
int nBuckets, GUIntBig * panHistogram,
|
||
|
|
int bIncludeOutOfRange, int bApprox );
|
||
|
|
|
||
|
|
// For managing the proxy file database.
|
||
|
|
const char CPL_DLL * PamGetProxy( const char * );
|
||
|
|
const char CPL_DLL * PamAllocateProxy( const char * );
|
||
|
|
const char CPL_DLL * PamDeallocateProxy( const char * );
|
||
|
|
void CPL_DLL PamCleanProxyDB( void );
|
||
|
|
|
||
|
|
#endif /* ndef GDAL_PAM_H_INCLUDED */
|