GDAL
|
Public (C callable) GDAL Utilities entry points. More...
Go to the source code of this file.
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... | |
GDALNearblackOptions * | GDALNearblackOptionsNew (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... | |
Public (C callable) GDAL Utilities entry points.
typedef struct GDALBuildVRTOptions GDALBuildVRTOptions |
Options for GDALBuildVRT(). Opaque type
typedef struct GDALDEMProcessingOptions GDALDEMProcessingOptions |
Options for GDALDEMProcessing(). Opaque type
typedef struct GDALFootprintOptions GDALFootprintOptions |
Options for GDALFootprint(). Opaque type
typedef struct GDALGridOptions GDALGridOptions |
Options for GDALGrid(). Opaque type
typedef struct GDALInfoOptions GDALInfoOptions |
Options for GDALInfo(). Opaque type
typedef struct GDALMultiDimInfoOptions GDALMultiDimInfoOptions |
Options for GDALMultiDimInfo(). Opaque type
typedef struct GDALMultiDimTranslateOptions GDALMultiDimTranslateOptions |
Options for GDALMultiDimTranslate(). Opaque type
typedef struct GDALNearblackOptions GDALNearblackOptions |
Options for GDALNearblack(). Opaque type
typedef struct GDALRasterizeOptions GDALRasterizeOptions |
Options for GDALRasterize(). Opaque type
typedef struct GDALTileIndexOptions GDALTileIndexOptions |
Options for GDALTileIndex(). Opaque type
typedef struct GDALTranslateOptions GDALTranslateOptions |
Options for GDALTranslate(). Opaque type
typedef struct GDALVectorInfoOptions GDALVectorInfoOptions |
Options for GDALVectorInfo(). Opaque type
typedef struct GDALVectorTranslateOptions GDALVectorTranslateOptions |
Options for GDALVectorTranslate(). Opaque type
typedef struct GDALWarpAppOptions GDALWarpAppOptions |
Options for GDALWarp(). Opaque type
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.
pszDest | the destination dataset path. |
nSrcCount | the number of input datasets. |
pahSrcDS | the 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. |
papszSrcDSNames | the list of input dataset names (or NULL, exclusive with pahSrcDS) |
psOptionsIn | the options struct returned by GDALBuildVRTOptionsNew() or NULL. |
pbUsageError | pointer to a integer output variable to store if any usage error has occurred. |
void GDALBuildVRTOptionsFree | ( | GDALBuildVRTOptions * | psOptions | ) |
Frees the GDALBuildVRTOptions struct.
psOptions | the options struct for GDALBuildVRT(). |
GDALBuildVRTOptions* GDALBuildVRTOptionsNew | ( | char ** | papszArgv, |
GDALBuildVRTOptionsForBinary * | psOptionsForBinary | ||
) |
Allocates a GDALBuildVRTOptions struct.
papszArgv | NULL 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,... |
void GDALBuildVRTOptionsSetProgress | ( | GDALBuildVRTOptions * | psOptions, |
GDALProgressFunc | pfnProgress, | ||
void * | pProgressData | ||
) |
Set a progress function.
psOptions | the options struct for GDALBuildVRT(). |
pfnProgress | the progress callback. |
pProgressData | the user data for the progress callback. |
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.
pszDest | the destination dataset path. |
hSrcDataset | the source dataset handle. |
pszProcessing | the processing to apply (one of "hillshade", "slope", "aspect", "color-relief", "TRI", "TPI", "Roughness") |
pszColorFilename | color file (mandatory for "color-relief" processing, should be NULL otherwise) |
psOptionsIn | the options struct returned by GDALDEMProcessingOptionsNew() or NULL. |
pbUsageError | pointer to a integer output variable to store if any usage error has occurred or NULL. |
void GDALDEMProcessingOptionsFree | ( | GDALDEMProcessingOptions * | psOptions | ) |
Frees the GDALDEMProcessingOptions struct.
psOptions | the options struct for GDALDEMProcessing(). |
GDALDEMProcessingOptions* GDALDEMProcessingOptionsNew | ( | char ** | papszArgv, |
GDALDEMProcessingOptionsForBinary * | psOptionsForBinary | ||
) |
Allocates a GDALDEMProcessingOptions struct.
papszArgv | NULL 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,... |
void GDALDEMProcessingOptionsSetProgress | ( | GDALDEMProcessingOptions * | psOptions, |
GDALProgressFunc | pfnProgress, | ||
void * | pProgressData | ||
) |
Set a progress function.
psOptions | the options struct for GDALDEMProcessing(). |
pfnProgress | the progress callback. |
pProgressData | the user data for the progress callback. |
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.
pszDest | the vector destination dataset path or NULL. |
hDstDS | the vector destination dataset or NULL. |
hSrcDataset | the raster source dataset handle. |
psOptionsIn | the options struct returned by GDALFootprintOptionsNew() or NULL. |
pbUsageError | pointer to a integer output variable to store if any usage error has occurred or NULL. |
void GDALFootprintOptionsFree | ( | GDALFootprintOptions * | psOptions | ) |
Frees the GDALFootprintOptions struct.
psOptions | the options struct for GDALFootprint(). |
GDALFootprintOptions* GDALFootprintOptionsNew | ( | char ** | papszArgv, |
GDALFootprintOptionsForBinary * | psOptionsForBinary | ||
) |
Allocates a GDALFootprintOptions struct.
papszArgv | NULL 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,... |
void GDALFootprintOptionsSetProgress | ( | GDALFootprintOptions * | psOptions, |
GDALProgressFunc | pfnProgress, | ||
void * | pProgressData | ||
) |
Set a progress function.
psOptions | the options struct for GDALFootprint(). |
pfnProgress | the progress callback. |
pProgressData | the user data for the progress callback. |
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.
pszDest | the destination dataset path. |
hSrcDataset | the source dataset handle. |
psOptionsIn | the options struct returned by GDALGridOptionsNew() or NULL. |
pbUsageError | pointer to a integer output variable to store if any usage error has occurred or NULL. |
void GDALGridOptionsFree | ( | GDALGridOptions * | psOptions | ) |
Frees the GDALGridOptions struct.
psOptions | the options struct for GDALGrid(). |
GDALGridOptions* GDALGridOptionsNew | ( | char ** | papszArgv, |
GDALGridOptionsForBinary * | psOptionsForBinary | ||
) |
Allocates a GDALGridOptions struct.
papszArgv | NULL 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,... |
void GDALGridOptionsSetProgress | ( | GDALGridOptions * | psOptions, |
GDALProgressFunc | pfnProgress, | ||
void * | pProgressData | ||
) |
Set a progress function.
psOptions | the options struct for GDALGrid(). |
pfnProgress | the progress callback. |
pProgressData | the user data for the progress callback. |
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.
hDataset | the dataset handle. |
psOptions | the options structure returned by GDALInfoOptionsNew() or NULL. |
void GDALInfoOptionsFree | ( | GDALInfoOptions * | psOptions | ) |
Frees the GDALInfoOptions struct.
psOptions | the options struct for GDALInfo(). |
GDALInfoOptions* GDALInfoOptionsNew | ( | char ** | papszArgv, |
GDALInfoOptionsForBinary * | psOptionsForBinary | ||
) |
Allocates a GDALInfoOptions struct.
papszArgv | NULL 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... |
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.
hDataset | the dataset handle. |
psOptionsIn | the options structure returned by GDALMultiDimInfoOptionsNew() or NULL. |
void GDALMultiDimInfoOptionsFree | ( | GDALMultiDimInfoOptions * | psOptions | ) |
Frees the GDALMultiDimInfoOptions struct.
psOptions | the options struct for GDALMultiDimInfo(). |
GDALMultiDimInfoOptions* GDALMultiDimInfoOptionsNew | ( | char ** | papszArgv, |
GDALMultiDimInfoOptionsForBinary * | psOptionsForBinary | ||
) |
Allocates a GDALMultiDimInfo struct.
papszArgv | NULL terminated list of options (potentially including filename and open options too), or NULL. The accepted options are the ones of the gdalmdiminfo utility. |
psOptionsForBinary | should be nullptr, unless called from gdalmultidiminfo_bin.cpp |
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.
pszDest | the destination dataset path or NULL. |
hDstDS | the destination dataset or NULL. |
nSrcCount | the number of input datasets. |
pahSrcDS | the list of input datasets. |
psOptions | the options struct returned by GDALMultiDimTranslateOptionsNew() or NULL. |
pbUsageError | pointer to a integer output variable to store if any usage error has occurred or NULL. |
void GDALMultiDimTranslateOptionsFree | ( | GDALMultiDimTranslateOptions * | psOptions | ) |
Frees the GDALMultiDimTranslateOptions struct.
psOptions | the options struct for GDALMultiDimTranslate(). |
GDALMultiDimTranslateOptions* GDALMultiDimTranslateOptionsNew | ( | char ** | papszArgv, |
GDALMultiDimTranslateOptionsForBinary * | psOptionsForBinary | ||
) |
Allocates a GDALMultiDimTranslateOptions struct.
papszArgv | NULL terminated list of options (potentially including filename and open options too), or NULL. The accepted options are the ones of the gdalmdimtranslate utility. |
psOptionsForBinary | should be nullptr, unless called from gdalmdimtranslate_bin.cpp |
void GDALMultiDimTranslateOptionsSetProgress | ( | GDALMultiDimTranslateOptions * | psOptions, |
GDALProgressFunc | pfnProgress, | ||
void * | pProgressData | ||
) |
Set a progress function.
psOptions | the options struct for GDALMultiDimTranslate(). |
pfnProgress | the progress callback. |
pProgressData | the user data for the progress callback. |
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.
pszDest | the destination dataset path or NULL. |
hDstDS | the destination dataset or NULL. Might be equal to hSrcDataset. |
hSrcDataset | the source dataset handle. |
psOptionsIn | the options struct returned by GDALNearblackOptionsNew() or NULL. |
pbUsageError | pointer to a integer output variable to store if any usage error has occurred or NULL. |
void GDALNearblackOptionsFree | ( | GDALNearblackOptions * | psOptions | ) |
Frees the GDALNearblackOptions struct.
psOptions | the options struct for GDALNearblack(). |
GDALNearblackOptions* GDALNearblackOptionsNew | ( | char ** | papszArgv, |
GDALNearblackOptionsForBinary * | psOptionsForBinary | ||
) |
Allocates a GDALNearblackOptions struct.
papszArgv | NULL 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,... |
void GDALNearblackOptionsSetProgress | ( | GDALNearblackOptions * | psOptions, |
GDALProgressFunc | pfnProgress, | ||
void * | pProgressData | ||
) |
Set a progress function.
psOptions | the options struct for GDALNearblack(). |
pfnProgress | the progress callback. |
pProgressData | the user data for the progress callback. |
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.
pszDest | the destination dataset path or NULL. |
hDstDS | the destination dataset or NULL. |
hSrcDataset | the source dataset handle. |
psOptionsIn | the options struct returned by GDALRasterizeOptionsNew() or NULL. |
pbUsageError | pointer to a integer output variable to store if any usage error has occurred or NULL. |
void GDALRasterizeOptionsFree | ( | GDALRasterizeOptions * | psOptions | ) |
Frees the GDALRasterizeOptions struct.
psOptions | the options struct for GDALRasterize(). |
GDALRasterizeOptions* GDALRasterizeOptionsNew | ( | char ** | papszArgv, |
GDALRasterizeOptionsForBinary * | psOptionsForBinary | ||
) |
Allocates a GDALRasterizeOptions struct.
papszArgv | NULL 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,... |
void GDALRasterizeOptionsSetProgress | ( | GDALRasterizeOptions * | psOptions, |
GDALProgressFunc | pfnProgress, | ||
void * | pProgressData | ||
) |
Set a progress function.
psOptions | the options struct for GDALRasterize(). |
pfnProgress | the progress callback. |
pProgressData | the user data for the progress callback. |
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.
pszDest | the destination dataset path. |
nSrcCount | the number of input datasets. |
papszSrcDSNames | the list of input dataset names |
psOptionsIn | the options struct returned by GDALTileIndexOptionsNew() or NULL. |
pbUsageError | pointer to a integer output variable to store if any usage error has occurred. |
void GDALTileIndexOptionsFree | ( | GDALTileIndexOptions * | psOptions | ) |
Frees the GDALTileIndexOptions struct.
psOptions | the options struct for GDALTileIndex(). |
GDALTileIndexOptions* GDALTileIndexOptionsNew | ( | char ** | papszArgv, |
GDALTileIndexOptionsForBinary * | psOptionsForBinary | ||
) |
Allocates a GDALTileIndexOptions struct.
papszArgv | NULL 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,... |
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.
pszDest | the destination dataset path. |
hSrcDataset | the source dataset handle. |
psOptionsIn | the options struct returned by GDALTranslateOptionsNew() or NULL. |
pbUsageError | pointer to a integer output variable to store if any usage error has occurred or NULL. |
void GDALTranslateOptionsFree | ( | GDALTranslateOptions * | psOptions | ) |
Frees the GDALTranslateOptions struct.
psOptions | the options struct for GDALTranslate(). |
GDALTranslateOptions* GDALTranslateOptionsNew | ( | char ** | papszArgv, |
GDALTranslateOptionsForBinary * | psOptionsForBinary | ||
) |
Allocates a GDALTranslateOptions struct.
papszArgv | NULL 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,... |
void GDALTranslateOptionsSetProgress | ( | GDALTranslateOptions * | psOptions, |
GDALProgressFunc | pfnProgress, | ||
void * | pProgressData | ||
) |
Set a progress function.
psOptions | the options struct for GDALTranslate(). |
pfnProgress | the progress callback. |
pProgressData | the user data for the progress callback. |
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.
hDataset | the dataset handle. |
psOptions | the options structure returned by GDALVectorInfoOptionsNew() or NULL. |
void GDALVectorInfoOptionsFree | ( | GDALVectorInfoOptions * | psOptions | ) |
Frees the GDALVectorInfoOptions struct.
psOptions | the options struct for GDALVectorInfo(). |
GDALVectorInfoOptions* GDALVectorInfoOptionsNew | ( | char ** | papszArgv, |
GDALVectorInfoOptionsForBinary * | psOptionsForBinary | ||
) |
Allocates a GDALVectorInfoOptions struct.
Note that when this function is used a library function, and not from the ogrinfo utility, a dataset name must be specified if any layer names(s) are specified (if no layer name is specific, passing a dataset name is not needed). That dataset name may be a dummy one, as the dataset taken into account is the hDS parameter passed to GDALVectorInfo(). Similarly the -oo switch in a non-ogrinfo context will be ignored, and it is the responsibility of the user to apply them when opening the hDS parameter passed to GDALVectorInfo().
papszArgv | NULL 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... |
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.
pszDest | the destination dataset path or NULL. |
hDstDS | the destination dataset or NULL. |
nSrcCount | the number of input datasets (only 1 supported currently) |
pahSrcDS | the list of input datasets. |
psOptionsIn | the options struct returned by GDALVectorTranslateOptionsNew() or NULL. |
pbUsageError | pointer to a integer output variable to store if any usage error has occurred, or NULL. |
void GDALVectorTranslateOptionsFree | ( | GDALVectorTranslateOptions * | psOptions | ) |
Frees the GDALVectorTranslateOptions struct.
psOptions | the options struct for GDALVectorTranslate(). |
GDALVectorTranslateOptions* GDALVectorTranslateOptionsNew | ( | char ** | papszArgv, |
GDALVectorTranslateOptionsForBinary * | psOptionsForBinary | ||
) |
allocates a GDALVectorTranslateOptions struct.
papszArgv | NULL 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,... |
void GDALVectorTranslateOptionsSetProgress | ( | GDALVectorTranslateOptions * | psOptions, |
GDALProgressFunc | pfnProgress, | ||
void * | pProgressData | ||
) |
Set a progress function.
psOptions | the options struct for GDALVectorTranslate(). |
pfnProgress | the progress callback. |
pProgressData | the user data for the progress callback. |
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.
pszDest | the destination dataset path or NULL. |
hDstDS | the destination dataset or NULL. |
nSrcCount | the number of input datasets. |
pahSrcDS | the 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. |
psOptionsIn | the options struct returned by GDALWarpAppOptionsNew() or NULL. |
pbUsageError | pointer to a integer output variable to store if any usage error has occurred, or NULL. |
void GDALWarpAppOptionsFree | ( | GDALWarpAppOptions * | psOptions | ) |
Frees the GDALWarpAppOptions struct.
psOptions | the options struct for GDALWarp(). |
GDALWarpAppOptions* GDALWarpAppOptionsNew | ( | char ** | papszArgv, |
GDALWarpAppOptionsForBinary * | psOptionsForBinary | ||
) |
Allocates a GDALWarpAppOptions struct.
papszArgv | NULL 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,... |
void GDALWarpAppOptionsSetProgress | ( | GDALWarpAppOptions * | psOptions, |
GDALProgressFunc | pfnProgress, | ||
void * | pProgressData | ||
) |
Set a progress function.
psOptions | the options struct for GDALWarp(). |
pfnProgress | the progress callback. |
pProgressData | the user data for the progress callback. |
void GDALWarpAppOptionsSetQuiet | ( | GDALWarpAppOptions * | psOptions, |
int | bQuiet | ||
) |
Set a progress function.
psOptions | the options struct for GDALWarp(). |
bQuiet | whether GDALWarp() should emit messages on stdout. |
void GDALWarpAppOptionsSetWarpOption | ( | GDALWarpAppOptions * | psOptions, |
const char * | pszKey, | ||
const char * | pszValue | ||
) |
Set a warp option.
psOptions | the options struct for GDALWarp(). |
pszKey | key. |
pszValue | value. |