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 #define MD_DOMAIN_IMD "IMD"
38 #define MD_DOMAIN_RPC "RPC"
39 #define MD_DOMAIN_IMAGERY "IMAGERY"
40 #define MD_DOMAIN_DEFAULT ""
42 #define MD_NAME_ACQDATETIME "ACQUISITIONDATETIME"
43 #define MD_NAME_SATELLITE "SATELLITEID"
44 #define MD_NAME_CLOUDCOVER "CLOUDCOVER"
45 #define MD_NAME_MDTYPE "METADATATYPE"
47 #define MD_DATETIMEFORMAT "%Y-%m-%d %H:%M:%S"
48 #define MD_CLOUDCOVER_NA "999"
54 #define RPC_ERR_BIAS "ERR_BIAS"
55 #define RPC_ERR_RAND "ERR_RAND"
56 #define RPC_LINE_OFF "LINE_OFF"
57 #define RPC_SAMP_OFF "SAMP_OFF"
58 #define RPC_LAT_OFF "LAT_OFF"
59 #define RPC_LONG_OFF "LONG_OFF"
60 #define RPC_HEIGHT_OFF "HEIGHT_OFF"
61 #define RPC_LINE_SCALE "LINE_SCALE"
62 #define RPC_SAMP_SCALE "SAMP_SCALE"
63 #define RPC_LAT_SCALE "LAT_SCALE"
64 #define RPC_LONG_SCALE "LONG_SCALE"
65 #define RPC_HEIGHT_SCALE "HEIGHT_SCALE"
66 #define RPC_LINE_NUM_COEFF "LINE_NUM_COEFF"
67 #define RPC_LINE_DEN_COEFF "LINE_DEN_COEFF"
68 #define RPC_SAMP_NUM_COEFF "SAMP_NUM_COEFF"
69 #define RPC_SAMP_DEN_COEFF "SAMP_DEN_COEFF"
70
71 /* Optional */
72 #define RPC_MIN_LONG "MIN_LONG"
73 #define RPC_MIN_LAT "MIN_LAT"
74 #define RPC_MAX_LONG "MAX_LONG"
75 #define RPC_MAX_LAT "MAX_LAT"
76
81 typedef enum {
82 MDR_None = 0x00000000,
83 MDR_DG = 0x00000001,
84 MDR_GE = 0x00000002,
85 MDR_OV = 0x00000004,
86 MDR_PLEIADES = 0x00000008,
87 MDR_SPOT = 0x00000010,
88 MDR_RDK1 = 0x00000020,
89 MDR_LS = 0x00000040,
90 MDR_RE = 0x00000080,
91 MDR_KOMPSAT = 0x00000100,
92 MDR_EROS = 0x00000200,
93 MDR_ALOS = 0x00000400,
94 MDR_ANY = MDR_DG | MDR_GE | MDR_OV | MDR_PLEIADES | MDR_SPOT | MDR_RDK1 |
95 MDR_LS | MDR_RE | MDR_KOMPSAT | MDR_EROS | MDR_ALOS
96 } MDReaders;
97
101 class GDALMDReaderBase{
102
103 CPL_DISALLOW_COPY_ASSIGN(GDALMDReaderBase)
104
105 public:
106 GDALMDReaderBase(const char *pszPath, char **papszSiblingFiles);
107 virtual ~GDALMDReaderBase();
108
114 virtual char ** GetMetadataDomain(const char *pszDomain);
120 virtual bool FillMetadata(GDALMultiDomainMetadata* poMDMD);
126 virtual bool HasRequiredFiles() const = 0;
132 virtual char** GetMetadataFiles() const = 0;
133 protected:
138 virtual void LoadMetadata();
144 virtual time_t GetAcquisitionTimeFromString(const char* pszDateTime);
154 virtual char** ReadXMLToList(CPLXMLNode* psNode, char** papszList,
155 const char* pszName = "");
165 virtual char** AddXMLNameValueToList(char** papszList, const char *pszName,
166 const char *pszValue);
167 protected:
169 char **m_papszIMDMD = nullptr;
170 char **m_papszRPCMD = nullptr;
171 char **m_papszIMAGERYMD = nullptr;
172 char **m_papszDEFAULTMD = nullptr;
173 bool m_bIsMetadataLoad = false;
175 };
176
182 class CPL_DLL GDALMDReaderManager{
183
184 CPL_DISALLOW_COPY_ASSIGN(GDALMDReaderManager)
185
186 public:
187 GDALMDReaderManager();
188 virtual ~GDALMDReaderManager();
189
200 virtual GDALMDReaderBase* GetReader(const char *pszPath,
201 char **papszSiblingFiles,
202 GUInt32 nType = MDR_ANY);
203 protected:
205 GDALMDReaderBase *m_pReader = nullptr;
207 };
208
209 // misc
210 CPLString CPLStrip(const CPLString& osString, const char cChar);
211 CPLString CPLStripQuotes(const CPLString& osString);
212 char** GDALLoadRPBFile( const CPLString& osFilePath );
213 char** GDALLoadRPCFile( const CPLString& osFilePath );
214 char** GDALLoadIMDFile( const CPLString& osFilePath );
215 bool GDALCheckFileHeader(const CPLString& soFilePath,
216 const char * pszTestString,
217 int nBufferSize = 256);
218
219 CPLErr GDALWriteRPBFile( const char *pszFilename, char **papszMD );
220 CPLErr GDALWriteRPCTXTFile( const char *pszFilename, char **papszMD );
221 CPLErr GDALWriteIMDFile( const char *pszFilename, char **papszMD );
222
223 #endif //GDAL_MDREADER_H_INCLUDED
CPLString
Convenient string class based on std::string.
Definition: cpl_string.h:333
GDALMDReaderBase
The base class for all metadata readers.
Definition: gdal_mdreader.h:101
GDALMDReaderBase::GetAcquisitionTimeFromString
virtual time_t GetAcquisitionTimeFromString(const char *pszDateTime)
Convert string like 2012-02-25T00:25:59.9440000Z to time.
Definition: gdal_mdreader.cpp:237
GDALMDReaderBase::GetMetadataDomain
virtual char ** GetMetadataDomain(const char *pszDomain)
Get specified metadata domain.
Definition: gdal_mdreader.cpp:210
GDALMDReaderBase::GDALMDReaderBase
GDALMDReaderBase(const char *pszPath, char **papszSiblingFiles)
GDALMDReaderBase()
Definition: gdal_mdreader.cpp:192
GDALMDReaderBase::ReadXMLToList
virtual char ** ReadXMLToList(CPLXMLNode *psNode, char **papszList, const char *pszName="")
ReadXMLToList Transform xml to list of NULL terminated name=value strings.
Definition: gdal_mdreader.cpp:306
GDALMDReaderBase::~GDALMDReaderBase
virtual ~GDALMDReaderBase()
~GDALMDReaderBase()
Definition: gdal_mdreader.cpp:199
GDALMDReaderBase::LoadMetadata
virtual void LoadMetadata()
Load metadata to the correspondent IMD, RPB, IMAGERY and DEFAULT domains.
Definition: gdal_mdreader.cpp:227
GDALMDReaderBase::FillMetadata
virtual bool FillMetadata(GDALMultiDomainMetadata *poMDMD)
Fill provided metadata store class.
Definition: gdal_mdreader.cpp:278
GDALMDReaderBase::HasRequiredFiles
virtual bool HasRequiredFiles() const =0
Determine whether the input parameter correspond to the particular provider of remote sensing data co...
GDALMDReaderBase::AddXMLNameValueToList
virtual char ** AddXMLNameValueToList(char **papszList, const char *pszName, const char *pszValue)
AddXMLNameValueToList Execute from ReadXMLToList to add name and value to list.
Definition: gdal_mdreader.cpp:296
GDALMDReaderBase::GetMetadataFiles
virtual char ** GetMetadataFiles() const =0
Get metadata file names.
GDALMDReaderManager
The metadata reader main class.
Definition: gdal_mdreader.h:182
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:207
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:1007
gdal_priv.h
C++ GDAL entry points.
CPLXMLNode
Document node structure.
Definition: cpl_minixml.h:70