| 1 |
""" |
| 2 |
This module houses the ctypes function prototypes for GDAL DataSource (raster) |
| 3 |
related data structures. |
| 4 |
""" |
| 5 |
|
| 6 |
from ctypes import POINTER, c_bool, c_char_p, c_double, c_int, c_void_p |
| 7 |
from functools import partial |
| 8 |
|
| 9 |
from django.contrib.gis.gdal.libgdal import std_call |
| 10 |
from django.contrib.gis.gdal.prototypes.generation import ( |
| 11 |
chararray_output, |
| 12 |
const_string_output, |
| 13 |
double_output, |
| 14 |
int_output, |
| 15 |
void_output, |
| 16 |
voidptr_output, |
| 17 |
) |
| 18 |
|
| 19 |
# For more detail about c function names and definitions see |
| 20 |
# https://gdal.org/api/raster_c_api.html |
| 21 |
# https://gdal.org/doxygen/gdalwarper_8h.html |
| 22 |
# https://gdal.org/api/gdal_utils.html |
| 23 |
|
| 24 |
# Prepare partial functions that use cpl error codes |
| 25 |
void_output = partial(void_output, cpl=True) |
| 26 |
const_string_output = partial(const_string_output, cpl=True) |
| 27 |
double_output = partial(double_output, cpl=True) |
| 28 |
|
| 29 |
# Raster Data Source Routines |
| 30 |
create_ds = voidptr_output( |
| 31 |
std_call("GDALCreate"), [c_void_p, c_char_p, c_int, c_int, c_int, c_int, c_void_p] |
| 32 |
) |
| 33 |
open_ds = voidptr_output(std_call("GDALOpen"), [c_char_p, c_int]) |
| 34 |
close_ds = void_output(std_call("GDALClose"), [c_void_p], errcheck=False) |
| 35 |
flush_ds = int_output(std_call("GDALFlushCache"), [c_void_p]) |
| 36 |
copy_ds = voidptr_output( |
| 37 |
std_call("GDALCreateCopy"), |
| 38 |
[c_void_p, c_char_p, c_void_p, c_int, POINTER(c_char_p), c_void_p, c_void_p], |
| 39 |
) |
| 40 |
add_band_ds = void_output(std_call("GDALAddBand"), [c_void_p, c_int]) |
| 41 |
get_ds_description = const_string_output(std_call("GDALGetDescription"), [c_void_p]) |
| 42 |
get_ds_driver = voidptr_output(std_call("GDALGetDatasetDriver"), [c_void_p]) |
| 43 |
get_ds_info = const_string_output(std_call("GDALInfo"), [c_void_p, c_void_p]) |
| 44 |
get_ds_xsize = int_output(std_call("GDALGetRasterXSize"), [c_void_p]) |
| 45 |
get_ds_ysize = int_output(std_call("GDALGetRasterYSize"), [c_void_p]) |
| 46 |
get_ds_raster_count = int_output(std_call("GDALGetRasterCount"), [c_void_p]) |
| 47 |
get_ds_raster_band = voidptr_output(std_call("GDALGetRasterBand"), [c_void_p, c_int]) |
| 48 |
get_ds_projection_ref = const_string_output( |
| 49 |
std_call("GDALGetProjectionRef"), [c_void_p] |
| 50 |
) |
| 51 |
set_ds_projection_ref = void_output(std_call("GDALSetProjection"), [c_void_p, c_char_p]) |
| 52 |
get_ds_geotransform = void_output( |
| 53 |
std_call("GDALGetGeoTransform"), [c_void_p, POINTER(c_double * 6)], errcheck=False |
| 54 |
) |
| 55 |
set_ds_geotransform = void_output( |
| 56 |
std_call("GDALSetGeoTransform"), [c_void_p, POINTER(c_double * 6)] |
| 57 |
) |
| 58 |
|
| 59 |
get_ds_metadata = chararray_output( |
| 60 |
std_call("GDALGetMetadata"), [c_void_p, c_char_p], errcheck=False |
| 61 |
) |
| 62 |
set_ds_metadata = void_output( |
| 63 |
std_call("GDALSetMetadata"), [c_void_p, POINTER(c_char_p), c_char_p] |
| 64 |
) |
| 65 |
get_ds_metadata_domain_list = chararray_output( |
| 66 |
std_call("GDALGetMetadataDomainList"), [c_void_p], errcheck=False |
| 67 |
) |
| 68 |
get_ds_metadata_item = const_string_output( |
| 69 |
std_call("GDALGetMetadataItem"), [c_void_p, c_char_p, c_char_p] |
| 70 |
) |
| 71 |
set_ds_metadata_item = const_string_output( |
| 72 |
std_call("GDALSetMetadataItem"), [c_void_p, c_char_p, c_char_p, c_char_p] |
| 73 |
) |
| 74 |
free_dsl = void_output(std_call("CSLDestroy"), [POINTER(c_char_p)], errcheck=False) |
| 75 |
|
| 76 |
# Raster Band Routines |
| 77 |
band_io = void_output( |
| 78 |
std_call("GDALRasterIO"), |
| 79 |
[ |
| 80 |
c_void_p, |
| 81 |
c_int, |
| 82 |
c_int, |
| 83 |
c_int, |
| 84 |
c_int, |
| 85 |
c_int, |
| 86 |
c_void_p, |
| 87 |
c_int, |
| 88 |
c_int, |
| 89 |
c_int, |
| 90 |
c_int, |
| 91 |
c_int, |
| 92 |
], |
| 93 |
) |
| 94 |
get_band_xsize = int_output(std_call("GDALGetRasterBandXSize"), [c_void_p]) |
| 95 |
get_band_ysize = int_output(std_call("GDALGetRasterBandYSize"), [c_void_p]) |
| 96 |
get_band_index = int_output(std_call("GDALGetBandNumber"), [c_void_p]) |
| 97 |
get_band_description = const_string_output(std_call("GDALGetDescription"), [c_void_p]) |
| 98 |
get_band_ds = voidptr_output(std_call("GDALGetBandDataset"), [c_void_p]) |
| 99 |
get_band_datatype = int_output(std_call("GDALGetRasterDataType"), [c_void_p]) |
| 100 |
get_band_color_interp = int_output( |
| 101 |
std_call("GDALGetRasterColorInterpretation"), [c_void_p] |
| 102 |
) |
| 103 |
get_band_nodata_value = double_output( |
| 104 |
std_call("GDALGetRasterNoDataValue"), [c_void_p, POINTER(c_int)] |
| 105 |
) |
| 106 |
set_band_nodata_value = void_output( |
| 107 |
std_call("GDALSetRasterNoDataValue"), [c_void_p, c_double] |
| 108 |
) |
| 109 |
delete_band_nodata_value = void_output( |
| 110 |
std_call("GDALDeleteRasterNoDataValue"), [c_void_p] |
| 111 |
) |
| 112 |
get_band_statistics = void_output( |
| 113 |
std_call("GDALGetRasterStatistics"), |
| 114 |
[ |
| 115 |
c_void_p, |
| 116 |
c_int, |
| 117 |
c_int, |
| 118 |
POINTER(c_double), |
| 119 |
POINTER(c_double), |
| 120 |
POINTER(c_double), |
| 121 |
POINTER(c_double), |
| 122 |
c_void_p, |
| 123 |
c_void_p, |
| 124 |
], |
| 125 |
) |
| 126 |
compute_band_statistics = void_output( |
| 127 |
std_call("GDALComputeRasterStatistics"), |
| 128 |
[ |
| 129 |
c_void_p, |
| 130 |
c_int, |
| 131 |
POINTER(c_double), |
| 132 |
POINTER(c_double), |
| 133 |
POINTER(c_double), |
| 134 |
POINTER(c_double), |
| 135 |
c_void_p, |
| 136 |
c_void_p, |
| 137 |
], |
| 138 |
) |
| 139 |
|
| 140 |
# Reprojection routine |
| 141 |
reproject_image = void_output( |
| 142 |
std_call("GDALReprojectImage"), |
| 143 |
[ |
| 144 |
c_void_p, |
| 145 |
c_char_p, |
| 146 |
c_void_p, |
| 147 |
c_char_p, |
| 148 |
c_int, |
| 149 |
c_double, |
| 150 |
c_double, |
| 151 |
c_void_p, |
| 152 |
c_void_p, |
| 153 |
c_void_p, |
| 154 |
], |
| 155 |
) |
| 156 |
auto_create_warped_vrt = voidptr_output( |
| 157 |
std_call("GDALAutoCreateWarpedVRT"), |
| 158 |
[c_void_p, c_char_p, c_char_p, c_int, c_double, c_void_p], |
| 159 |
) |
| 160 |
|
| 161 |
# Create VSI gdal raster files from in-memory buffers. |
| 162 |
# https://gdal.org/api/cpl.html#cpl-vsi-h |
| 163 |
create_vsi_file_from_mem_buffer = voidptr_output( |
| 164 |
std_call("VSIFileFromMemBuffer"), [c_char_p, c_void_p, c_int, c_int] |
| 165 |
) |
| 166 |
get_mem_buffer_from_vsi_file = voidptr_output( |
| 167 |
std_call("VSIGetMemFileBuffer"), [c_char_p, POINTER(c_int), c_bool] |
| 168 |
) |
| 169 |
unlink_vsi_file = int_output(std_call("VSIUnlink"), [c_char_p]) |