GDAL
Typedefs | Functions
gdal_utils.h File Reference

Public (C callable) GDAL Utilities entry points. More...

#include "cpl_port.h"
#include "gdal.h"

Go to the source code of this file.

Typedefs

typedef struct GDALInfoOptions GDALInfoOptions
 
typedef struct GDALInfoOptionsForBinary GDALInfoOptionsForBinary
 Opaque type.
 
typedef struct GDALTranslateOptions GDALTranslateOptions
 
typedef struct GDALTranslateOptionsForBinary GDALTranslateOptionsForBinary
 Opaque type.
 
typedef struct GDALWarpAppOptions GDALWarpAppOptions
 
typedef struct GDALWarpAppOptionsForBinary GDALWarpAppOptionsForBinary
 Opaque type.
 
typedef struct GDALVectorTranslateOptions GDALVectorTranslateOptions
 
typedef struct GDALVectorTranslateOptionsForBinary GDALVectorTranslateOptionsForBinary
 Opaque type.
 
typedef struct GDALDEMProcessingOptions GDALDEMProcessingOptions
 
typedef struct GDALDEMProcessingOptionsForBinary GDALDEMProcessingOptionsForBinary
 Opaque type.
 
typedef struct GDALNearblackOptions GDALNearblackOptions
 
typedef struct GDALNearblackOptionsForBinary GDALNearblackOptionsForBinary
 Opaque type.
 
typedef struct GDALGridOptions GDALGridOptions
 
typedef struct GDALGridOptionsForBinary GDALGridOptionsForBinary
 Opaque type.
 
typedef struct GDALRasterizeOptions GDALRasterizeOptions
 
typedef struct GDALRasterizeOptionsForBinary GDALRasterizeOptionsForBinary
 Opaque type.
 
typedef struct GDALFootprintOptions GDALFootprintOptions
 
typedef struct GDALFootprintOptionsForBinary GDALFootprintOptionsForBinary
 Opaque type.
 
typedef struct GDALBuildVRTOptions GDALBuildVRTOptions
 
typedef struct GDALBuildVRTOptionsForBinary GDALBuildVRTOptionsForBinary
 Opaque type.
 
typedef struct GDALMultiDimInfoOptions GDALMultiDimInfoOptions
 
typedef struct GDALMultiDimInfoOptionsForBinary GDALMultiDimInfoOptionsForBinary
 Opaque type.
 
typedef struct GDALMultiDimTranslateOptions GDALMultiDimTranslateOptions
 
typedef struct GDALMultiDimTranslateOptionsForBinary GDALMultiDimTranslateOptionsForBinary
 Opaque type.
 
typedef struct GDALVectorInfoOptions GDALVectorInfoOptions
 
typedef struct GDALVectorInfoOptionsForBinary GDALVectorInfoOptionsForBinary
 Opaque type.
 
typedef struct GDALTileIndexOptions GDALTileIndexOptions
 
typedef struct GDALTileIndexOptionsForBinary GDALTileIndexOptionsForBinary
 Opaque type.
 

Functions

GDALInfoOptions * GDALInfoOptionsNew (char **papszArgv, GDALInfoOptionsForBinary *psOptionsForBinary)
 Allocates a GDALInfoOptions struct. More...
 
void GDALInfoOptionsFree (GDALInfoOptions *psOptions)
 Frees the GDALInfoOptions struct. More...
 
char * GDALInfo (GDALDatasetH hDataset, const GDALInfoOptions *psOptions)
 Lists various information about a GDAL supported raster dataset. More...
 
GDALTranslateOptions * GDALTranslateOptionsNew (char **papszArgv, GDALTranslateOptionsForBinary *psOptionsForBinary)
 Allocates a GDALTranslateOptions struct. More...
 
void GDALTranslateOptionsFree (GDALTranslateOptions *psOptions)
 Frees the GDALTranslateOptions struct. More...
 
void GDALTranslateOptionsSetProgress (GDALTranslateOptions *psOptions, GDALProgressFunc pfnProgress, void *pProgressData)
 Set a progress function. More...
 
GDALDatasetH GDALTranslate (const char *pszDestFilename, GDALDatasetH hSrcDataset, const GDALTranslateOptions *psOptions, int *pbUsageError)
 Converts raster data between different formats. More...
 
GDALWarpAppOptions * GDALWarpAppOptionsNew (char **papszArgv, GDALWarpAppOptionsForBinary *psOptionsForBinary)
 Allocates a GDALWarpAppOptions struct. More...
 
void GDALWarpAppOptionsFree (GDALWarpAppOptions *psOptions)
 Frees the GDALWarpAppOptions struct. More...
 
void GDALWarpAppOptionsSetProgress (GDALWarpAppOptions *psOptions, GDALProgressFunc pfnProgress, void *pProgressData)
 Set a progress function. More...
 
void GDALWarpAppOptionsSetQuiet (GDALWarpAppOptions *psOptions, int bQuiet)
 Set a progress function. More...
 
void GDALWarpAppOptionsSetWarpOption (GDALWarpAppOptions *psOptions, const char *pszKey, const char *pszValue)
 Set a warp option. More...
 
GDALDatasetH GDALWarp (const char *pszDest, GDALDatasetH hDstDS, int nSrcCount, GDALDatasetH *pahSrcDS, const GDALWarpAppOptions *psOptions, int *pbUsageError)
 Image reprojection and warping function. More...
 
GDALVectorTranslateOptions * GDALVectorTranslateOptionsNew (char **papszArgv, GDALVectorTranslateOptionsForBinary *psOptionsForBinary)
 allocates a GDALVectorTranslateOptions struct. More...
 
void GDALVectorTranslateOptionsFree (GDALVectorTranslateOptions *psOptions)
 Frees the GDALVectorTranslateOptions struct. More...
 
void GDALVectorTranslateOptionsSetProgress (GDALVectorTranslateOptions *psOptions, GDALProgressFunc pfnProgress, void *pProgressData)
 Set a progress function. More...
 
GDALDatasetH GDALVectorTranslate (const char *pszDest, GDALDatasetH hDstDS, int nSrcCount, GDALDatasetH *pahSrcDS, const GDALVectorTranslateOptions *psOptions, int *pbUsageError)
 Converts vector data between file formats. More...
 
GDALDEMProcessingOptions * GDALDEMProcessingOptionsNew (char **papszArgv, GDALDEMProcessingOptionsForBinary *psOptionsForBinary)
 Allocates a GDALDEMProcessingOptions struct. More...
 
void GDALDEMProcessingOptionsFree (GDALDEMProcessingOptions *psOptions)
 Frees the GDALDEMProcessingOptions struct. More...
 
void GDALDEMProcessingOptionsSetProgress (GDALDEMProcessingOptions *psOptions, GDALProgressFunc pfnProgress, void *pProgressData)
 Set a progress function. More...
 
GDALDatasetH GDALDEMProcessing (const char *pszDestFilename, GDALDatasetH hSrcDataset, const char *pszProcessing, const char *pszColorFilename, const GDALDEMProcessingOptions *psOptions, int *pbUsageError)
 Apply a DEM processing. More...
 
GDALNearblackOptionsGDALNearblackOptionsNew (char **papszArgv, GDALNearblackOptionsForBinary *psOptionsForBinary)
 Allocates a GDALNearblackOptions struct. More...
 
void GDALNearblackOptionsFree (GDALNearblackOptions *psOptions)
 Frees the GDALNearblackOptions struct. More...
 
void GDALNearblackOptionsSetProgress (GDALNearblackOptions *psOptions, GDALProgressFunc pfnProgress, void *pProgressData)
 Set a progress function. More...
 
GDALDatasetH GDALNearblack (const char *pszDest, GDALDatasetH hDstDS, GDALDatasetH hSrcDS, const GDALNearblackOptions *psOptions, int *pbUsageError)
 Convert nearly black/white borders to exact value. More...
 
GDALGridOptions * GDALGridOptionsNew (char **papszArgv, GDALGridOptionsForBinary *psOptionsForBinary)
 Allocates a GDALGridOptions struct. More...
 
void GDALGridOptionsFree (GDALGridOptions *psOptions)
 Frees the GDALGridOptions struct. More...
 
void GDALGridOptionsSetProgress (GDALGridOptions *psOptions, GDALProgressFunc pfnProgress, void *pProgressData)
 Set a progress function. More...
 
GDALDatasetH GDALGrid (const char *pszDest, GDALDatasetH hSrcDS, const GDALGridOptions *psOptions, int *pbUsageError)
 Create raster from the scattered data. More...
 
GDALRasterizeOptions * GDALRasterizeOptionsNew (char **papszArgv, GDALRasterizeOptionsForBinary *psOptionsForBinary)
 Allocates a GDALRasterizeOptions struct. More...
 
void GDALRasterizeOptionsFree (GDALRasterizeOptions *psOptions)
 Frees the GDALRasterizeOptions struct. More...
 
void GDALRasterizeOptionsSetProgress (GDALRasterizeOptions *psOptions, GDALProgressFunc pfnProgress, void *pProgressData)
 Set a progress function. More...
 
GDALDatasetH GDALRasterize (const char *pszDest, GDALDatasetH hDstDS, GDALDatasetH hSrcDS, const GDALRasterizeOptions *psOptions, int *pbUsageError)
 Burns vector geometries into a raster. More...
 
GDALFootprintOptions * GDALFootprintOptionsNew (char **papszArgv, GDALFootprintOptionsForBinary *psOptionsForBinary)
 Allocates a GDALFootprintOptions struct. More...
 
void GDALFootprintOptionsFree (GDALFootprintOptions *psOptions)
 Frees the GDALFootprintOptions struct. More...
 
void GDALFootprintOptionsSetProgress (GDALFootprintOptions *psOptions, GDALProgressFunc pfnProgress, void *pProgressData)
 Set a progress function. More...
 
GDALDatasetH GDALFootprint (const char *pszDest, GDALDatasetH hDstDS, GDALDatasetH hSrcDS, const GDALFootprintOptions *psOptions, int *pbUsageError)
 Computes the footprint of a raster. More...
 
GDALBuildVRTOptions * GDALBuildVRTOptionsNew (char **papszArgv, GDALBuildVRTOptionsForBinary *psOptionsForBinary)
 Allocates a GDALBuildVRTOptions struct. More...
 
void GDALBuildVRTOptionsFree (GDALBuildVRTOptions *psOptions)
 Frees the GDALBuildVRTOptions struct. More...
 
void GDALBuildVRTOptionsSetProgress (GDALBuildVRTOptions *psOptions, GDALProgressFunc pfnProgress, void *pProgressData)
 Set a progress function. More...
 
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. More...
 
GDALMultiDimInfoOptions * GDALMultiDimInfoOptionsNew (char **papszArgv, GDALMultiDimInfoOptionsForBinary *psOptionsForBinary)
 Allocates a GDALMultiDimInfo struct. More...
 
void GDALMultiDimInfoOptionsFree (GDALMultiDimInfoOptions *psOptions)
 Frees the GDALMultiDimInfoOptions struct. More...
 
char * GDALMultiDimInfo (GDALDatasetH hDataset, const GDALMultiDimInfoOptions *psOptions)
 Lists various information about a GDAL multidimensional dataset. More...
 
GDALMultiDimTranslateOptions * GDALMultiDimTranslateOptionsNew (char **papszArgv, GDALMultiDimTranslateOptionsForBinary *psOptionsForBinary)
 Allocates a GDALMultiDimTranslateOptions struct. More...
 
void GDALMultiDimTranslateOptionsFree (GDALMultiDimTranslateOptions *psOptions)
 Frees the GDALMultiDimTranslateOptions struct. More...
 
void GDALMultiDimTranslateOptionsSetProgress (GDALMultiDimTranslateOptions *psOptions, GDALProgressFunc pfnProgress, void *pProgressData)
 Set a progress function. More...
 
GDALDatasetH GDALMultiDimTranslate (const char *pszDest, GDALDatasetH hDstDataset, int nSrcCount, GDALDatasetH *pahSrcDS, const GDALMultiDimTranslateOptions *psOptions, int *pbUsageError)
 Converts raster data between different formats. More...
 
GDALVectorInfoOptions * GDALVectorInfoOptionsNew (char **papszArgv, GDALVectorInfoOptionsForBinary *psOptionsForBinary)
 Allocates a GDALVectorInfoOptions struct. More...
 
void GDALVectorInfoOptionsFree (GDALVectorInfoOptions *psOptions)
 Frees the GDALVectorInfoOptions struct. More...
 
char * GDALVectorInfo (GDALDatasetH hDataset, const GDALVectorInfoOptions *psOptions)
 Lists various information about a GDAL supported vector dataset. More...
 
GDALTileIndexOptions * GDALTileIndexOptionsNew (char **papszArgv, GDALTileIndexOptionsForBinary *psOptionsForBinary)
 Allocates a GDALTileIndexOptions struct. More...
 
void GDALTileIndexOptionsFree (GDALTileIndexOptions *psOptions)
 Frees the GDALTileIndexOptions struct. More...
 
GDALDatasetH GDALTileIndex (const char *pszDest, int nSrcCount, const char *const *papszSrcDSNames, const GDALTileIndexOptions *psOptions, int *pbUsageError)
 Build a tile index from a list of datasets. More...
 

Detailed Description

Public (C callable) GDAL Utilities entry points.

Since
GDAL 2.1

Typedef Documentation

◆ GDALBuildVRTOptions

typedef struct GDALBuildVRTOptions GDALBuildVRTOptions

Options for GDALBuildVRT(). Opaque type

◆ GDALDEMProcessingOptions

typedef struct GDALDEMProcessingOptions GDALDEMProcessingOptions

Options for GDALDEMProcessing(). Opaque type

◆ GDALFootprintOptions

typedef struct GDALFootprintOptions GDALFootprintOptions

Options for GDALFootprint(). Opaque type

◆ GDALGridOptions

typedef struct GDALGridOptions GDALGridOptions

Options for GDALGrid(). Opaque type

◆ GDALInfoOptions

typedef struct GDALInfoOptions GDALInfoOptions

Options for GDALInfo(). Opaque type

◆ GDALMultiDimInfoOptions

typedef struct GDALMultiDimInfoOptions GDALMultiDimInfoOptions

Options for GDALMultiDimInfo(). Opaque type

◆ GDALMultiDimTranslateOptions

typedef struct GDALMultiDimTranslateOptions GDALMultiDimTranslateOptions

Options for GDALMultiDimTranslate(). Opaque type

◆ GDALNearblackOptions

Options for GDALNearblack(). Opaque type

◆ GDALRasterizeOptions

typedef struct GDALRasterizeOptions GDALRasterizeOptions

Options for GDALRasterize(). Opaque type

◆ GDALTileIndexOptions

typedef struct GDALTileIndexOptions GDALTileIndexOptions

Options for GDALTileIndex(). Opaque type

◆ GDALTranslateOptions

typedef struct GDALTranslateOptions GDALTranslateOptions

Options for GDALTranslate(). Opaque type

◆ GDALVectorInfoOptions

typedef struct GDALVectorInfoOptions GDALVectorInfoOptions

Options for GDALVectorInfo(). Opaque type

◆ GDALVectorTranslateOptions

typedef struct GDALVectorTranslateOptions GDALVectorTranslateOptions

Options for GDALVectorTranslate(). Opaque type

◆ GDALWarpAppOptions

typedef struct GDALWarpAppOptions GDALWarpAppOptions

Options for GDALWarp(). Opaque type

Function Documentation

◆ GDALBuildVRT()

GDALDatasetH GDALBuildVRT ( const char *  pszDest,
int  nSrcCount,
GDALDatasetH pahSrcDS,
const char *const *  papszSrcDSNames,
const GDALBuildVRTOptions *  psOptionsIn,
int *  pbUsageError 
)

Build a VRT from a list of datasets.

This is the equivalent of the gdalbuildvrt utility.

GDALBuildVRTOptions* must be allocated and freed with GDALBuildVRTOptionsNew() and GDALBuildVRTOptionsFree() respectively. pahSrcDS and papszSrcDSNames cannot be used at the same time.

Parameters
pszDestthe destination dataset path.
nSrcCountthe number of input datasets.
pahSrcDSthe list of input datasets (or NULL, exclusive with papszSrcDSNames). For practical purposes, the type of this argument should be considered as "const GDALDatasetH* const*", that is neither the array nor its values are mutated by this function.
papszSrcDSNamesthe list of input dataset names (or NULL, exclusive with pahSrcDS)
psOptionsInthe options struct returned by GDALBuildVRTOptionsNew() or NULL.
pbUsageErrorpointer to a integer output variable to store if any usage error has occurred.
Returns
the output dataset (new dataset that must be closed using GDALClose()) or NULL in case of error. If using pahSrcDS, the returned VRT dataset has a reference to each pahSrcDS[] element. Hence pahSrcDS[] elements should be closed after the returned dataset if using GDALClose(). A safer alternative is to use GDALReleaseDataset() instead of using GDALClose(), in which case you can close datasets in any order.
Since
GDAL 2.1

◆ GDALBuildVRTOptionsFree()

void GDALBuildVRTOptionsFree ( GDALBuildVRTOptions *  psOptions)

Frees the GDALBuildVRTOptions struct.

Parameters
psOptionsthe options struct for GDALBuildVRT().
Since
GDAL 2.1

◆ GDALBuildVRTOptionsNew()

GDALBuildVRTOptions * GDALBuildVRTOptionsNew ( char **  papszArgv,
GDALBuildVRTOptionsForBinary psOptionsForBinary 
)

Allocates a GDALBuildVRTOptions struct.

Parameters
papszArgvNULL terminated list of options (potentially including filename and open options too), or NULL. The accepted options are the ones of the gdalbuildvrt utility.
psOptionsForBinary(output) may be NULL (and should generally be NULL), otherwise (gdalbuildvrt_bin.cpp use case) must be allocated with GDALBuildVRTOptionsForBinaryNew() prior to this function. Will be filled with potentially present filename, open options,...
Returns
pointer to the allocated GDALBuildVRTOptions struct. Must be freed with GDALBuildVRTOptionsFree().
Since
GDAL 2.1

◆ GDALBuildVRTOptionsSetProgress()

void GDALBuildVRTOptionsSetProgress ( GDALBuildVRTOptions *  psOptions,
GDALProgressFunc  pfnProgress,
void *  pProgressData 
)

Set a progress function.

Parameters
psOptionsthe options struct for GDALBuildVRT().
pfnProgressthe progress callback.
pProgressDatathe user data for the progress callback.
Since
GDAL 2.1

◆ GDALDEMProcessing()

GDALDatasetH GDALDEMProcessing ( const char *  pszDest,
GDALDatasetH  hSrcDataset,
const char *  pszProcessing,
const char *  pszColorFilename,
const GDALDEMProcessingOptions *  psOptionsIn,
int *  pbUsageError 
)

Apply a DEM processing.

This is the equivalent of the gdaldem utility.

GDALDEMProcessingOptions* must be allocated and freed with GDALDEMProcessingOptionsNew() and GDALDEMProcessingOptionsFree() respectively.

Parameters
pszDestthe destination dataset path.
hSrcDatasetthe source dataset handle.
pszProcessingthe processing to apply (one of "hillshade", "slope", "aspect", "color-relief", "TRI", "TPI", "Roughness")
pszColorFilenamecolor file (mandatory for "color-relief" processing, should be NULL otherwise)
psOptionsInthe options struct returned by GDALDEMProcessingOptionsNew() or NULL.
pbUsageErrorpointer to a integer output variable to store if any usage error has occurred or NULL.
Returns
the output dataset (new dataset that must be closed using GDALClose()) or NULL in case of error.
Since
GDAL 2.1

◆ GDALDEMProcessingOptionsFree()

void GDALDEMProcessingOptionsFree ( GDALDEMProcessingOptions *  psOptions)

Frees the GDALDEMProcessingOptions struct.

Parameters
psOptionsthe options struct for GDALDEMProcessing().
Since
GDAL 2.1

◆ GDALDEMProcessingOptionsNew()

GDALDEMProcessingOptions * GDALDEMProcessingOptionsNew ( char **  papszArgv,
GDALDEMProcessingOptionsForBinary psOptionsForBinary 
)

Allocates a GDALDEMProcessingOptions struct.

Parameters
papszArgvNULL terminated list of options (potentially including filename and open options too), or NULL. The accepted options are the ones of the gdaldem utility.
psOptionsForBinary(output) may be NULL (and should generally be NULL), otherwise (gdal_translate_bin.cpp use case) must be allocated with GDALDEMProcessingOptionsForBinaryNew() prior to this function. Will be filled with potentially present filename, open options,...
Returns
pointer to the allocated GDALDEMProcessingOptions struct. Must be freed with GDALDEMProcessingOptionsFree().
Since
GDAL 2.1

◆ GDALDEMProcessingOptionsSetProgress()

void GDALDEMProcessingOptionsSetProgress ( GDALDEMProcessingOptions *  psOptions,
GDALProgressFunc  pfnProgress,
void *  pProgressData 
)

Set a progress function.

Parameters
psOptionsthe options struct for GDALDEMProcessing().
pfnProgressthe progress callback.
pProgressDatathe user data for the progress callback.
Since
GDAL 2.1

◆ GDALFootprint()

GDALDatasetH GDALFootprint ( const char *  pszDest,
GDALDatasetH  hDstDS,
GDALDatasetH  hSrcDataset,
const GDALFootprintOptions *  psOptionsIn,
int *  pbUsageError 
)

Computes the footprint of a raster.

This is the equivalent of the gdal_footprint utility.

GDALFootprintOptions* must be allocated and freed with GDALFootprintOptionsNew() and GDALFootprintOptionsFree() respectively. pszDest and hDstDS cannot be used at the same time.

Parameters
pszDestthe vector destination dataset path or NULL.
hDstDSthe vector destination dataset or NULL.
hSrcDatasetthe raster source dataset handle.
psOptionsInthe options struct returned by GDALFootprintOptionsNew() or NULL.
pbUsageErrorpointer to a integer output variable to store if any usage error has occurred or NULL.
Returns
the output dataset (new dataset that must be closed using GDALClose(), or hDstDS is not NULL) or NULL in case of error.
Since
GDAL 3.8

◆ GDALFootprintOptionsFree()

void GDALFootprintOptionsFree ( GDALFootprintOptions *  psOptions)

Frees the GDALFootprintOptions struct.

Parameters
psOptionsthe options struct for GDALFootprint().
Since
GDAL 3.8

◆ GDALFootprintOptionsNew()

GDALFootprintOptions * GDALFootprintOptionsNew ( char **  papszArgv,
GDALFootprintOptionsForBinary psOptionsForBinary 
)

Allocates a GDALFootprintOptions struct.

Parameters
papszArgvNULL terminated list of options (potentially including filename and open options too), or NULL. The accepted options are the ones of the gdal_rasterize utility.
psOptionsForBinary(output) may be NULL (and should generally be NULL), otherwise (gdal_translate_bin.cpp use case) must be allocated with GDALFootprintOptionsForBinaryNew() prior to this function. Will be filled with potentially present filename, open options,...
Returns
pointer to the allocated GDALFootprintOptions struct. Must be freed with GDALFootprintOptionsFree().
Since
GDAL 3.8

◆ GDALFootprintOptionsSetProgress()

void GDALFootprintOptionsSetProgress ( GDALFootprintOptions *  psOptions,
GDALProgressFunc  pfnProgress,
void *  pProgressData 
)

Set a progress function.

Parameters
psOptionsthe options struct for GDALFootprint().
pfnProgressthe progress callback.
pProgressDatathe user data for the progress callback.
Since
GDAL 3.8

◆ GDALGrid()

GDALDatasetH GDALGrid ( const char *  pszDest,
GDALDatasetH  hSrcDataset,
const GDALGridOptions *  psOptionsIn,
int *  pbUsageError 
)

Create raster from the scattered data.

This is the equivalent of the gdal_grid utility.

GDALGridOptions* must be allocated and freed with GDALGridOptionsNew() and GDALGridOptionsFree() respectively.

Parameters
pszDestthe destination dataset path.
hSrcDatasetthe source dataset handle.
psOptionsInthe options struct returned by GDALGridOptionsNew() or NULL.
pbUsageErrorpointer to a integer output variable to store if any usage error has occurred or NULL.
Returns
the output dataset (new dataset that must be closed using GDALClose()) or NULL in case of error.
Since
GDAL 2.1

◆ GDALGridOptionsFree()

void GDALGridOptionsFree ( GDALGridOptions *  psOptions)

Frees the GDALGridOptions struct.

Parameters
psOptionsthe options struct for GDALGrid().
Since
GDAL 2.1

◆ GDALGridOptionsNew()

GDALGridOptions * GDALGridOptionsNew ( char **  papszArgv,
GDALGridOptionsForBinary psOptionsForBinary 
)

Allocates a GDALGridOptions struct.

Parameters
papszArgvNULL terminated list of options (potentially including filename and open options too), or NULL. The accepted options are the ones of the gdal_translate utility.
psOptionsForBinary(output) may be NULL (and should generally be NULL), otherwise (gdal_translate_bin.cpp use case) must be allocated with GDALGridOptionsForBinaryNew() prior to this function. Will be filled with potentially present filename, open options,...
Returns
pointer to the allocated GDALGridOptions struct. Must be freed with GDALGridOptionsFree().
Since
GDAL 2.1

◆ GDALGridOptionsSetProgress()

void GDALGridOptionsSetProgress ( GDALGridOptions *  psOptions,
GDALProgressFunc  pfnProgress,
void *  pProgressData 
)

Set a progress function.

Parameters
psOptionsthe options struct for GDALGrid().
pfnProgressthe progress callback.
pProgressDatathe user data for the progress callback.
Since
GDAL 2.1

◆ GDALInfo()

char * GDALInfo ( GDALDatasetH  hDataset,
const GDALInfoOptions *  psOptions 
)

Lists various information about a GDAL supported raster dataset.

This is the equivalent of the gdalinfo utility.

GDALInfoOptions* must be allocated and freed with GDALInfoOptionsNew() and GDALInfoOptionsFree() respectively.

Parameters
hDatasetthe dataset handle.
psOptionsthe options structure returned by GDALInfoOptionsNew() or NULL.
Returns
string corresponding to the information about the raster dataset (must be freed with CPLFree()), or NULL in case of error.
Since
GDAL 2.1

◆ GDALInfoOptionsFree()

void GDALInfoOptionsFree ( GDALInfoOptions *  psOptions)

Frees the GDALInfoOptions struct.

Parameters
psOptionsthe options struct for GDALInfo().
Since
GDAL 2.1

◆ GDALInfoOptionsNew()

GDALInfoOptions * GDALInfoOptionsNew ( char **  papszArgv,
GDALInfoOptionsForBinary psOptionsForBinary 
)

Allocates a GDALInfoOptions struct.

Parameters
papszArgvNULL terminated list of options (potentially including filename and open options too), or NULL. The accepted options are the ones of the gdalinfo utility.
psOptionsForBinary(output) may be NULL (and should generally be NULL), otherwise (gdalinfo_bin.cpp use case) must be allocated with GDALInfoOptionsForBinaryNew() prior to this function. Will be filled with potentially present filename, open options, subdataset number...
Returns
pointer to the allocated GDALInfoOptions struct. Must be freed with GDALInfoOptionsFree().
Since
GDAL 2.1

◆ GDALMultiDimInfo()

char * GDALMultiDimInfo ( GDALDatasetH  hDataset,
const GDALMultiDimInfoOptions *  psOptionsIn 
)

Lists various information about a GDAL multidimensional dataset.

This is the equivalent of the gdalmdiminfoutility.

GDALMultiDimInfoOptions* must be allocated and freed with GDALMultiDimInfoOptionsNew() and GDALMultiDimInfoOptionsFree() respectively.

Parameters
hDatasetthe dataset handle.
psOptionsInthe options structure returned by GDALMultiDimInfoOptionsNew() or NULL.
Returns
string corresponding to the information about the raster dataset (must be freed with CPLFree()), or NULL in case of error.
Since
GDAL 3.1

◆ GDALMultiDimInfoOptionsFree()

void GDALMultiDimInfoOptionsFree ( GDALMultiDimInfoOptions *  psOptions)

Frees the GDALMultiDimInfoOptions struct.

Parameters
psOptionsthe options struct for GDALMultiDimInfo().
Since
GDAL 3.1

◆ GDALMultiDimInfoOptionsNew()

GDALMultiDimInfoOptions * GDALMultiDimInfoOptionsNew ( char **  papszArgv,
GDALMultiDimInfoOptionsForBinary psOptionsForBinary 
)

Allocates a GDALMultiDimInfo struct.

Parameters
papszArgvNULL terminated list of options (potentially including filename and open options too), or NULL. The accepted options are the ones of the gdalmdiminfo utility.
psOptionsForBinaryshould be nullptr, unless called from gdalmultidiminfo_bin.cpp
Returns
pointer to the allocated GDALMultiDimInfoOptions struct. Must be freed with GDALMultiDimInfoOptionsFree().
Since
GDAL 3.1

◆ GDALMultiDimTranslate()

GDALDatasetH GDALMultiDimTranslate ( const char *  pszDest,
GDALDatasetH  hDstDS,
int  nSrcCount,
GDALDatasetH pahSrcDS,
const GDALMultiDimTranslateOptions *  psOptions,
int *  pbUsageError 
)

Converts raster data between different formats.

This is the equivalent of the gdalmdimtranslate utility.

GDALMultiDimTranslateOptions* must be allocated and freed with GDALMultiDimTranslateOptionsNew() and GDALMultiDimTranslateOptionsFree() respectively. pszDest and hDstDS cannot be used at the same time.

Parameters
pszDestthe destination dataset path or NULL.
hDstDSthe destination dataset or NULL.
nSrcCountthe number of input datasets.
pahSrcDSthe list of input datasets.
psOptionsthe options struct returned by GDALMultiDimTranslateOptionsNew() or NULL.
pbUsageErrorpointer to a integer output variable to store if any usage error has occurred or NULL.
Returns
the output dataset (new dataset that must be closed using GDALClose(), or hDstDS is not NULL) or NULL in case of error.
Since
GDAL 3.1

◆ GDALMultiDimTranslateOptionsFree()

void GDALMultiDimTranslateOptionsFree ( GDALMultiDimTranslateOptions *  psOptions)

Frees the GDALMultiDimTranslateOptions struct.

Parameters
psOptionsthe options struct for GDALMultiDimTranslate().
Since
GDAL 3.1

◆ GDALMultiDimTranslateOptionsNew()

GDALMultiDimTranslateOptions * GDALMultiDimTranslateOptionsNew ( char **  papszArgv,
GDALMultiDimTranslateOptionsForBinary psOptionsForBinary 
)

Allocates a GDALMultiDimTranslateOptions struct.

Parameters
papszArgvNULL terminated list of options (potentially including filename and open options too), or NULL. The accepted options are the ones of the gdalmdimtranslate utility.
psOptionsForBinaryshould be nullptr, unless called from gdalmdimtranslate_bin.cpp
Returns
pointer to the allocated GDALMultiDimTranslateOptions struct. Must be freed with GDALMultiDimTranslateOptionsFree().
Since
GDAL 3.1

◆ GDALMultiDimTranslateOptionsSetProgress()

void GDALMultiDimTranslateOptionsSetProgress ( GDALMultiDimTranslateOptions *  psOptions,
GDALProgressFunc  pfnProgress,
void *  pProgressData 
)

Set a progress function.

Parameters
psOptionsthe options struct for GDALMultiDimTranslate().
pfnProgressthe progress callback.
pProgressDatathe user data for the progress callback.
Since
GDAL 3.1

◆ GDALNearblack()

GDALDatasetH GDALNearblack ( const char *  pszDest,
GDALDatasetH  hDstDS,
GDALDatasetH  hSrcDataset,
const GDALNearblackOptions psOptionsIn,
int *  pbUsageError 
)

Convert nearly black/white borders to exact value.

This is the equivalent of the nearblack utility.

GDALNearblackOptions* must be allocated and freed with GDALNearblackOptionsNew() and GDALNearblackOptionsFree() respectively. pszDest and hDstDS cannot be used at the same time.

In-place update (i.e. hDstDS == hSrcDataset) is possible for formats that support it, and if the dataset is opened in update mode.

Parameters
pszDestthe destination dataset path or NULL.
hDstDSthe destination dataset or NULL. Might be equal to hSrcDataset.
hSrcDatasetthe source dataset handle.
psOptionsInthe options struct returned by GDALNearblackOptionsNew() or NULL.
pbUsageErrorpointer to a integer output variable to store if any usage error has occurred or NULL.
Returns
the output dataset (new dataset that must be closed using GDALClose(), or hDstDS when it is not NULL) or NULL in case of error.
Since
GDAL 2.1

◆ GDALNearblackOptionsFree()

void GDALNearblackOptionsFree ( GDALNearblackOptions psOptions)

Frees the GDALNearblackOptions struct.

Parameters
psOptionsthe options struct for GDALNearblack().
Since
GDAL 2.1

◆ GDALNearblackOptionsNew()

GDALNearblackOptions * GDALNearblackOptionsNew ( char **  papszArgv,
GDALNearblackOptionsForBinary psOptionsForBinary 
)

Allocates a GDALNearblackOptions struct.

Parameters
papszArgvNULL terminated list of options (potentially including filename and open options too), or NULL. The accepted options are the ones of the nearblack utility.
psOptionsForBinary(output) may be NULL (and should generally be NULL), otherwise (gdal_translate_bin.cpp use case) must be allocated with GDALNearblackOptionsForBinaryNew() prior to this function. Will be filled with potentially present filename, open options,...
Returns
pointer to the allocated GDALNearblackOptions struct. Must be freed with GDALNearblackOptionsFree().
Since
GDAL 2.1

◆ GDALNearblackOptionsSetProgress()

void GDALNearblackOptionsSetProgress ( GDALNearblackOptions psOptions,
GDALProgressFunc  pfnProgress,
void *  pProgressData 
)

Set a progress function.

Parameters
psOptionsthe options struct for GDALNearblack().
pfnProgressthe progress callback.
pProgressDatathe user data for the progress callback.
Since
GDAL 2.1

◆ GDALRasterize()

GDALDatasetH GDALRasterize ( const char *  pszDest,
GDALDatasetH  hDstDS,
GDALDatasetH  hSrcDataset,
const GDALRasterizeOptions *  psOptionsIn,
int *  pbUsageError 
)

Burns vector geometries into a raster.

This is the equivalent of the gdal_rasterize utility.

GDALRasterizeOptions* must be allocated and freed with GDALRasterizeOptionsNew() and GDALRasterizeOptionsFree() respectively. pszDest and hDstDS cannot be used at the same time.

Parameters
pszDestthe destination dataset path or NULL.
hDstDSthe destination dataset or NULL.
hSrcDatasetthe source dataset handle.
psOptionsInthe options struct returned by GDALRasterizeOptionsNew() or NULL.
pbUsageErrorpointer to a integer output variable to store if any usage error has occurred or NULL.
Returns
the output dataset (new dataset that must be closed using GDALClose(), or hDstDS is not NULL) or NULL in case of error.
Since
GDAL 2.1

◆ GDALRasterizeOptionsFree()

void GDALRasterizeOptionsFree ( GDALRasterizeOptions *  psOptions)

Frees the GDALRasterizeOptions struct.

Parameters
psOptionsthe options struct for GDALRasterize().
Since
GDAL 2.1

◆ GDALRasterizeOptionsNew()

GDALRasterizeOptions * GDALRasterizeOptionsNew ( char **  papszArgv,
GDALRasterizeOptionsForBinary psOptionsForBinary 
)

Allocates a GDALRasterizeOptions struct.

Parameters
papszArgvNULL terminated list of options (potentially including filename and open options too), or NULL. The accepted options are the ones of the gdal_rasterize utility.
psOptionsForBinary(output) may be NULL (and should generally be NULL), otherwise (gdal_translate_bin.cpp use case) must be allocated with GDALRasterizeOptionsForBinaryNew() prior to this function. Will be filled with potentially present filename, open options,...
Returns
pointer to the allocated GDALRasterizeOptions struct. Must be freed with GDALRasterizeOptionsFree().
Since
GDAL 2.1

◆ GDALRasterizeOptionsSetProgress()

void GDALRasterizeOptionsSetProgress ( GDALRasterizeOptions *  psOptions,
GDALProgressFunc  pfnProgress,
void *  pProgressData 
)

Set a progress function.

Parameters
psOptionsthe options struct for GDALRasterize().
pfnProgressthe progress callback.
pProgressDatathe user data for the progress callback.
Since
GDAL 2.1

◆ GDALTileIndex()

GDALDatasetH GDALTileIndex ( const char *  pszDest,
int  nSrcCount,
const char *const *  papszSrcDSNames,
const GDALTileIndexOptions *  psOptionsIn,
int *  pbUsageError 
)

Build a tile index from a list of datasets.

This is the equivalent of the gdaltindex utility.

GDALTileIndexOptions* must be allocated and freed with GDALTileIndexOptionsNew() and GDALTileIndexOptionsFree() respectively.

Parameters
pszDestthe destination dataset path.
nSrcCountthe number of input datasets.
papszSrcDSNamesthe list of input dataset names
psOptionsInthe options struct returned by GDALTileIndexOptionsNew() or NULL.
pbUsageErrorpointer to a integer output variable to store if any usage error has occurred.
Returns
the output dataset (new dataset that must be closed using GDALClose()) or NULL in case of error.
Since
GDAL3.9

◆ GDALTileIndexOptionsFree()

void GDALTileIndexOptionsFree ( GDALTileIndexOptions *  psOptions)

Frees the GDALTileIndexOptions struct.

Parameters
psOptionsthe options struct for GDALTileIndex().
Since
GDAL 3.9

◆ GDALTileIndexOptionsNew()

GDALTileIndexOptions * GDALTileIndexOptionsNew ( char **  papszArgv,
GDALTileIndexOptionsForBinary psOptionsForBinary 
)

Allocates a GDALTileIndexOptions struct.

Parameters
papszArgvNULL terminated list of options (potentially including filename and open options too), or NULL. The accepted options are the ones of the gdaltindex utility.
psOptionsForBinary(output) may be NULL (and should generally be NULL), otherwise (gdaltindex_bin.cpp use case) must be allocated with GDALTileIndexOptionsForBinaryNew() prior to this function. Will be filled with potentially present filename, open options,...
Returns
pointer to the allocated GDALTileIndexOptions struct. Must be freed with GDALTileIndexOptionsFree().
Since
GDAL 3.9

◆ GDALTranslate()

GDALDatasetH GDALTranslate ( const char *  pszDest,
GDALDatasetH  hSrcDataset,
const GDALTranslateOptions *  psOptionsIn,
int *  pbUsageError 
)

Converts raster data between different formats.

This is the equivalent of the gdal_translate utility.

GDALTranslateOptions* must be allocated and freed with GDALTranslateOptionsNew() and GDALTranslateOptionsFree() respectively.

Parameters
pszDestthe destination dataset path.
hSrcDatasetthe source dataset handle.
psOptionsInthe options struct returned by GDALTranslateOptionsNew() or NULL.
pbUsageErrorpointer to a integer output variable to store if any usage error has occurred or NULL.
Returns
the output dataset (new dataset that must be closed using GDALClose()) or NULL in case of error. If the output format is a VRT dataset, then the returned VRT dataset has a reference to hSrcDataset. Hence hSrcDataset should be closed after the returned dataset if using GDALClose(). A safer alternative is to use GDALReleaseDataset() instead of using GDALClose(), in which case you can close datasets in any order.
Since
GDAL 2.1

◆ GDALTranslateOptionsFree()

void GDALTranslateOptionsFree ( GDALTranslateOptions *  psOptions)

Frees the GDALTranslateOptions struct.

Parameters
psOptionsthe options struct for GDALTranslate().
Since
GDAL 2.1

◆ GDALTranslateOptionsNew()

GDALTranslateOptions * GDALTranslateOptionsNew ( char **  papszArgv,
GDALTranslateOptionsForBinary psOptionsForBinary 
)

Allocates a GDALTranslateOptions struct.

Parameters
papszArgvNULL terminated list of options (potentially including filename and open options too), or NULL. The accepted options are the ones of the gdal_translate utility.
psOptionsForBinary(output) may be NULL (and should generally be NULL), otherwise (gdal_translate_bin.cpp use case) must be allocated with GDALTranslateOptionsForBinaryNew() prior to this function. Will be filled with potentially present filename, open options,...
Returns
pointer to the allocated GDALTranslateOptions struct. Must be freed with GDALTranslateOptionsFree().
Since
GDAL 2.1

◆ GDALTranslateOptionsSetProgress()

void GDALTranslateOptionsSetProgress ( GDALTranslateOptions *  psOptions,
GDALProgressFunc  pfnProgress,
void *  pProgressData 
)

Set a progress function.

Parameters
psOptionsthe options struct for GDALTranslate().
pfnProgressthe progress callback.
pProgressDatathe user data for the progress callback.
Since
GDAL 2.1

◆ GDALVectorInfo()

char * GDALVectorInfo ( GDALDatasetH  hDataset,
const GDALVectorInfoOptions *  psOptions 
)

Lists various information about a GDAL supported vector dataset.

This is the equivalent of the ogrinfo utility.

GDALVectorInfoOptions* must be allocated and freed with GDALVectorInfoOptionsNew() and GDALVectorInfoOptionsFree() respectively.

Parameters
hDatasetthe dataset handle.
psOptionsthe options structure returned by GDALVectorInfoOptionsNew() or NULL.
Returns
string corresponding to the information about the raster dataset (must be freed with CPLFree()), or NULL in case of error.
Since
GDAL 3.7

◆ GDALVectorInfoOptionsFree()

void GDALVectorInfoOptionsFree ( GDALVectorInfoOptions *  psOptions)

Frees the GDALVectorInfoOptions struct.

Parameters
psOptionsthe options struct for GDALVectorInfo().
Since
GDAL 3.7

◆ GDALVectorInfoOptionsNew()

GDALVectorInfoOptions * GDALVectorInfoOptionsNew ( char **  papszArgv,
GDALVectorInfoOptionsForBinary psOptionsForBinary 
)

Allocates a GDALVectorInfoOptions struct.

Parameters
papszArgvNULL terminated list of options (potentially including filename and open options too), or NULL. The accepted options are the ones of the ogrinfo utility.
psOptionsForBinary(output) may be NULL (and should generally be NULL), otherwise (ogrinfo_bin.cpp use case) must be allocated with GDALVectorInfoOptionsForBinaryNew() prior to this function. Will be filled with potentially present filename, open options, subdataset number...
Returns
pointer to the allocated GDALVectorInfoOptions struct. Must be freed with GDALVectorInfoOptionsFree().
Since
GDAL 3.7

◆ GDALVectorTranslate()

GDALDatasetH GDALVectorTranslate ( const char *  pszDest,
GDALDatasetH  hDstDS,
int  nSrcCount,
GDALDatasetH pahSrcDS,
const GDALVectorTranslateOptions *  psOptionsIn,
int *  pbUsageError 
)

Converts vector data between file formats.

This is the equivalent of the ogr2ogr utility.

GDALVectorTranslateOptions* must be allocated and freed with GDALVectorTranslateOptionsNew() and GDALVectorTranslateOptionsFree() respectively. pszDest and hDstDS cannot be used at the same time.

Parameters
pszDestthe destination dataset path or NULL.
hDstDSthe destination dataset or NULL.
nSrcCountthe number of input datasets (only 1 supported currently)
pahSrcDSthe list of input datasets.
psOptionsInthe options struct returned by GDALVectorTranslateOptionsNew() or NULL.
pbUsageErrorpointer to a integer output variable to store if any usage error has occurred, or NULL.
Returns
the output dataset (new dataset that must be closed using GDALClose(), or hDstDS is not NULL) or NULL in case of error.
Since
GDAL 2.1

◆ GDALVectorTranslateOptionsFree()

void GDALVectorTranslateOptionsFree ( GDALVectorTranslateOptions *  psOptions)

Frees the GDALVectorTranslateOptions struct.

Parameters
psOptionsthe options struct for GDALVectorTranslate().
Since
GDAL 2.1

◆ GDALVectorTranslateOptionsNew()

GDALVectorTranslateOptions * GDALVectorTranslateOptionsNew ( char **  papszArgv,
GDALVectorTranslateOptionsForBinary psOptionsForBinary 
)

allocates a GDALVectorTranslateOptions struct.

Parameters
papszArgvNULL terminated list of options (potentially including filename and open options too), or NULL. The accepted options are the ones of the ogr2ogr utility.
psOptionsForBinary(output) may be NULL (and should generally be NULL), otherwise (gdal_translate_bin.cpp use case) must be allocated with GDALVectorTranslateOptionsForBinaryNew() prior to this function. Will be filled with potentially present filename, open options,...
Returns
pointer to the allocated GDALVectorTranslateOptions struct. Must be freed with GDALVectorTranslateOptionsFree().
Since
GDAL 2.1

◆ GDALVectorTranslateOptionsSetProgress()

void GDALVectorTranslateOptionsSetProgress ( GDALVectorTranslateOptions *  psOptions,
GDALProgressFunc  pfnProgress,
void *  pProgressData 
)

Set a progress function.

Parameters
psOptionsthe options struct for GDALVectorTranslate().
pfnProgressthe progress callback.
pProgressDatathe user data for the progress callback.
Since
GDAL 2.1

◆ GDALWarp()

GDALDatasetH GDALWarp ( const char *  pszDest,
GDALDatasetH  hDstDS,
int  nSrcCount,
GDALDatasetH pahSrcDS,
const GDALWarpAppOptions *  psOptionsIn,
int *  pbUsageError 
)

Image reprojection and warping function.

This is the equivalent of the gdalwarp utility.

GDALWarpAppOptions* must be allocated and freed with GDALWarpAppOptionsNew() and GDALWarpAppOptionsFree() respectively. pszDest and hDstDS cannot be used at the same time.

Parameters
pszDestthe destination dataset path or NULL.
hDstDSthe destination dataset or NULL.
nSrcCountthe number of input datasets.
pahSrcDSthe list of input datasets. For practical purposes, the type of this argument should be considered as "const GDALDatasetH* const*", that is neither the array nor its values are mutated by this function.
psOptionsInthe options struct returned by GDALWarpAppOptionsNew() or NULL.
pbUsageErrorpointer to a integer output variable to store if any usage error has occurred, or NULL.
Returns
the output dataset (new dataset that must be closed using GDALClose(), or hDstDS if not NULL) or NULL in case of error. If the output format is a VRT dataset, then the returned VRT dataset has a reference to pahSrcDS[0]. Hence pahSrcDS[0] should be closed after the returned dataset if using GDALClose(). A safer alternative is to use GDALReleaseDataset() instead of using GDALClose(), in which case you can close datasets in any order.
Since
GDAL 2.1

◆ GDALWarpAppOptionsFree()

void GDALWarpAppOptionsFree ( GDALWarpAppOptions *  psOptions)

Frees the GDALWarpAppOptions struct.

Parameters
psOptionsthe options struct for GDALWarp().
Since
GDAL 2.1

◆ GDALWarpAppOptionsNew()

GDALWarpAppOptions * GDALWarpAppOptionsNew ( char **  papszArgv,
GDALWarpAppOptionsForBinary psOptionsForBinary 
)

Allocates a GDALWarpAppOptions struct.

Parameters
papszArgvNULL terminated list of options (potentially including filename and open options too), or NULL. The accepted options are the ones of the gdalwarp utility.
psOptionsForBinary(output) may be NULL (and should generally be NULL), otherwise (gdal_translate_bin.cpp use case) must be allocated with GDALWarpAppOptionsForBinaryNew() prior to this function. Will be filled with potentially present filename, open options,...
Returns
pointer to the allocated GDALWarpAppOptions struct. Must be freed with GDALWarpAppOptionsFree().
Since
GDAL 2.1

◆ GDALWarpAppOptionsSetProgress()

void GDALWarpAppOptionsSetProgress ( GDALWarpAppOptions *  psOptions,
GDALProgressFunc  pfnProgress,
void *  pProgressData 
)

Set a progress function.

Parameters
psOptionsthe options struct for GDALWarp().
pfnProgressthe progress callback.
pProgressDatathe user data for the progress callback.
Since
GDAL 2.1

◆ GDALWarpAppOptionsSetQuiet()

void GDALWarpAppOptionsSetQuiet ( GDALWarpAppOptions *  psOptions,
int  bQuiet 
)

Set a progress function.

Parameters
psOptionsthe options struct for GDALWarp().
bQuietwhether GDALWarp() should emit messages on stdout.
Since
GDAL 2.3

◆ GDALWarpAppOptionsSetWarpOption()

void GDALWarpAppOptionsSetWarpOption ( GDALWarpAppOptions *  psOptions,
const char *  pszKey,
const char *  pszValue 
)

Set a warp option.

Parameters
psOptionsthe options struct for GDALWarp().
pszKeykey.
pszValuevalue.
Since
GDAL 2.1