GDAL

- Main Page
- Related Pages
- Classes
- Files

- File List
- File Members

gdal_utils.h
Go to the documentation of this file.
1 /******************************************************************************
2 * $Id$
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
51 typedef struct GDALInfoOptionsForBinary GDALInfoOptionsForBinary;
52
53 GDALInfoOptions CPL_DLL *GDALInfoOptionsNew(char** papszArgv, GDALInfoOptionsForBinary* psOptionsForBinary);
54
55 void CPL_DLL GDALInfoOptionsFree( GDALInfoOptions *psOptions );
56
57 char CPL_DLL *GDALInfo( GDALDatasetH hDataset, const GDALInfoOptions *psOptions );
58
59
61 typedef struct GDALTranslateOptions GDALTranslateOptions;
62
63 typedef struct GDALTranslateOptionsForBinary GDALTranslateOptionsForBinary;
64
65 GDALTranslateOptions CPL_DLL *GDALTranslateOptionsNew(char** papszArgv,
66 GDALTranslateOptionsForBinary* psOptionsForBinary);
67
68 void CPL_DLL GDALTranslateOptionsFree( GDALTranslateOptions *psOptions );
69
70 void CPL_DLL GDALTranslateOptionsSetProgress( GDALTranslateOptions *psOptions,
71 GDALProgressFunc pfnProgress,
72 void *pProgressData );
73
74 GDALDatasetH CPL_DLL GDALTranslate(const char *pszDestFilename,
75 GDALDatasetH hSrcDataset,
76 const GDALTranslateOptions *psOptions,
77 int *pbUsageError);
78
80 typedef struct GDALWarpAppOptions GDALWarpAppOptions;
81
82 typedef struct GDALWarpAppOptionsForBinary GDALWarpAppOptionsForBinary;
83
84 GDALWarpAppOptions CPL_DLL *GDALWarpAppOptionsNew(char** papszArgv,
85 GDALWarpAppOptionsForBinary* psOptionsForBinary);
86
87 void CPL_DLL GDALWarpAppOptionsFree( GDALWarpAppOptions *psOptions );
88
89 void CPL_DLL GDALWarpAppOptionsSetProgress( GDALWarpAppOptions *psOptions,
90 GDALProgressFunc pfnProgress,
91 void *pProgressData );
92 void CPL_DLL GDALWarpAppOptionsSetWarpOption( GDALWarpAppOptions *psOptions,
93 const char* pszKey,
94 const char* pszValue );
95
96 GDALDatasetH CPL_DLL GDALWarp( const char *pszDest, GDALDatasetH hDstDS,
97 int nSrcCount, GDALDatasetH *pahSrcDS,
98 const GDALWarpAppOptions *psOptions, int *pbUsageError );
99
101 typedef struct GDALVectorTranslateOptions GDALVectorTranslateOptions;
102
103 typedef struct GDALVectorTranslateOptionsForBinary GDALVectorTranslateOptionsForBinary;
104
105 GDALVectorTranslateOptions CPL_DLL *GDALVectorTranslateOptionsNew(char** papszArgv,
106 GDALVectorTranslateOptionsForBinary* psOptionsForBinary);
107
108 void CPL_DLL GDALVectorTranslateOptionsFree( GDALVectorTranslateOptions *psOptions );
109
110 void CPL_DLL GDALVectorTranslateOptionsSetProgress( GDALVectorTranslateOptions *psOptions,
111 GDALProgressFunc pfnProgress,
112 void *pProgressData );
113
114 GDALDatasetH CPL_DLL GDALVectorTranslate( const char *pszDest, GDALDatasetH hDstDS, int nSrcCount,
115 GDALDatasetH *pahSrcDS,
116 const GDALVectorTranslateOptions *psOptions, int *pbUsageError );
117
118
120 typedef struct GDALDEMProcessingOptions GDALDEMProcessingOptions;
121
122 typedef struct GDALDEMProcessingOptionsForBinary GDALDEMProcessingOptionsForBinary;
123
124 GDALDEMProcessingOptions CPL_DLL *GDALDEMProcessingOptionsNew(char** papszArgv,
125 GDALDEMProcessingOptionsForBinary* psOptionsForBinary);
126
127 void CPL_DLL GDALDEMProcessingOptionsFree( GDALDEMProcessingOptions *psOptions );
128
129 void CPL_DLL GDALDEMProcessingOptionsSetProgress( GDALDEMProcessingOptions *psOptions,
130 GDALProgressFunc pfnProgress,
131 void *pProgressData );
132
133 GDALDatasetH CPL_DLL GDALDEMProcessing(const char *pszDestFilename,
134 GDALDatasetH hSrcDataset,
135 const char* pszProcessing,
136 const char* pszColorFilename,
137 const GDALDEMProcessingOptions *psOptions,
138 int *pbUsageError);
139
141 typedef struct GDALNearblackOptions GDALNearblackOptions;
142
143 typedef struct GDALNearblackOptionsForBinary GDALNearblackOptionsForBinary;
144
145 GDALNearblackOptions CPL_DLL *GDALNearblackOptionsNew(char** papszArgv,
146 GDALNearblackOptionsForBinary* psOptionsForBinary);
147
148 void CPL_DLL GDALNearblackOptionsFree( GDALNearblackOptions *psOptions );
149
150 void CPL_DLL GDALNearblackOptionsSetProgress( GDALNearblackOptions *psOptions,
151 GDALProgressFunc pfnProgress,
152 void *pProgressData );
153
154 GDALDatasetH CPL_DLL GDALNearblack( const char *pszDest, GDALDatasetH hDstDS,
155 GDALDatasetH hSrcDS,
156 const GDALNearblackOptions *psOptions, int *pbUsageError );
157
159 typedef struct GDALGridOptions GDALGridOptions;
160
161 typedef struct GDALGridOptionsForBinary GDALGridOptionsForBinary;
162
163 GDALGridOptions CPL_DLL *GDALGridOptionsNew(char** papszArgv,
164 GDALGridOptionsForBinary* psOptionsForBinary);
165
166 void CPL_DLL GDALGridOptionsFree( GDALGridOptions *psOptions );
167
168 void CPL_DLL GDALGridOptionsSetProgress( GDALGridOptions *psOptions,
169 GDALProgressFunc pfnProgress,
170 void *pProgressData );
171
172 GDALDatasetH CPL_DLL GDALGrid( const char *pszDest,
173 GDALDatasetH hSrcDS,
174 const GDALGridOptions *psOptions, int *pbUsageError );
175
177 typedef struct GDALRasterizeOptions GDALRasterizeOptions;
178
179 typedef struct GDALRasterizeOptionsForBinary GDALRasterizeOptionsForBinary;
180
181 GDALRasterizeOptions CPL_DLL *GDALRasterizeOptionsNew(char** papszArgv,
182 GDALRasterizeOptionsForBinary* psOptionsForBinary);
183
184 void CPL_DLL GDALRasterizeOptionsFree( GDALRasterizeOptions *psOptions );
185
186 void CPL_DLL GDALRasterizeOptionsSetProgress( GDALRasterizeOptions *psOptions,
187 GDALProgressFunc pfnProgress,
188 void *pProgressData );
189
190 GDALDatasetH CPL_DLL GDALRasterize( const char *pszDest, GDALDatasetH hDstDS,
191 GDALDatasetH hSrcDS,
192 const GDALRasterizeOptions *psOptions, int *pbUsageError );
193
195 typedef struct GDALBuildVRTOptions GDALBuildVRTOptions;
196
197 typedef struct GDALBuildVRTOptionsForBinary GDALBuildVRTOptionsForBinary;
198
199 GDALBuildVRTOptions CPL_DLL *GDALBuildVRTOptionsNew(char** papszArgv,
200 GDALBuildVRTOptionsForBinary* psOptionsForBinary);
201
202 void CPL_DLL GDALBuildVRTOptionsFree( GDALBuildVRTOptions *psOptions );
203
204 void CPL_DLL GDALBuildVRTOptionsSetProgress( GDALBuildVRTOptions *psOptions,
205 GDALProgressFunc pfnProgress,
206 void *pProgressData );
207
208 GDALDatasetH CPL_DLL GDALBuildVRT( const char *pszDest,
209 int nSrcCount, GDALDatasetH *pahSrcDS, const char* const* papszSrcDSNames,
210 const GDALBuildVRTOptions *psOptions, int *pbUsageError );
211
212 CPL_C_END
213
214 #endif /* GDAL_UTILS_H_INCLUDED */
GDALVectorTranslateOptionsFree
void GDALVectorTranslateOptionsFree(GDALVectorTranslateOptions *psOptions)
Frees the GDALVectorTranslateOptions struct.
Definition: ogr2ogr_lib.cpp:4529
GDALGridOptionsForBinary
Definition: gdal_utils_priv.h:119
GDALVectorTranslateOptionsSetProgress
void GDALVectorTranslateOptionsSetProgress(GDALVectorTranslateOptions *psOptions, GDALProgressFunc pfnProgress, void *pProgressData)
Set a progress function.
Definition: ogr2ogr_lib.cpp:4592
GDALTranslateOptionsNew
GDALTranslateOptions * GDALTranslateOptionsNew(char **papszArgv, GDALTranslateOptionsForBinary *psOptionsForBinary)
Allocates a GDALTranslateOptions struct.
Definition: gdal_translate_lib.cpp:1674
cpl_port.h
Core portability definitions for CPL.
GDALDEMProcessingOptionsSetProgress
void GDALDEMProcessingOptionsSetProgress(GDALDEMProcessingOptions *psOptions, GDALProgressFunc pfnProgress, void *pProgressData)
Set a progress function.
Definition: gdaldem_lib.cpp:3091
GDALGridOptionsNew
GDALGridOptions * GDALGridOptionsNew(char **papszArgv, GDALGridOptionsForBinary *psOptionsForBinary)
Allocates a GDALGridOptions struct.
Definition: gdal_grid_lib.cpp:908
GDALVectorTranslateOptionsForBinary
Definition: gdal_utils_priv.h:88
GDALBuildVRTOptionsForBinary
Definition: gdal_utils_priv.h:138
GDALRasterizeOptionsNew
GDALRasterizeOptions * GDALRasterizeOptionsNew(char **papszArgv, GDALRasterizeOptionsForBinary *psOptionsForBinary)
Allocates a GDALRasterizeOptions struct.
Definition: gdal_rasterize_lib.cpp:767
GDALDatasetH
void * GDALDatasetH
Opaque type used for the C bindings of the C++ GDALDataset class.
Definition: gdal.h:230
GDALTranslateOptionsSetProgress
void GDALTranslateOptionsSetProgress(GDALTranslateOptions *psOptions, GDALProgressFunc pfnProgress, void *pProgressData)
Set a progress function.
Definition: gdal_translate_lib.cpp:2239
GDALBuildVRTOptionsNew
GDALBuildVRTOptions * GDALBuildVRTOptionsNew(char **papszArgv, GDALBuildVRTOptionsForBinary *psOptionsForBinary)
Allocates a GDALBuildVRTOptions struct.
Definition: gdalbuildvrt_lib.cpp:1491
GDALVectorTranslateOptions
struct GDALVectorTranslateOptions GDALVectorTranslateOptions
Definition: gdal_utils.h:101
GDALNearblackOptionsForBinary
Definition: gdal_utils_priv.h:110
GDALInfoOptionsNew
GDALInfoOptions * GDALInfoOptionsNew(char **papszArgv, GDALInfoOptionsForBinary *psOptionsForBinary)
Allocates a GDALInfoOptions struct.
Definition: gdalinfo_lib.cpp:1574
GDALDEMProcessingOptionsNew
GDALDEMProcessingOptions * GDALDEMProcessingOptionsNew(char **papszArgv, GDALDEMProcessingOptionsForBinary *psOptionsForBinary)
Allocates a GDALDEMProcessingOptions struct.
Definition: gdaldem_lib.cpp:2838
GDALGridOptions
struct GDALGridOptions GDALGridOptions
Definition: gdal_utils.h:159
GDALVectorTranslateOptionsNew
GDALVectorTranslateOptions * GDALVectorTranslateOptionsNew(char **papszArgv, GDALVectorTranslateOptionsForBinary *psOptionsForBinary)
allocates a GDALVectorTranslateOptions struct.
Definition: ogr2ogr_lib.cpp:3833
GDALWarpAppOptionsSetProgress
void GDALWarpAppOptionsSetProgress(GDALWarpAppOptions *psOptions, GDALProgressFunc pfnProgress, void *pProgressData)
Set a progress function.
Definition: gdalwarp_lib.cpp:2939
GDALBuildVRT
GDALDatasetH GDALBuildVRT(const char *pszDest, int nSrcCount, GDALDatasetH *pahSrcDS, const char *const *papszSrcDSNames, const GDALBuildVRTOptions *psOptions, int *pbUsageError)
Build a VRT from a list of datasets.
Definition: gdalbuildvrt_lib.cpp:1351
GDALGridOptionsFree
void GDALGridOptionsFree(GDALGridOptions *psOptions)
Frees the GDALGridOptions struct.
Definition: gdal_grid_lib.cpp:1277
GDALTranslateOptions
struct GDALTranslateOptions GDALTranslateOptions
Definition: gdal_utils.h:61
GDALDEMProcessingOptionsForBinary
Definition: gdal_utils_priv.h:99
GDALInfoOptions
struct GDALInfoOptions GDALInfoOptions
Definition: gdal_utils.h:49
GDALRasterizeOptionsFree
void GDALRasterizeOptionsFree(GDALRasterizeOptions *psOptions)
Frees the GDALRasterizeOptions struct.
Definition: gdal_rasterize_lib.cpp:1157
GDALWarpAppOptionsSetWarpOption
void GDALWarpAppOptionsSetWarpOption(GDALWarpAppOptions *psOptions, const char *pszKey, const char *pszValue)
Set a warp option.
Definition: gdalwarp_lib.cpp:2962
GDALInfoOptionsForBinary
Definition: gdal_utils_priv.h:40
gdal.h
Public (C callable) GDAL entry points.
GDALDEMProcessingOptionsFree
void GDALDEMProcessingOptionsFree(GDALDEMProcessingOptions *psOptions)
Frees the GDALDEMProcessingOptions struct.
Definition: gdaldem_lib.cpp:3066
GDALInfo
char * GDALInfo(GDALDatasetH hDataset, const GDALInfoOptions *psOptions)
Lists various information about a GDAL supported raster dataset.
Definition: gdalinfo_lib.cpp:189
GDALVectorTranslate
GDALDatasetH GDALVectorTranslate(const char *pszDest, GDALDatasetH hDstDS, int nSrcCount, GDALDatasetH *pahSrcDS, const GDALVectorTranslateOptions *psOptions, int *pbUsageError)
Converts vector data between file formats.
Definition: ogr2ogr_lib.cpp:1207
GDALDEMProcessing
GDALDatasetH GDALDEMProcessing(const char *pszDestFilename, GDALDatasetH hSrcDataset, const char *pszProcessing, const char *pszColorFilename, const GDALDEMProcessingOptions *psOptions, int *pbUsageError)
Apply a DEM processing.
Definition: gdaldem_lib.cpp:2451
GDALGrid
GDALDatasetH GDALGrid(const char *pszDest, GDALDatasetH hSrcDS, const GDALGridOptions *psOptions, int *pbUsageError)
Create raster from the scattered data.
Definition: gdal_grid_lib.cpp:656
GDALRasterizeOptions
struct GDALRasterizeOptions GDALRasterizeOptions
Definition: gdal_utils.h:177
GDALWarpAppOptionsFree
void GDALWarpAppOptionsFree(GDALWarpAppOptions *psOptions)
Frees the GDALWarpAppOptions struct.
Definition: gdalwarp_lib.cpp:2904
GDALBuildVRTOptions
struct GDALBuildVRTOptions GDALBuildVRTOptions
Definition: gdal_utils.h:195
GDALNearblackOptions
struct GDALNearblackOptions GDALNearblackOptions
Definition: gdal_utils.h:141
GDALWarpAppOptionsForBinary
Definition: gdal_utils_priv.h:63
GDALTranslateOptionsFree
void GDALTranslateOptionsFree(GDALTranslateOptions *psOptions)
Frees the GDALTranslateOptions struct.
Definition: gdal_translate_lib.cpp:2204
GDALWarpAppOptions
struct GDALWarpAppOptions GDALWarpAppOptions
Definition: gdal_utils.h:80
GDALWarpAppOptionsNew
GDALWarpAppOptions * GDALWarpAppOptionsNew(char **papszArgv, GDALWarpAppOptionsForBinary *psOptionsForBinary)
Allocates a GDALWarpAppOptions struct.
Definition: gdalwarp_lib.cpp:2446
GDALGridOptionsSetProgress
void GDALGridOptionsSetProgress(GDALGridOptions *psOptions, GDALProgressFunc pfnProgress, void *pProgressData)
Set a progress function.
Definition: gdal_grid_lib.cpp:1313
GDALWarp
GDALDatasetH GDALWarp(const char *pszDest, GDALDatasetH hDstDS, int nSrcCount, GDALDatasetH *pahSrcDS, const GDALWarpAppOptions *psOptions, int *pbUsageError)
Image reprojection and warping function.
Definition: gdalwarp_lib.cpp:450
GDALNearblackOptionsFree
void GDALNearblackOptionsFree(GDALNearblackOptions *psOptions)
Frees the GDALNearblackOptions struct.
Definition: nearblack_lib.cpp:896
GDALRasterizeOptionsSetProgress
void GDALRasterizeOptionsSetProgress(GDALRasterizeOptions *psOptions, GDALProgressFunc pfnProgress, void *pProgressData)
Set a progress function.
Definition: gdal_rasterize_lib.cpp:1189
GDALInfoOptionsFree
void GDALInfoOptionsFree(GDALInfoOptions *psOptions)
Frees the GDALInfoOptions struct.
Definition: gdalinfo_lib.cpp:1697
GDALTranslateOptionsForBinary
Definition: gdal_utils_priv.h:52
GDALNearblackOptionsSetProgress
void GDALNearblackOptionsSetProgress(GDALNearblackOptions *psOptions, GDALProgressFunc pfnProgress, void *pProgressData)
Set a progress function.
Definition: nearblack_lib.cpp:921
GDALRasterize
GDALDatasetH GDALRasterize(const char *pszDest, GDALDatasetH hDstDS, GDALDatasetH hSrcDS, const GDALRasterizeOptions *psOptions, int *pbUsageError)
Burns vector geometries into a raster.
Definition: gdal_rasterize_lib.cpp:523
GDALBuildVRTOptionsSetProgress
void GDALBuildVRTOptionsSetProgress(GDALBuildVRTOptions *psOptions, GDALProgressFunc pfnProgress, void *pProgressData)
Set a progress function.
Definition: gdalbuildvrt_lib.cpp:1743
GDALBuildVRTOptionsFree
void GDALBuildVRTOptionsFree(GDALBuildVRTOptions *psOptions)
Frees the GDALBuildVRTOptions struct.
Definition: gdalbuildvrt_lib.cpp:1714
GDALTranslate
GDALDatasetH GDALTranslate(const char *pszDestFilename, GDALDatasetH hSrcDataset, const GDALTranslateOptions *psOptions, int *pbUsageError)
Converts raster data between different formats.
Definition: gdal_translate_lib.cpp:482
GDALRasterizeOptionsForBinary
Definition: gdal_utils_priv.h:128
GDALNearblackOptionsNew
GDALNearblackOptions * GDALNearblackOptionsNew(char **papszArgv, GDALNearblackOptionsForBinary *psOptionsForBinary)
Allocates a GDALNearblackOptions struct.
Definition: nearblack_lib.cpp:741
GDALDEMProcessingOptions
struct GDALDEMProcessingOptions GDALDEMProcessingOptions
Definition: gdal_utils.h:120
GDALNearblack
GDALDatasetH GDALNearblack(const char *pszDest, GDALDatasetH hDstDS, GDALDatasetH hSrcDS, const GDALNearblackOptions *psOptions, int *pbUsageError)
Convert nearly black/white borders to exact value.
Definition: nearblack_lib.cpp:96

Generated for GDAL by 1.8.8.