GDAL

gdal_mdreader.h
1/******************************************************************************
2 * $Id$
3 *
4 * Project: GDAL Core
5 * Purpose: Read metadata (mainly the remote sensing imagery) from files of
6 * different providers like DigitalGlobe, GeoEye etc.
7 * Author: Dmitry Baryshnikov, polimax@mail.ru
8 *
9 ******************************************************************************
10 * Copyright (c) 2014-2015, NextGIS info@nextgis.ru
11 *
12 * Permission is hereby granted, free of charge, to any person obtaining a
13 * copy of this software and associated documentation files (the "Software"),
14 * to deal in the Software without restriction, including without limitation
15 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
16 * and/or sell copies of the Software, and to permit persons to whom the
17 * Software is furnished to do so, subject to the following conditions:
18 *
19 * The above copyright notice and this permission notice shall be included
20 * in all copies or substantial portions of the Software.
21 *
22 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
23 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
25 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
27 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
28 * DEALINGS IN THE SOFTWARE.
29 ****************************************************************************/
30
31#ifndef GDAL_MDREADER_H_INCLUDED
32#define GDAL_MDREADER_H_INCLUDED
33
34#include "cpl_port.h"
35#include "gdal_priv.h"
36
37#include <map>
38
39#define MD_DOMAIN_IMD "IMD"
40#define MD_DOMAIN_RPC "RPC"
41#define MD_DOMAIN_IMAGERY "IMAGERY"
42#define MD_DOMAIN_DEFAULT ""
44#define MD_NAME_ACQDATETIME \
45 "ACQUISITIONDATETIME"
47#define MD_NAME_SATELLITE \
48 "SATELLITEID"
49#define MD_NAME_CLOUDCOVER \
50 "CLOUDCOVER"
52#define MD_NAME_MDTYPE \
53 "METADATATYPE"
56#define MD_DATETIMEFORMAT "%Y-%m-%d %H:%M:%S"
57#define MD_CLOUDCOVER_NA "999"
63#define RPC_ERR_BIAS "ERR_BIAS"
64#define RPC_ERR_RAND "ERR_RAND"
65#define RPC_LINE_OFF "LINE_OFF"
66#define RPC_SAMP_OFF "SAMP_OFF"
67#define RPC_LAT_OFF "LAT_OFF"
68#define RPC_LONG_OFF "LONG_OFF"
69#define RPC_HEIGHT_OFF "HEIGHT_OFF"
70#define RPC_LINE_SCALE "LINE_SCALE"
71#define RPC_SAMP_SCALE "SAMP_SCALE"
72#define RPC_LAT_SCALE "LAT_SCALE"
73#define RPC_LONG_SCALE "LONG_SCALE"
74#define RPC_HEIGHT_SCALE "HEIGHT_SCALE"
75#define RPC_LINE_NUM_COEFF "LINE_NUM_COEFF"
76#define RPC_LINE_DEN_COEFF "LINE_DEN_COEFF"
77#define RPC_SAMP_NUM_COEFF "SAMP_NUM_COEFF"
78#define RPC_SAMP_DEN_COEFF "SAMP_DEN_COEFF"
79
80/* Optional */
81#define RPC_MIN_LONG "MIN_LONG"
82#define RPC_MIN_LAT "MIN_LAT"
83#define RPC_MAX_LONG "MAX_LONG"
84#define RPC_MAX_LAT "MAX_LAT"
85
86/* Pleiades Neo nomenclature */
87#define RPC_LAT_NUM_COEFF "LAT_NUM_COEFF"
88#define RPC_LAT_DEN_COEFF "LAT_DEN_COEFF"
89#define RPC_LON_NUM_COEFF "LON_NUM_COEFF"
90#define RPC_LON_DEN_COEFF "LON_DEN_COEFF"
91
96typedef enum
97{
98 MDR_None = 0x00000000,
99 MDR_DG = 0x00000001,
100 MDR_GE = 0x00000002,
101 MDR_OV = 0x00000004,
102 MDR_PLEIADES = 0x00000008,
103 MDR_SPOT = 0x00000010,
104 MDR_RDK1 = 0x00000020,
105 MDR_LS = 0x00000040,
106 MDR_RE = 0x00000080,
107 MDR_KOMPSAT = 0x00000100,
108 MDR_EROS = 0x00000200,
109 MDR_ALOS = 0x00000400,
110 MDR_ANY = MDR_DG | MDR_GE | MDR_OV | MDR_PLEIADES | MDR_SPOT | MDR_RDK1 |
111 MDR_LS | MDR_RE | MDR_KOMPSAT | MDR_EROS |
112 MDR_ALOS
113} MDReaders;
114
118 class CPL_DLL GDALMDReaderBase
119{
120
121 CPL_DISALLOW_COPY_ASSIGN(GDALMDReaderBase)
122
123 static bool
124 ReadXMLToListFirstPass(const CPLXMLNode *psNode,
125 std::map<std::string, int> &oMapCountKeysFull,
126 const std::string &osPrefixFull, int nDepth);
127
128 char **ReadXMLToList(const CPLXMLNode *psNode, char **papszList,
129 const std::map<std::string, int> &oMapCountKeysFullRef,
130 std::map<std::string, int> &oMapCountKeysFull,
131 std::map<std::string, int> &oMapCountKeys,
132 const std::string &osPrefix,
133 const std::string &osPrefixFull);
134
135 public:
136 GDALMDReaderBase(const char *pszPath, char **papszSiblingFiles);
137 virtual ~GDALMDReaderBase();
138
144 virtual char **GetMetadataDomain(const char *pszDomain);
150 virtual bool FillMetadata(GDALMultiDomainMetadata *poMDMD);
156 virtual bool HasRequiredFiles() const = 0;
162 virtual char **GetMetadataFiles() const = 0;
163
164 protected:
169 virtual void LoadMetadata();
175 virtual GIntBig GetAcquisitionTimeFromString(const char *pszDateTime);
185 virtual char **ReadXMLToList(CPLXMLNode *psNode, char **papszList,
186 const char *pszName = "");
196 virtual char **AddXMLNameValueToList(char **papszList, const char *pszName,
197 const char *pszValue);
198
199 protected:
201 char **m_papszIMDMD = nullptr;
202 char **m_papszRPCMD = nullptr;
203 char **m_papszIMAGERYMD = nullptr;
204 char **m_papszDEFAULTMD = nullptr;
205 bool m_bIsMetadataLoad = false;
207};
208
214 class CPL_DLL GDALMDReaderManager
215{
216
217 CPL_DISALLOW_COPY_ASSIGN(GDALMDReaderManager)
218
219 public:
220 GDALMDReaderManager();
221 virtual ~GDALMDReaderManager();
222
233 virtual GDALMDReaderBase *GetReader(const char *pszPath,
234 char **papszSiblingFiles,
235 GUInt32 nType = MDR_ANY);
236
237 protected:
239 GDALMDReaderBase *m_pReader = nullptr;
241};
242
243// misc
244 CPLString CPLStrip(const CPLString &osString, const char cChar);
245 CPLString CPLStripQuotes(const CPLString &osString);
246char **GDALLoadRPBFile(const CPLString &osFilePath);
247char CPL_DLL **GDALLoadRPCFile(const CPLString &osFilePath);
248char **GDALLoadIMDFile(const CPLString &osFilePath);
249bool GDALCheckFileHeader(const CPLString &soFilePath, const char *pszTestString,
250 int nBufferSize = 256);
251
252 CPLErr GDALWriteRPBFile(const char *pszFilename, char **papszMD);
253 CPLErr CPL_DLL GDALWriteRPCTXTFile(const char *pszFilename, char **papszMD);
254 CPLErr GDALWriteIMDFile(const char *pszFilename, char **papszMD);
255
256#endif // GDAL_MDREADER_H_INCLUDED
CPLString
Convenient string class based on std::string.
Definition: cpl_string.h:320
GDALMDReaderBase
The base class for all metadata readers.
Definition: gdal_mdreader.h:119
GDALMDReaderBase::GetMetadataFiles
virtual char ** GetMetadataFiles() const =0
Get metadata file names.
GDALMDReaderBase::HasRequiredFiles
virtual bool HasRequiredFiles() const =0
Determine whether the input parameter correspond to the particular provider of remote sensing data co...
GDALMDReaderManager
The metadata reader main class.
Definition: gdal_mdreader.h:215
GDALMDReaderManager::GDALMDReaderManager
GDALMDReaderManager()
GDALMDReaderManager()
CPLErr
CPLErr
Error category.
Definition: cpl_error.h:53
cpl_port.h
Core portability definitions for CPL.
GUInt32
unsigned int GUInt32
Unsigned int32 type.
Definition: cpl_port.h:177
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:1042
GIntBig
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition: cpl_port.h:215
gdal_priv.h
C++ GDAL entry points.
CPLXMLNode
Document node structure.
Definition: cpl_minixml.h:71