My Project
gdal_utils.h
Go to the documentation of this file.
1 /******************************************************************************
2  * $Id: gdal_utils.h dc3819d387764593c0fb5a5c4d02c21a848a4c9d 2018-04-12 18:07:28 +0200 Even Rouault $
3  *
4  * Project: GDAL Utilities
5  * Purpose: GDAL Utilities Public Declarations.
6  * Author: Faza Mahamood, fazamhd at gmail dot com
7  *
8  * ****************************************************************************
9  * Copyright (c) 1998, Frank Warmerdam
10  * Copyright (c) 2007-2015, Even Rouault <even.rouault at spatialys.com>
11  * Copyright (c) 2015, Faza Mahamood
12  *
13  * Permission is hereby granted, free of charge, to any person obtaining a
14  * copy of this software and associated documentation files (the "Software"),
15  * to deal in the Software without restriction, including without limitation
16  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
17  * and/or sell copies of the Software, and to permit persons to whom the
18  * Software is furnished to do so, subject to the following conditions:
19  *
20  * The above copyright notice and this permission notice shall be included
21  * in all copies or substantial portions of the Software.
22  *
23  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
24  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
26  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
28  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
29  * DEALINGS IN THE SOFTWARE.
30  ****************************************************************************/
31 
32 #ifndef GDAL_UTILS_H_INCLUDED
33 #define GDAL_UTILS_H_INCLUDED
34 
43 #include "cpl_port.h"
44 #include "gdal.h"
45 
46 CPL_C_START
47 
49 typedef struct GDALInfoOptions GDALInfoOptions;
50 
53 
54 GDALInfoOptions CPL_DLL *GDALInfoOptionsNew(char** papszArgv, GDALInfoOptionsForBinary* psOptionsForBinary);
55 
56 void CPL_DLL GDALInfoOptionsFree( GDALInfoOptions *psOptions );
57 
58 char CPL_DLL *GDALInfo( GDALDatasetH hDataset, const GDALInfoOptions *psOptions );
59 
62 
65 
66 GDALTranslateOptions CPL_DLL *GDALTranslateOptionsNew(char** papszArgv,
67  GDALTranslateOptionsForBinary* psOptionsForBinary);
68 
69 void CPL_DLL GDALTranslateOptionsFree( GDALTranslateOptions *psOptions );
70 
72  GDALProgressFunc pfnProgress,
73  void *pProgressData );
74 
75 GDALDatasetH CPL_DLL GDALTranslate(const char *pszDestFilename,
76  GDALDatasetH hSrcDataset,
77  const GDALTranslateOptions *psOptions,
78  int *pbUsageError);
79 
82 
85 
86 GDALWarpAppOptions CPL_DLL *GDALWarpAppOptionsNew(char** papszArgv,
87  GDALWarpAppOptionsForBinary* psOptionsForBinary);
88 
89 void CPL_DLL GDALWarpAppOptionsFree( GDALWarpAppOptions *psOptions );
90 
91 void CPL_DLL GDALWarpAppOptionsSetProgress( GDALWarpAppOptions *psOptions,
92  GDALProgressFunc pfnProgress,
93  void *pProgressData );
94 void CPL_DLL GDALWarpAppOptionsSetQuiet( GDALWarpAppOptions *psOptions,
95  int bQuiet );
97  const char* pszKey,
98  const char* pszValue );
99 
100 GDALDatasetH CPL_DLL GDALWarp( const char *pszDest, GDALDatasetH hDstDS,
101  int nSrcCount, GDALDatasetH *pahSrcDS,
102  const GDALWarpAppOptions *psOptions, int *pbUsageError );
103 
106 
109 
111  GDALVectorTranslateOptionsForBinary* psOptionsForBinary);
112 
114 
116  GDALProgressFunc pfnProgress,
117  void *pProgressData );
118 
119 GDALDatasetH CPL_DLL GDALVectorTranslate( const char *pszDest, GDALDatasetH hDstDS, int nSrcCount,
120  GDALDatasetH *pahSrcDS,
121  const GDALVectorTranslateOptions *psOptions, int *pbUsageError );
122 
125 
128 
129 GDALDEMProcessingOptions CPL_DLL *GDALDEMProcessingOptionsNew(char** papszArgv,
130  GDALDEMProcessingOptionsForBinary* psOptionsForBinary);
131 
132 void CPL_DLL GDALDEMProcessingOptionsFree( GDALDEMProcessingOptions *psOptions );
133 
135  GDALProgressFunc pfnProgress,
136  void *pProgressData );
137 
138 GDALDatasetH CPL_DLL GDALDEMProcessing(const char *pszDestFilename,
139  GDALDatasetH hSrcDataset,
140  const char* pszProcessing,
141  const char* pszColorFilename,
142  const GDALDEMProcessingOptions *psOptions,
143  int *pbUsageError);
144 
147 
150 
151 GDALNearblackOptions CPL_DLL *GDALNearblackOptionsNew(char** papszArgv,
152  GDALNearblackOptionsForBinary* psOptionsForBinary);
153 
154 void CPL_DLL GDALNearblackOptionsFree( GDALNearblackOptions *psOptions );
155 
157  GDALProgressFunc pfnProgress,
158  void *pProgressData );
159 
160 GDALDatasetH CPL_DLL GDALNearblack( const char *pszDest, GDALDatasetH hDstDS,
161  GDALDatasetH hSrcDS,
162  const GDALNearblackOptions *psOptions, int *pbUsageError );
163 
165 typedef struct GDALGridOptions GDALGridOptions;
166 
169 
170 GDALGridOptions CPL_DLL *GDALGridOptionsNew(char** papszArgv,
171  GDALGridOptionsForBinary* psOptionsForBinary);
172 
173 void CPL_DLL GDALGridOptionsFree( GDALGridOptions *psOptions );
174 
175 void CPL_DLL GDALGridOptionsSetProgress( GDALGridOptions *psOptions,
176  GDALProgressFunc pfnProgress,
177  void *pProgressData );
178 
179 GDALDatasetH CPL_DLL GDALGrid( const char *pszDest,
180  GDALDatasetH hSrcDS,
181  const GDALGridOptions *psOptions, int *pbUsageError );
182 
185 
188 
189 GDALRasterizeOptions CPL_DLL *GDALRasterizeOptionsNew(char** papszArgv,
190  GDALRasterizeOptionsForBinary* psOptionsForBinary);
191 
192 void CPL_DLL GDALRasterizeOptionsFree( GDALRasterizeOptions *psOptions );
193 
195  GDALProgressFunc pfnProgress,
196  void *pProgressData );
197 
198 GDALDatasetH CPL_DLL GDALRasterize( const char *pszDest, GDALDatasetH hDstDS,
199  GDALDatasetH hSrcDS,
200  const GDALRasterizeOptions *psOptions, int *pbUsageError );
201 
204 
207 
208 GDALBuildVRTOptions CPL_DLL *GDALBuildVRTOptionsNew(char** papszArgv,
209  GDALBuildVRTOptionsForBinary* psOptionsForBinary);
210 
211 void CPL_DLL GDALBuildVRTOptionsFree( GDALBuildVRTOptions *psOptions );
212 
213 void CPL_DLL GDALBuildVRTOptionsSetProgress( GDALBuildVRTOptions *psOptions,
214  GDALProgressFunc pfnProgress,
215  void *pProgressData );
216 
217 GDALDatasetH CPL_DLL GDALBuildVRT( const char *pszDest,
218  int nSrcCount, GDALDatasetH *pahSrcDS, const char* const* papszSrcDSNames,
219  const GDALBuildVRTOptions *psOptions, int *pbUsageError );
220 
221 CPL_C_END
222 
223 #endif /* GDAL_UTILS_H_INCLUDED */
GDALVectorTranslateOptionsForBinary
Definition: gdal_utils_priv.h:90
GDALTranslateOptions
Definition: gdal_translate_lib.cpp:106
GDALTranslateOptionsFree
void CPL_DLL GDALTranslateOptionsFree(GDALTranslateOptions *psOptions)
Definition: gdal_translate_lib.cpp:2728
GDALNearblackOptionsNew
GDALNearblackOptions CPL_DLL * GDALNearblackOptionsNew(char **papszArgv, GDALNearblackOptionsForBinary *psOptionsForBinary)
Definition: nearblack_lib.cpp:763
GDALGrid
GDALDatasetH CPL_DLL GDALGrid(const char *pszDest, GDALDatasetH hSrcDS, const GDALGridOptions *psOptions, int *pbUsageError)
Definition: gdal_grid_lib.cpp:726
GDALInfo
char CPL_DLL * GDALInfo(GDALDatasetH hDataset, const GDALInfoOptions *psOptions)
Definition: gdalinfo_lib.cpp:209
GDALGridOptionsSetProgress
void CPL_DLL GDALGridOptionsSetProgress(GDALGridOptions *psOptions, GDALProgressFunc pfnProgress, void *pProgressData)
Definition: gdal_grid_lib.cpp:1399
GDALBuildVRTOptions
Definition: gdalbuildvrt_lib.cpp:1459
GDALTranslateOptionsSetProgress
void CPL_DLL GDALTranslateOptionsSetProgress(GDALTranslateOptions *psOptions, GDALProgressFunc pfnProgress, void *pProgressData)
Definition: gdal_translate_lib.cpp:2763
GDALNearblackOptionsSetProgress
void CPL_DLL GDALNearblackOptionsSetProgress(GDALNearblackOptions *psOptions, GDALProgressFunc pfnProgress, void *pProgressData)
Definition: nearblack_lib.cpp:942
GDALNearblackOptionsForBinary
Definition: gdal_utils_priv.h:109
GDALBuildVRTOptionsFree
void CPL_DLL GDALBuildVRTOptionsFree(GDALBuildVRTOptions *psOptions)
Definition: gdalbuildvrt_lib.cpp:1911
GDALWarpAppOptionsSetQuiet
void CPL_DLL GDALWarpAppOptionsSetQuiet(GDALWarpAppOptions *psOptions, int bQuiet)
Definition: gdalwarp_lib.cpp:3908
GDALRasterizeOptionsForBinary
Definition: gdal_utils_priv.h:124
GDALNearblack
GDALDatasetH CPL_DLL GDALNearblack(const char *pszDest, GDALDatasetH hDstDS, GDALDatasetH hSrcDS, const GDALNearblackOptions *psOptions, int *pbUsageError)
Definition: nearblack_lib.cpp:108
GDALWarpAppOptionsSetProgress
void CPL_DLL GDALWarpAppOptionsSetProgress(GDALWarpAppOptions *psOptions, GDALProgressFunc pfnProgress, void *pProgressData)
Definition: gdalwarp_lib.cpp:3886
GDALInfoOptionsForBinary
Definition: gdal_utils_priv.h:43
GDALDEMProcessingOptionsNew
GDALDEMProcessingOptions CPL_DLL * GDALDEMProcessingOptionsNew(char **papszArgv, GDALDEMProcessingOptionsForBinary *psOptionsForBinary)
Definition: gdaldem_lib.cpp:3872
GDALRasterizeOptionsFree
void CPL_DLL GDALRasterizeOptionsFree(GDALRasterizeOptions *psOptions)
Definition: gdal_rasterize_lib.cpp:1221
GDALVectorTranslateOptionsNew
GDALVectorTranslateOptions CPL_DLL * GDALVectorTranslateOptionsNew(char **papszArgv, GDALVectorTranslateOptionsForBinary *psOptionsForBinary)
Definition: ogr2ogr_lib.cpp:4977
GDALVectorTranslateOptions
Definition: ogr2ogr_lib.cpp:99
GDALWarpAppOptionsFree
void CPL_DLL GDALWarpAppOptionsFree(GDALWarpAppOptions *psOptions)
Definition: gdalwarp_lib.cpp:3851
GDALWarpAppOptionsNew
GDALWarpAppOptions CPL_DLL * GDALWarpAppOptionsNew(char **papszArgv, GDALWarpAppOptionsForBinary *psOptionsForBinary)
Definition: gdalwarp_lib.cpp:3373
GDALDEMProcessingOptionsSetProgress
void CPL_DLL GDALDEMProcessingOptionsSetProgress(GDALDEMProcessingOptions *psOptions, GDALProgressFunc pfnProgress, void *pProgressData)
Definition: gdaldem_lib.cpp:4172
GDALWarpAppOptionsForBinary
Definition: gdal_utils_priv.h:65
GDALDEMProcessingOptionsFree
void CPL_DLL GDALDEMProcessingOptionsFree(GDALDEMProcessingOptions *psOptions)
Definition: gdaldem_lib.cpp:4147
GDALVectorTranslate
GDALDatasetH CPL_DLL GDALVectorTranslate(const char *pszDest, GDALDatasetH hDstDS, int nSrcCount, GDALDatasetH *pahSrcDS, const GDALVectorTranslateOptions *psOptions, int *pbUsageError)
Definition: ogr2ogr_lib.cpp:1952
GDALWarpAppOptions
Definition: gdalwarp_lib.cpp:73
GDALGridOptionsForBinary
Definition: gdal_utils_priv.h:116
GDALDEMProcessing
GDALDatasetH CPL_DLL GDALDEMProcessing(const char *pszDestFilename, GDALDatasetH hSrcDataset, const char *pszProcessing, const char *pszColorFilename, const GDALDEMProcessingOptions *psOptions, int *pbUsageError)
Definition: gdaldem_lib.cpp:3332
GDALTranslate
GDALDatasetH CPL_DLL GDALTranslate(const char *pszDestFilename, GDALDatasetH hSrcDataset, const GDALTranslateOptions *psOptions, int *pbUsageError)
Definition: gdal_translate_lib.cpp:530
GDALRasterize
GDALDatasetH CPL_DLL GDALRasterize(const char *pszDest, GDALDatasetH hDstDS, GDALDatasetH hSrcDS, const GDALRasterizeOptions *psOptions, int *pbUsageError)
Definition: gdal_rasterize_lib.cpp:576
GDALNearblackOptionsFree
void CPL_DLL GDALNearblackOptionsFree(GDALNearblackOptions *psOptions)
Definition: nearblack_lib.cpp:918
GDALBuildVRTOptionsNew
GDALBuildVRTOptions CPL_DLL * GDALBuildVRTOptionsNew(char **papszArgv, GDALBuildVRTOptionsForBinary *psOptionsForBinary)
Definition: gdalbuildvrt_lib.cpp:1681
GDALTranslateOptionsForBinary
Definition: gdal_utils_priv.h:55
GDALRasterizeOptionsSetProgress
void CPL_DLL GDALRasterizeOptionsSetProgress(GDALRasterizeOptions *psOptions, GDALProgressFunc pfnProgress, void *pProgressData)
Definition: gdal_rasterize_lib.cpp:1254
GDALGridOptionsFree
void CPL_DLL GDALGridOptionsFree(GDALGridOptions *psOptions)
Definition: gdal_grid_lib.cpp:1363
GDALBuildVRTOptionsSetProgress
void CPL_DLL GDALBuildVRTOptionsSetProgress(GDALBuildVRTOptions *psOptions, GDALProgressFunc pfnProgress, void *pProgressData)
Definition: gdalbuildvrt_lib.cpp:1941
GDALRasterizeOptions
Definition: gdal_rasterize_lib.cpp:517
GDALGridOptionsNew
GDALGridOptions CPL_DLL * GDALGridOptionsNew(char **papszArgv, GDALGridOptionsForBinary *psOptionsForBinary)
Definition: gdal_grid_lib.cpp:993
GDALDEMProcessingOptionsForBinary
Definition: gdal_utils_priv.h:100
GDALBuildVRT
GDALDatasetH CPL_DLL GDALBuildVRT(const char *pszDest, int nSrcCount, GDALDatasetH *pahSrcDS, const char *const *papszSrcDSNames, const GDALBuildVRTOptions *psOptions, int *pbUsageError)
Definition: gdalbuildvrt_lib.cpp:1540
GDALInfoOptionsFree
void CPL_DLL GDALInfoOptionsFree(GDALInfoOptions *psOptions)
Definition: gdalinfo_lib.cpp:1927
GDALWarpAppOptionsSetWarpOption
void CPL_DLL GDALWarpAppOptionsSetWarpOption(GDALWarpAppOptions *psOptions, const char *pszKey, const char *pszValue)
Definition: gdalwarp_lib.cpp:3928
GDALVectorTranslateOptionsSetProgress
void CPL_DLL GDALVectorTranslateOptionsSetProgress(GDALVectorTranslateOptions *psOptions, GDALProgressFunc pfnProgress, void *pProgressData)
Definition: ogr2ogr_lib.cpp:5759
GDALNearblackOptions
Definition: nearblack_lib.cpp:55
GDALBuildVRTOptionsForBinary
Definition: gdal_utils_priv.h:133
GDALDEMProcessingOptions
Definition: gdaldem_lib.cpp:132
GDALTranslateOptionsNew
GDALTranslateOptions CPL_DLL * GDALTranslateOptionsNew(char **papszArgv, GDALTranslateOptionsForBinary *psOptionsForBinary)
Definition: gdal_translate_lib.cpp:2103
GDALInfoOptions
Definition: gdalinfo_lib.cpp:80
GDALVectorTranslateOptionsFree
void CPL_DLL GDALVectorTranslateOptionsFree(GDALVectorTranslateOptions *psOptions)
Definition: ogr2ogr_lib.cpp:5695
GDALRasterizeOptionsNew
GDALRasterizeOptions CPL_DLL * GDALRasterizeOptionsNew(char **papszArgv, GDALRasterizeOptionsForBinary *psOptionsForBinary)
Definition: gdal_rasterize_lib.cpp:821
GDALGridOptions
Definition: gdal_grid_lib.cpp:67
GDALWarp
GDALDatasetH CPL_DLL GDALWarp(const char *pszDest, GDALDatasetH hDstDS, int nSrcCount, GDALDatasetH *pahSrcDS, const GDALWarpAppOptions *psOptions, int *pbUsageError)
Definition: gdalwarp_lib.cpp:772
GDALInfoOptionsNew
GDALInfoOptions CPL_DLL * GDALInfoOptionsNew(char **papszArgv, GDALInfoOptionsForBinary *psOptionsForBinary)
Definition: gdalinfo_lib.cpp:1796