GDAL
gdal.h
Go to the documentation of this file.
1/******************************************************************************
2 * $Id$
3 *
4 * Project: GDAL Core
5 * Purpose: GDAL Core C/Public declarations.
6 * Author: Frank Warmerdam, warmerdam@pobox.com
7 *
8 ******************************************************************************
9 * Copyright (c) 1998, 2002 Frank Warmerdam
10 * Copyright (c) 2007-2014, Even Rouault <even dot rouault at spatialys.com>
11 *
12 * Permission is hereby granted, free of charge, to any person obtaining a
13 * copy of this software and associated documentation files (the "Software"),
14 * to deal in the Software without restriction, including without limitation
15 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
16 * and/or sell copies of the Software, and to permit persons to whom the
17 * Software is furnished to do so, subject to the following conditions:
18 *
19 * The above copyright notice and this permission notice shall be included
20 * in all copies or substantial portions of the Software.
21 *
22 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
23 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
25 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
27 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
28 * DEALINGS IN THE SOFTWARE.
29 ****************************************************************************/
30
31#ifndef GDAL_H_INCLUDED
32#define GDAL_H_INCLUDED
33
40#ifndef DOXYGEN_SKIP
41#if defined(GDAL_COMPILATION)
42#define DO_NOT_DEFINE_GDAL_DATE_NAME
43#endif
44#include "gdal_version.h"
45#include "cpl_port.h"
46#include "cpl_error.h"
47#include "cpl_progress.h"
48#include "cpl_virtualmem.h"
49#include "cpl_minixml.h"
50#include "ogr_api.h"
51#endif
52
53#include <stdbool.h>
54#include <stdint.h>
55
56/* -------------------------------------------------------------------- */
57/* Significant constants. */
58/* -------------------------------------------------------------------- */
59
61
63typedef enum
64{ GDT_Unknown = 0, GDT_Byte = 1, GDT_Int8 = 14, GDT_UInt16 = 2, GDT_Int16 = 3, GDT_UInt32 = 4, GDT_Int32 = 5, GDT_UInt64 = 12, GDT_Int64 = 13, GDT_Float32 = 6, GDT_Float64 = 7, GDT_CInt16 = 8, GDT_CInt32 = 9,
78 /* TODO?(#6879): GDT_CInt64 */ GDT_CFloat32 = 10, GDT_CFloat64 = 11,
81 GDT_TypeCount = 15 /* maximum type # + 1 */
83
84int CPL_DLL CPL_STDCALL GDALGetDataTypeSize(GDALDataType); // Deprecated.
85int CPL_DLL CPL_STDCALL GDALGetDataTypeSizeBits(GDALDataType eDataType);
86int CPL_DLL CPL_STDCALL GDALGetDataTypeSizeBytes(GDALDataType);
87int CPL_DLL CPL_STDCALL GDALDataTypeIsComplex(GDALDataType);
88int CPL_DLL CPL_STDCALL GDALDataTypeIsInteger(GDALDataType);
89int CPL_DLL CPL_STDCALL GDALDataTypeIsFloating(GDALDataType);
90int CPL_DLL CPL_STDCALL GDALDataTypeIsSigned(GDALDataType);
91const char CPL_DLL *CPL_STDCALL GDALGetDataTypeName(GDALDataType);
92GDALDataType CPL_DLL CPL_STDCALL GDALGetDataTypeByName(const char *);
95 double dValue,
96 int bComplex);
97GDALDataType CPL_DLL CPL_STDCALL GDALFindDataType(int nBits, int bSigned,
98 int bFloating, int bComplex);
99GDALDataType CPL_DLL CPL_STDCALL GDALFindDataTypeForValue(double dValue,
100 int bComplex);
101double CPL_DLL GDALAdjustValueToDataType(GDALDataType eDT, double dfValue,
102 int *pbClamped, int *pbRounded);
104int CPL_DLL CPL_STDCALL GDALDataTypeIsConversionLossy(GDALDataType eTypeFrom,
105 GDALDataType eTypeTo);
106
110typedef enum
111{
112 GARIO_PENDING = 0,
113 GARIO_UPDATE = 1,
114 GARIO_ERROR = 2,
115 GARIO_COMPLETE = 3,
116 GARIO_TypeCount = 4
118
119const char CPL_DLL *CPL_STDCALL GDALGetAsyncStatusTypeName(GDALAsyncStatusType);
120GDALAsyncStatusType CPL_DLL CPL_STDCALL
121GDALGetAsyncStatusTypeByName(const char *);
122
124typedef enum
125{ GA_ReadOnly = 0, GA_Update = 1
129
131typedef enum
132{ GF_Read = 0, GF_Write = 1
136
137/* NOTE: values are selected to be consistent with GDALResampleAlg of
138 * alg/gdalwarper.h */
142typedef enum
154 /* NOTE: values 8 to 13 are reserved for max,min,med,Q1,Q3,sum */
156 GRIORA_RESERVED_START = 8,
157 GRIORA_RESERVED_END = 13,
165 GRIORA_LAST = GRIORA_RMS
168
169/* NOTE to developers: only add members, and if so edit INIT_RASTERIO_EXTRA_ARG
170 */
175typedef struct
176{
179
182
184 GDALProgressFunc pfnProgress;
187
196 double dfXOff;
199 double dfYOff;
202 double dfXSize;
205 double dfYSize;
207
208#ifndef DOXYGEN_SKIP
209#define RASTERIO_EXTRA_ARG_CURRENT_VERSION 1
210#endif
211
215#define INIT_RASTERIO_EXTRA_ARG(s) \
216 do \
217 { \
218 (s).nVersion = RASTERIO_EXTRA_ARG_CURRENT_VERSION; \
219 (s).eResampleAlg = GRIORA_NearestNeighbour; \
220 (s).pfnProgress = CPL_NULLPTR; \
221 (s).pProgressData = CPL_NULLPTR; \
222 (s).bFloatingPointWindowValidity = FALSE; \
223 } while (0)
224
226typedef enum
247
249GDALColorInterp CPL_DLL GDALGetColorInterpretationByName(const char *pszName);
250
252typedef enum
253{ GPI_Gray = 0, GPI_RGB = 1, GPI_CMYK = 2, GPI_HLS = 3
259
261
262/* "well known" metadata items. */
263
266#define GDALMD_AREA_OR_POINT "AREA_OR_POINT"
269#define GDALMD_AOP_AREA "Area"
272#define GDALMD_AOP_POINT "Point"
273
274/* -------------------------------------------------------------------- */
275/* GDAL Specific error codes. */
276/* */
277/* error codes 100 to 299 reserved for GDAL. */
278/* -------------------------------------------------------------------- */
279#ifndef DOXYGEN_SKIP
280#define CPLE_WrongFormat CPL_STATIC_CAST(CPLErrorNum, 200)
281#endif
282
283/* -------------------------------------------------------------------- */
284/* Define handle types related to various internal classes. */
285/* -------------------------------------------------------------------- */
286
288typedef void *GDALMajorObjectH;
289
291typedef void *GDALDatasetH;
292
294typedef void *GDALRasterBandH;
295
297typedef void *GDALDriverH;
298
300typedef void *GDALColorTableH;
301
305
307typedef void *GDALAsyncReaderH;
308
312typedef void *GDALRelationshipH;
313
316
320typedef enum
321{
329
333typedef enum
334{
340
342typedef struct GDALExtendedDataTypeHS *GDALExtendedDataTypeH;
344typedef struct GDALEDTComponentHS *GDALEDTComponentH;
346typedef struct GDALGroupHS *GDALGroupH;
348typedef struct GDALMDArrayHS *GDALMDArrayH;
350typedef struct GDALAttributeHS *GDALAttributeH;
352typedef struct GDALDimensionHS *GDALDimensionH;
353
354/* ==================================================================== */
355/* Registration/driver related. */
356/* ==================================================================== */
357
359#define GDAL_DMD_LONGNAME "DMD_LONGNAME"
360
362#define GDAL_DMD_HELPTOPIC "DMD_HELPTOPIC"
363
365#define GDAL_DMD_MIMETYPE "DMD_MIMETYPE"
366
368#define GDAL_DMD_EXTENSION "DMD_EXTENSION"
369
374#define GDAL_DMD_CONNECTION_PREFIX "DMD_CONNECTION_PREFIX"
375
379#define GDAL_DMD_EXTENSIONS "DMD_EXTENSIONS"
380
382#define GDAL_DMD_CREATIONOPTIONLIST "DMD_CREATIONOPTIONLIST"
383
387#define GDAL_DMD_MULTIDIM_DATASET_CREATIONOPTIONLIST \
388 "DMD_MULTIDIM_DATASET_CREATIONOPTIONLIST"
389
393#define GDAL_DMD_MULTIDIM_GROUP_CREATIONOPTIONLIST \
394 "DMD_MULTIDIM_GROUP_CREATIONOPTIONLIST"
395
399#define GDAL_DMD_MULTIDIM_DIMENSION_CREATIONOPTIONLIST \
400 "DMD_MULTIDIM_DIMENSION_CREATIONOPTIONLIST"
401
405#define GDAL_DMD_MULTIDIM_ARRAY_CREATIONOPTIONLIST \
406 "DMD_MULTIDIM_ARRAY_CREATIONOPTIONLIST"
407
411#define GDAL_DMD_MULTIDIM_ARRAY_OPENOPTIONLIST \
412 "DMD_MULTIDIM_ARRAY_OPENOPTIONLIST"
413
417#define GDAL_DMD_MULTIDIM_ATTRIBUTE_CREATIONOPTIONLIST \
418 "DMD_MULTIDIM_ATTRIBUTE_CREATIONOPTIONLIST"
419
423#define GDAL_DMD_OPENOPTIONLIST "DMD_OPENOPTIONLIST"
424
427#define GDAL_DMD_CREATIONDATATYPES "DMD_CREATIONDATATYPES"
428
433#define GDAL_DMD_CREATIONFIELDDATATYPES "DMD_CREATIONFIELDDATATYPES"
434
439#define GDAL_DMD_CREATIONFIELDDATASUBTYPES "DMD_CREATIONFIELDDATASUBTYPES"
440
458#define GDAL_DMD_CREATION_FIELD_DEFN_FLAGS "DMD_CREATION_FIELD_DEFN_FLAGS"
459
468#define GDAL_DMD_SUBDATASETS "DMD_SUBDATASETS"
469
478#define GDAL_DMD_NUMERIC_FIELD_WIDTH_INCLUDES_DECIMAL_SEPARATOR \
479 "DMD_NUMERIC_FIELD_WIDTH_INCLUDES_DECIMAL_SEPARATOR"
480
489#define GDAL_DMD_NUMERIC_FIELD_WIDTH_INCLUDES_SIGN \
490 "DMD_NUMERIC_FIELD_WIDTH_INCLUDES_SIGN"
491
493#define GDAL_DCAP_OPEN "DCAP_OPEN"
494
503#define GDAL_DCAP_CREATE "DCAP_CREATE"
504
509#define GDAL_DCAP_CREATE_MULTIDIMENSIONAL "DCAP_CREATE_MULTIDIMENSIONAL"
510
519#define GDAL_DCAP_CREATECOPY "DCAP_CREATECOPY"
520
525#define GDAL_DCAP_VECTOR_TRANSLATE_FROM "DCAP_VECTOR_TRANSLATE_FROM"
526
532#define GDAL_DCAP_CREATECOPY_MULTIDIMENSIONAL "DCAP_CREATECOPY_MULTIDIMENSIONAL"
533
537#define GDAL_DCAP_MULTIDIM_RASTER "DCAP_MULTIDIM_RASTER"
538
540#define GDAL_DCAP_SUBCREATECOPY "DCAP_SUBCREATECOPY"
541
544#define GDAL_DCAP_VIRTUALIO "DCAP_VIRTUALIO"
545
549#define GDAL_DCAP_RASTER "DCAP_RASTER"
550
554#define GDAL_DCAP_VECTOR "DCAP_VECTOR"
555
559#define GDAL_DCAP_GNM "DCAP_GNM"
560
564#define GDAL_DCAP_CREATE_LAYER "DCAP_CREATE_LAYER"
565
569#define GDAL_DCAP_DELETE_LAYER "DCAP_DELETE_LAYER"
570
574#define GDAL_DCAP_CREATE_FIELD "DCAP_CREATE_FIELD"
575
579#define GDAL_DCAP_DELETE_FIELD "DCAP_DELETE_FIELD"
580
584#define GDAL_DCAP_REORDER_FIELDS "DCAP_REORDER_FIELDS"
585
605#define GDAL_DMD_ALTER_FIELD_DEFN_FLAGS "GDAL_DMD_ALTER_FIELD_DEFN_FLAGS"
606
612#define GDAL_DMD_ILLEGAL_FIELD_NAMES "GDAL_DMD_ILLEGAL_FIELD_NAMES"
613
617#define GDAL_DCAP_NOTNULL_FIELDS "DCAP_NOTNULL_FIELDS"
618
622#define GDAL_DCAP_UNIQUE_FIELDS "DCAP_UNIQUE_FIELDS"
623
627#define GDAL_DCAP_DEFAULT_FIELDS "DCAP_DEFAULT_FIELDS"
628
633#define GDAL_DCAP_NOTNULL_GEOMFIELDS "DCAP_NOTNULL_GEOMFIELDS"
634
640#define GDAL_DCAP_NONSPATIAL "DCAP_NONSPATIAL"
641
645#define GDAL_DCAP_CURVE_GEOMETRIES "DCAP_CURVE_GEOMETRIES"
646
651#define GDAL_DCAP_MEASURED_GEOMETRIES "DCAP_MEASURED_GEOMETRIES"
652
657#define GDAL_DCAP_Z_GEOMETRIES "DCAP_Z_GEOMETRIES"
658
671#define GDAL_DMD_GEOMETRY_FLAGS "GDAL_DMD_GEOMETRY_FLAGS"
672
681#define GDAL_DCAP_FEATURE_STYLES "DCAP_FEATURE_STYLES"
682
686#define GDAL_DCAP_FEATURE_STYLES_READ "DCAP_FEATURE_STYLES_READ"
687
691#define GDAL_DCAP_FEATURE_STYLES_WRITE "DCAP_FEATURE_STYLES_WRITE"
692
697#define GDAL_DCAP_COORDINATE_EPOCH "DCAP_COORDINATE_EPOCH"
698
707#define GDAL_DCAP_MULTIPLE_VECTOR_LAYERS "DCAP_MULTIPLE_VECTOR_LAYERS"
708
713#define GDAL_DCAP_FIELD_DOMAINS "DCAP_FIELD_DOMAINS"
714
720#define GDAL_DCAP_RELATIONSHIPS "DCAP_RELATIONSHIPS"
721
726#define GDAL_DCAP_CREATE_RELATIONSHIP "DCAP_CREATE_RELATIONSHIP"
727
732#define GDAL_DCAP_DELETE_RELATIONSHIP "DCAP_DELETE_RELATIONSHIP"
733
738#define GDAL_DCAP_UPDATE_RELATIONSHIP "DCAP_UPDATE_RELATIONSHIP"
739
745#define GDAL_DCAP_FLUSHCACHE_CONSISTENT_STATE "DCAP_FLUSHCACHE_CONSISTENT_STATE"
746
755#define GDAL_DCAP_HONOR_GEOM_COORDINATE_PRECISION \
756 "DCAP_HONOR_GEOM_COORDINATE_PRECISION"
757
784#define GDAL_DMD_RELATIONSHIP_FLAGS "GDAL_DMD_RELATIONSHIP_FLAGS"
785
793#define GDAL_DMD_RELATIONSHIP_RELATED_TABLE_TYPES \
794 "GDAL_DMD_RELATIONSHIP_RELATED_TABLE_TYPES"
795
800#define GDAL_DCAP_RENAME_LAYERS "DCAP_RENAME_LAYERS"
801
811#define GDAL_DMD_CREATION_FIELD_DOMAIN_TYPES "DMD_CREATION_FIELD_DOMAIN_TYPES"
812
828#define GDAL_DMD_ALTER_GEOM_FIELD_DEFN_FLAGS "DMD_ALTER_GEOM_FIELD_DEFN_FLAGS"
829
851#define GDAL_DMD_SUPPORTED_SQL_DIALECTS "DMD_SUPPORTED_SQL_DIALECTS"
852
854#define GDAL_DMD_PLUGIN_INSTALLATION_MESSAGE "DMD_PLUGIN_INSTALLATION_MESSAGE"
861#define GDAL_DIM_TYPE_HORIZONTAL_X "HORIZONTAL_X"
862
867#define GDAL_DIM_TYPE_HORIZONTAL_Y "HORIZONTAL_Y"
868
872#define GDAL_DIM_TYPE_VERTICAL "VERTICAL"
873
877#define GDAL_DIM_TYPE_TEMPORAL "TEMPORAL"
878
882#define GDAL_DIM_TYPE_PARAMETRIC "PARAMETRIC"
883
884#define GDsCAddRelationship \
885 "AddRelationship"
887#define GDsCDeleteRelationship \
888 "DeleteRelationship"
890#define GDsCUpdateRelationship \
891 "UpdateRelationship"
894void CPL_DLL CPL_STDCALL GDALAllRegister(void);
895void CPL_DLL GDALRegisterPlugins(void);
896CPLErr CPL_DLL GDALRegisterPlugin(const char *name);
897
898GDALDatasetH CPL_DLL CPL_STDCALL
899GDALCreate(GDALDriverH hDriver, const char *, int, int, int, GDALDataType,
901GDALDatasetH CPL_DLL CPL_STDCALL GDALCreateCopy(GDALDriverH, const char *,
903 GDALProgressFunc,
905
906GDALDriverH CPL_DLL CPL_STDCALL GDALIdentifyDriver(const char *pszFilename,
907 CSLConstList papszFileList);
908
909GDALDriverH CPL_DLL CPL_STDCALL GDALIdentifyDriverEx(
910 const char *pszFilename, unsigned int nIdentifyFlags,
911 const char *const *papszAllowedDrivers, const char *const *papszFileList);
912
913GDALDatasetH CPL_DLL CPL_STDCALL
914GDALOpen(const char *pszFilename, GDALAccess eAccess) CPL_WARN_UNUSED_RESULT;
915GDALDatasetH CPL_DLL CPL_STDCALL GDALOpenShared(const char *, GDALAccess)
917
918/* Note: we define GDAL_OF_READONLY and GDAL_OF_UPDATE to be on purpose */
919/* equals to GA_ReadOnly and GA_Update */
920
925#define GDAL_OF_READONLY 0x00
926
931#define GDAL_OF_UPDATE 0x01
932
937#define GDAL_OF_ALL 0x00
938
943#define GDAL_OF_RASTER 0x02
944
949#define GDAL_OF_VECTOR 0x04
950
955#define GDAL_OF_GNM 0x08
956
961#define GDAL_OF_MULTIDIM_RASTER 0x10
962
963#ifndef DOXYGEN_SKIP
964#define GDAL_OF_KIND_MASK 0x1E
965#endif
966
971#define GDAL_OF_SHARED 0x20
972
977#define GDAL_OF_VERBOSE_ERROR 0x40
978
985#define GDAL_OF_INTERNAL 0x80
986
996#define GDAL_OF_DEFAULT_BLOCK_ACCESS 0
997
1006#define GDAL_OF_ARRAY_BLOCK_ACCESS 0x100
1007
1016#define GDAL_OF_HASHSET_BLOCK_ACCESS 0x200
1017
1018#ifndef DOXYGEN_SKIP
1019/* Reserved for a potential future alternative to GDAL_OF_ARRAY_BLOCK_ACCESS
1020 * and GDAL_OF_HASHSET_BLOCK_ACCESS */
1021#define GDAL_OF_RESERVED_1 0x300
1022
1024#define GDAL_OF_BLOCK_ACCESS_MASK 0x300
1025#endif
1026
1027#ifndef DOXYGEN_SKIP
1030#define GDAL_OF_FROM_GDALOPEN 0x400
1031#endif
1032
1033GDALDatasetH CPL_DLL CPL_STDCALL GDALOpenEx(
1034 const char *pszFilename, unsigned int nOpenFlags,
1035 const char *const *papszAllowedDrivers, const char *const *papszOpenOptions,
1036 const char *const *papszSiblingFiles) CPL_WARN_UNUSED_RESULT;
1037
1038int CPL_DLL CPL_STDCALL GDALDumpOpenDatasets(FILE *);
1039
1040GDALDriverH CPL_DLL CPL_STDCALL GDALGetDriverByName(const char *);
1041int CPL_DLL CPL_STDCALL GDALGetDriverCount(void);
1042GDALDriverH CPL_DLL CPL_STDCALL GDALGetDriver(int);
1043GDALDriverH CPL_DLL CPL_STDCALL GDALCreateDriver(void);
1044void CPL_DLL CPL_STDCALL GDALDestroyDriver(GDALDriverH);
1045int CPL_DLL CPL_STDCALL GDALRegisterDriver(GDALDriverH);
1046void CPL_DLL CPL_STDCALL GDALDeregisterDriver(GDALDriverH);
1047void CPL_DLL CPL_STDCALL GDALDestroyDriverManager(void);
1048#ifndef DOXYGEN_SKIP
1049void CPL_DLL GDALDestroy(void);
1050#endif
1051CPLErr CPL_DLL CPL_STDCALL GDALDeleteDataset(GDALDriverH, const char *);
1052CPLErr CPL_DLL CPL_STDCALL GDALRenameDataset(GDALDriverH,
1053 const char *pszNewName,
1054 const char *pszOldName);
1055CPLErr CPL_DLL CPL_STDCALL GDALCopyDatasetFiles(GDALDriverH,
1056 const char *pszNewName,
1057 const char *pszOldName);
1058int CPL_DLL CPL_STDCALL
1060char CPL_DLL **GDALGetOutputDriversForDatasetName(const char *pszDestFilename,
1061 int nFlagRasterVector,
1062 bool bSingleMatch,
1063 bool bEmitWarning);
1064
1065/* The following are deprecated */
1066const char CPL_DLL *CPL_STDCALL GDALGetDriverShortName(GDALDriverH);
1067const char CPL_DLL *CPL_STDCALL GDALGetDriverLongName(GDALDriverH);
1068const char CPL_DLL *CPL_STDCALL GDALGetDriverHelpTopic(GDALDriverH);
1069const char CPL_DLL *CPL_STDCALL GDALGetDriverCreationOptionList(GDALDriverH);
1070
1071/* ==================================================================== */
1072/* GDAL_GCP */
1073/* ==================================================================== */
1074
1076typedef struct
1077{
1079 char *pszId;
1080
1082 char *pszInfo;
1083
1088
1090 double dfGCPX;
1091
1093 double dfGCPY;
1094
1096 double dfGCPZ;
1097} GDAL_GCP;
1098
1099void CPL_DLL CPL_STDCALL GDALInitGCPs(int, GDAL_GCP *);
1100void CPL_DLL CPL_STDCALL GDALDeinitGCPs(int, GDAL_GCP *);
1101GDAL_GCP CPL_DLL *CPL_STDCALL GDALDuplicateGCPs(int, const GDAL_GCP *);
1102
1103int CPL_DLL CPL_STDCALL GDALGCPsToGeoTransform(
1104 int nGCPCount, const GDAL_GCP *pasGCPs, double *padfGeoTransform,
1105 int bApproxOK) CPL_WARN_UNUSED_RESULT;
1106int CPL_DLL CPL_STDCALL GDALInvGeoTransform(const double *padfGeoTransformIn,
1107 double *padfInvGeoTransformOut)
1109void CPL_DLL CPL_STDCALL GDALApplyGeoTransform(const double *, double, double,
1110 double *, double *);
1111void CPL_DLL GDALComposeGeoTransforms(const double *padfGeoTransform1,
1112 const double *padfGeoTransform2,
1113 double *padfGeoTransformOut);
1114
1115/* ==================================================================== */
1116/* major objects (dataset, and, driver, drivermanager). */
1117/* ==================================================================== */
1118
1119char CPL_DLL **CPL_STDCALL GDALGetMetadataDomainList(GDALMajorObjectH hObject);
1120char CPL_DLL **CPL_STDCALL GDALGetMetadata(GDALMajorObjectH, const char *);
1122 const char *);
1123const char CPL_DLL *CPL_STDCALL GDALGetMetadataItem(GDALMajorObjectH,
1124 const char *, const char *);
1125CPLErr CPL_DLL CPL_STDCALL GDALSetMetadataItem(GDALMajorObjectH, const char *,
1126 const char *, const char *);
1127const char CPL_DLL *CPL_STDCALL GDALGetDescription(GDALMajorObjectH);
1128void CPL_DLL CPL_STDCALL GDALSetDescription(GDALMajorObjectH, const char *);
1129
1130/* ==================================================================== */
1131/* GDALDataset class ... normally this represents one file. */
1132/* ==================================================================== */
1133
1135#define GDAL_DS_LAYER_CREATIONOPTIONLIST "DS_LAYER_CREATIONOPTIONLIST"
1136
1137GDALDriverH CPL_DLL CPL_STDCALL GDALGetDatasetDriver(GDALDatasetH);
1138char CPL_DLL **CPL_STDCALL GDALGetFileList(GDALDatasetH);
1139CPLErr CPL_DLL CPL_STDCALL GDALClose(GDALDatasetH);
1140int CPL_DLL CPL_STDCALL GDALGetRasterXSize(GDALDatasetH);
1141int CPL_DLL CPL_STDCALL GDALGetRasterYSize(GDALDatasetH);
1142int CPL_DLL CPL_STDCALL GDALGetRasterCount(GDALDatasetH);
1143GDALRasterBandH CPL_DLL CPL_STDCALL GDALGetRasterBand(GDALDatasetH, int);
1144
1145CPLErr CPL_DLL CPL_STDCALL GDALAddBand(GDALDatasetH hDS, GDALDataType eType,
1146 CSLConstList papszOptions);
1147
1148GDALAsyncReaderH CPL_DLL CPL_STDCALL GDALBeginAsyncReader(
1149 GDALDatasetH hDS, int nXOff, int nYOff, int nXSize, int nYSize, void *pBuf,
1150 int nBufXSize, int nBufYSize, GDALDataType eBufType, int nBandCount,
1151 int *panBandMap, int nPixelSpace, int nLineSpace, int nBandSpace,
1153
1154void CPL_DLL CPL_STDCALL GDALEndAsyncReader(GDALDatasetH hDS,
1155 GDALAsyncReaderH hAsynchReaderH);
1156
1157CPLErr CPL_DLL CPL_STDCALL GDALDatasetRasterIO(
1158 GDALDatasetH hDS, GDALRWFlag eRWFlag, int nDSXOff, int nDSYOff,
1159 int nDSXSize, int nDSYSize, void *pBuffer, int nBXSize, int nBYSize,
1160 GDALDataType eBDataType, int nBandCount, int *panBandCount, int nPixelSpace,
1161 int nLineSpace, int nBandSpace) CPL_WARN_UNUSED_RESULT;
1162
1163CPLErr CPL_DLL CPL_STDCALL GDALDatasetRasterIOEx(
1164 GDALDatasetH hDS, GDALRWFlag eRWFlag, int nDSXOff, int nDSYOff,
1165 int nDSXSize, int nDSYSize, void *pBuffer, int nBXSize, int nBYSize,
1166 GDALDataType eBDataType, int nBandCount, int *panBandCount,
1167 GSpacing nPixelSpace, GSpacing nLineSpace, GSpacing nBandSpace,
1169
1170CPLErr CPL_DLL CPL_STDCALL GDALDatasetAdviseRead(
1171 GDALDatasetH hDS, int nDSXOff, int nDSYOff, int nDSXSize, int nDSYSize,
1172 int nBXSize, int nBYSize, GDALDataType eBDataType, int nBandCount,
1173 int *panBandCount, CSLConstList papszOptions);
1174
1175char CPL_DLL **
1176GDALDatasetGetCompressionFormats(GDALDatasetH hDS, int nXOff, int nYOff,
1177 int nXSize, int nYSize, int nBandCount,
1178 const int *panBandList) CPL_WARN_UNUSED_RESULT;
1180 GDALDatasetH hDS, const char *pszFormat, int nXOff, int nYOff, int nXSize,
1181 int nYSize, int nBandCount, const int *panBandList, void **ppBuffer,
1182 size_t *pnBufferSize, char **ppszDetailedFormat);
1183
1184const char CPL_DLL *CPL_STDCALL GDALGetProjectionRef(GDALDatasetH);
1186CPLErr CPL_DLL CPL_STDCALL GDALSetProjection(GDALDatasetH, const char *);
1188CPLErr CPL_DLL CPL_STDCALL GDALGetGeoTransform(GDALDatasetH, double *);
1189CPLErr CPL_DLL CPL_STDCALL GDALSetGeoTransform(GDALDatasetH, double *);
1190
1191int CPL_DLL CPL_STDCALL GDALGetGCPCount(GDALDatasetH);
1192const char CPL_DLL *CPL_STDCALL GDALGetGCPProjection(GDALDatasetH);
1194const GDAL_GCP CPL_DLL *CPL_STDCALL GDALGetGCPs(GDALDatasetH);
1195CPLErr CPL_DLL CPL_STDCALL GDALSetGCPs(GDALDatasetH, int, const GDAL_GCP *,
1196 const char *);
1197CPLErr CPL_DLL GDALSetGCPs2(GDALDatasetH, int, const GDAL_GCP *,
1199
1200void CPL_DLL *CPL_STDCALL GDALGetInternalHandle(GDALDatasetH, const char *);
1201int CPL_DLL CPL_STDCALL GDALReferenceDataset(GDALDatasetH);
1202int CPL_DLL CPL_STDCALL GDALDereferenceDataset(GDALDatasetH);
1203int CPL_DLL CPL_STDCALL GDALReleaseDataset(GDALDatasetH);
1204
1205CPLErr CPL_DLL CPL_STDCALL GDALBuildOverviews(GDALDatasetH, const char *, int,
1206 const int *, int, const int *,
1207 GDALProgressFunc,
1208 void *) CPL_WARN_UNUSED_RESULT;
1209CPLErr CPL_DLL CPL_STDCALL GDALBuildOverviewsEx(
1210 GDALDatasetH, const char *, int, const int *, int, const int *,
1211 GDALProgressFunc, void *, CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
1212void CPL_DLL CPL_STDCALL GDALGetOpenDatasets(GDALDatasetH **hDS, int *pnCount);
1213int CPL_DLL CPL_STDCALL GDALGetAccess(GDALDatasetH hDS);
1214CPLErr CPL_DLL CPL_STDCALL GDALFlushCache(GDALDatasetH hDS);
1215CPLErr CPL_DLL CPL_STDCALL GDALDropCache(GDALDatasetH hDS);
1216
1217CPLErr CPL_DLL CPL_STDCALL GDALCreateDatasetMaskBand(GDALDatasetH hDS,
1218 int nFlags);
1219
1220CPLErr CPL_DLL CPL_STDCALL GDALDatasetCopyWholeRaster(
1221 GDALDatasetH hSrcDS, GDALDatasetH hDstDS, CSLConstList papszOptions,
1222 GDALProgressFunc pfnProgress, void *pProgressData) CPL_WARN_UNUSED_RESULT;
1223
1224CPLErr CPL_DLL CPL_STDCALL GDALRasterBandCopyWholeRaster(
1225 GDALRasterBandH hSrcBand, GDALRasterBandH hDstBand,
1226 const char *const *constpapszOptions, GDALProgressFunc pfnProgress,
1227 void *pProgressData) CPL_WARN_UNUSED_RESULT;
1228
1230 int nOverviewCount,
1231 GDALRasterBandH *pahOverviewBands,
1232 const char *pszResampling,
1233 GDALProgressFunc pfnProgress,
1234 void *pProgressData);
1235
1237 int nOverviewCount,
1238 GDALRasterBandH *pahOverviewBands,
1239 const char *pszResampling,
1240 GDALProgressFunc pfnProgress,
1241 void *pProgressData,
1242 CSLConstList papszOptions);
1243
1246
1247/* Defined here to avoid circular dependency with ogr_api.h */
1249
1250OGRLayerH CPL_DLL GDALDatasetGetLayerByName(GDALDatasetH, const char *);
1251int CPL_DLL GDALDatasetIsLayerPrivate(GDALDatasetH, int);
1253OGRLayerH CPL_DLL GDALDatasetCreateLayer(GDALDatasetH, const char *,
1257 const char *,
1259 CSLConstList);
1261 CSLConstList);
1264 OGRLayerH *phBelongingLayer,
1265 double *pdfProgressPct,
1266 GDALProgressFunc pfnProgress,
1267 void *pProgressData);
1268int CPL_DLL GDALDatasetTestCapability(GDALDatasetH, const char *);
1269OGRLayerH CPL_DLL GDALDatasetExecuteSQL(GDALDatasetH, const char *,
1270 OGRGeometryH, const char *);
1276OGRErr CPL_DLL GDALDatasetStartTransaction(GDALDatasetH hDS, int bForce);
1280
1284 const char *pszName);
1286 OGRFieldDomainH hFieldDomain,
1287 char **ppszFailureReason);
1288bool CPL_DLL GDALDatasetDeleteFieldDomain(GDALDatasetH hDS, const char *pszName,
1289 char **ppszFailureReason);
1291 OGRFieldDomainH hFieldDomain,
1292 char **ppszFailureReason);
1293
1297 const char *pszName);
1298
1300 GDALRelationshipH hRelationship,
1301 char **ppszFailureReason);
1303 const char *pszName,
1304 char **ppszFailureReason);
1306 GDALRelationshipH hRelationship,
1307 char **ppszFailureReason);
1308
1311typedef void (*GDALQueryLoggerFunc)(const char *pszSQL, const char *pszError,
1312 int64_t lNumRecords,
1313 int64_t lExecutionTimeMilliseconds,
1314 void *pQueryLoggerArg);
1315
1333 GDALDatasetH hDS, GDALQueryLoggerFunc pfnQueryLoggerFunc,
1334 void *poQueryLoggerArg);
1335
1336/* ==================================================================== */
1337/* Informational utilities about subdatasets in file names */
1338/* ==================================================================== */
1339
1345
1357GDALSubdatasetInfoH CPL_DLL GDALGetSubdatasetInfo(const char *pszFileName);
1358
1370
1379char CPL_DLL *
1381
1392 const char *pszNewPath);
1393
1400
1401/* ==================================================================== */
1402/* GDALRasterBand ... one band/channel in a dataset. */
1403/* ==================================================================== */
1404
1405/* Note: the only user of SRCVAL() was frmts/vrt/pixelfunctions.cpp and we no */
1406/* longer use it. */
1407
1412#define SRCVAL(papoSource, eSrcType, ii) \
1413 (eSrcType == GDT_Byte \
1414 ? CPL_REINTERPRET_CAST(const GByte *, papoSource)[ii] \
1415 : (eSrcType == GDT_Int8 \
1416 ? CPL_REINTERPRET_CAST(const GInt8 *, papoSource)[ii] \
1417 : (eSrcType == GDT_Float32 \
1418 ? CPL_REINTERPRET_CAST(const float *, papoSource)[ii] \
1419 : (eSrcType == GDT_Float64 \
1420 ? CPL_REINTERPRET_CAST(const double *, \
1421 papoSource)[ii] \
1422 : (eSrcType == GDT_Int32 \
1423 ? CPL_REINTERPRET_CAST(const GInt32 *, \
1424 papoSource)[ii] \
1425 : (eSrcType == GDT_UInt16 \
1426 ? CPL_REINTERPRET_CAST( \
1427 const GUInt16 *, \
1428 papoSource)[ii] \
1429 : (eSrcType == GDT_Int16 \
1430 ? CPL_REINTERPRET_CAST( \
1431 const GInt16 *, \
1432 papoSource)[ii] \
1433 : (eSrcType == GDT_UInt32 \
1434 ? CPL_REINTERPRET_CAST( \
1435 const GUInt32 \
1436 *, \
1437 papoSource) \
1438 [ii] \
1439 : (eSrcType == \
1440 GDT_CInt16 \
1441 ? CPL_REINTERPRET_CAST( \
1442 const GInt16 \
1443 *, \
1444 papoSource) \
1445 [(ii)*2] \
1446 : (eSrcType == \
1447 GDT_CInt32 \
1448 ? CPL_REINTERPRET_CAST( \
1449 const GInt32 \
1450 *, \
1451 papoSource) \
1452 [(ii)*2] \
1453 : (eSrcType == \
1454 GDT_CFloat32 \
1455 ? CPL_REINTERPRET_CAST( \
1456 const float \
1457 *, \
1458 papoSource) \
1459 [(ii)*2] \
1460 : (eSrcType == \
1461 GDT_CFloat64 \
1462 ? CPL_REINTERPRET_CAST( \
1463 const double \
1464 *, \
1465 papoSource) \
1466 [(ii)*2] \
1467 : 0))))))))))))
1468
1471typedef CPLErr (*GDALDerivedPixelFunc)(void **papoSources, int nSources,
1472 void *pData, int nBufXSize,
1473 int nBufYSize, GDALDataType eSrcType,
1474 GDALDataType eBufType, int nPixelSpace,
1475 int nLineSpace);
1476
1480 void **papoSources, int nSources, void *pData, int nBufXSize, int nBufYSize,
1481 GDALDataType eSrcType, GDALDataType eBufType, int nPixelSpace,
1482 int nLineSpace, CSLConstList papszFunctionArgs);
1483
1485void CPL_DLL CPL_STDCALL GDALGetBlockSize(GDALRasterBandH, int *pnXSize,
1486 int *pnYSize);
1487
1489 int nXBlockOff,
1490 int nYBlockOff, int *pnXValid,
1491 int *pnYValid);
1492
1493CPLErr CPL_DLL CPL_STDCALL GDALRasterAdviseRead(GDALRasterBandH hRB,
1494 int nDSXOff, int nDSYOff,
1495 int nDSXSize, int nDSYSize,
1496 int nBXSize, int nBYSize,
1497 GDALDataType eBDataType,
1498 CSLConstList papszOptions);
1499
1500CPLErr CPL_DLL CPL_STDCALL GDALRasterIO(GDALRasterBandH hRBand,
1501 GDALRWFlag eRWFlag, int nDSXOff,
1502 int nDSYOff, int nDSXSize, int nDSYSize,
1503 void *pBuffer, int nBXSize, int nBYSize,
1504 GDALDataType eBDataType,
1505 int nPixelSpace,
1506 int nLineSpace) CPL_WARN_UNUSED_RESULT;
1507CPLErr CPL_DLL CPL_STDCALL GDALRasterIOEx(
1508 GDALRasterBandH hRBand, GDALRWFlag eRWFlag, int nDSXOff, int nDSYOff,
1509 int nDSXSize, int nDSYSize, void *pBuffer, int nBXSize, int nBYSize,
1510 GDALDataType eBDataType, GSpacing nPixelSpace, GSpacing nLineSpace,
1512CPLErr CPL_DLL CPL_STDCALL GDALReadBlock(GDALRasterBandH, int, int,
1513 void *) CPL_WARN_UNUSED_RESULT;
1514CPLErr CPL_DLL CPL_STDCALL GDALWriteBlock(GDALRasterBandH, int, int,
1515 void *) CPL_WARN_UNUSED_RESULT;
1516int CPL_DLL CPL_STDCALL GDALGetRasterBandXSize(GDALRasterBandH);
1517int CPL_DLL CPL_STDCALL GDALGetRasterBandYSize(GDALRasterBandH);
1519int CPL_DLL CPL_STDCALL GDALGetBandNumber(GDALRasterBandH);
1521
1529int CPL_DLL CPL_STDCALL GDALHasArbitraryOverviews(GDALRasterBandH);
1530int CPL_DLL CPL_STDCALL GDALGetOverviewCount(GDALRasterBandH);
1531GDALRasterBandH CPL_DLL CPL_STDCALL GDALGetOverview(GDALRasterBandH, int);
1532double CPL_DLL CPL_STDCALL GDALGetRasterNoDataValue(GDALRasterBandH, int *);
1533int64_t CPL_DLL CPL_STDCALL GDALGetRasterNoDataValueAsInt64(GDALRasterBandH,
1534 int *);
1535uint64_t CPL_DLL CPL_STDCALL GDALGetRasterNoDataValueAsUInt64(GDALRasterBandH,
1536 int *);
1537CPLErr CPL_DLL CPL_STDCALL GDALSetRasterNoDataValue(GDALRasterBandH, double);
1539 int64_t);
1541 uint64_t);
1543char CPL_DLL **CPL_STDCALL GDALGetRasterCategoryNames(GDALRasterBandH);
1545 CSLConstList);
1546double CPL_DLL CPL_STDCALL GDALGetRasterMinimum(GDALRasterBandH,
1547 int *pbSuccess);
1548double CPL_DLL CPL_STDCALL GDALGetRasterMaximum(GDALRasterBandH,
1549 int *pbSuccess);
1550CPLErr CPL_DLL CPL_STDCALL GDALGetRasterStatistics(
1551 GDALRasterBandH, int bApproxOK, int bForce, double *pdfMin, double *pdfMax,
1552 double *pdfMean, double *pdfStdDev);
1553CPLErr CPL_DLL CPL_STDCALL
1554GDALComputeRasterStatistics(GDALRasterBandH, int bApproxOK, double *pdfMin,
1555 double *pdfMax, double *pdfMean, double *pdfStdDev,
1556 GDALProgressFunc pfnProgress, void *pProgressData);
1557CPLErr CPL_DLL CPL_STDCALL GDALSetRasterStatistics(GDALRasterBandH hBand,
1558 double dfMin, double dfMax,
1559 double dfMean,
1560 double dfStdDev);
1561
1564
1565const char CPL_DLL *CPL_STDCALL GDALGetRasterUnitType(GDALRasterBandH);
1566CPLErr CPL_DLL CPL_STDCALL GDALSetRasterUnitType(GDALRasterBandH hBand,
1567 const char *pszNewValue);
1568double CPL_DLL CPL_STDCALL GDALGetRasterOffset(GDALRasterBandH, int *pbSuccess);
1569CPLErr CPL_DLL CPL_STDCALL GDALSetRasterOffset(GDALRasterBandH hBand,
1570 double dfNewOffset);
1571double CPL_DLL CPL_STDCALL GDALGetRasterScale(GDALRasterBandH, int *pbSuccess);
1572CPLErr CPL_DLL CPL_STDCALL GDALSetRasterScale(GDALRasterBandH hBand,
1573 double dfNewOffset);
1574CPLErr CPL_DLL CPL_STDCALL GDALComputeRasterMinMax(GDALRasterBandH hBand,
1575 int bApproxOK,
1576 double adfMinMax[2]);
1577CPLErr CPL_DLL CPL_STDCALL GDALFlushRasterCache(GDALRasterBandH hBand);
1578CPLErr CPL_DLL CPL_STDCALL GDALDropRasterCache(GDALRasterBandH hBand);
1579CPLErr CPL_DLL CPL_STDCALL GDALGetRasterHistogram(
1580 GDALRasterBandH hBand, double dfMin, double dfMax, int nBuckets,
1581 int *panHistogram, int bIncludeOutOfRange, int bApproxOK,
1582 GDALProgressFunc pfnProgress, void *pProgressData)
1584 CPL_WARN_DEPRECATED("Use GDALGetRasterHistogramEx() instead")
1586 ;
1587CPLErr CPL_DLL CPL_STDCALL GDALGetRasterHistogramEx(
1588 GDALRasterBandH hBand, double dfMin, double dfMax, int nBuckets,
1589 GUIntBig *panHistogram, int bIncludeOutOfRange, int bApproxOK,
1590 GDALProgressFunc pfnProgress, void *pProgressData);
1591CPLErr CPL_DLL CPL_STDCALL
1592GDALGetDefaultHistogram(GDALRasterBandH hBand, double *pdfMin, double *pdfMax,
1593 int *pnBuckets, int **ppanHistogram, int bForce,
1594 GDALProgressFunc pfnProgress, void *pProgressData)
1596 CPL_WARN_DEPRECATED("Use GDALGetDefaultHistogramEx() instead")
1598 ;
1599CPLErr CPL_DLL CPL_STDCALL
1600GDALGetDefaultHistogramEx(GDALRasterBandH hBand, double *pdfMin, double *pdfMax,
1601 int *pnBuckets, GUIntBig **ppanHistogram, int bForce,
1602 GDALProgressFunc pfnProgress, void *pProgressData);
1603CPLErr CPL_DLL CPL_STDCALL GDALSetDefaultHistogram(GDALRasterBandH hBand,
1604 double dfMin, double dfMax,
1605 int nBuckets,
1606 int *panHistogram)
1608 CPL_WARN_DEPRECATED("Use GDALSetDefaultHistogramEx() instead")
1610 ;
1611CPLErr CPL_DLL CPL_STDCALL GDALSetDefaultHistogramEx(GDALRasterBandH hBand,
1612 double dfMin, double dfMax,
1613 int nBuckets,
1614 GUIntBig *panHistogram);
1615int CPL_DLL CPL_STDCALL GDALGetRandomRasterSample(GDALRasterBandH, int,
1616 float *);
1618 int);
1619GDALRasterBandH CPL_DLL CPL_STDCALL
1621CPLErr CPL_DLL CPL_STDCALL GDALFillRaster(GDALRasterBandH hBand,
1622 double dfRealValue,
1623 double dfImaginaryValue);
1624CPLErr CPL_DLL CPL_STDCALL GDALComputeBandStats(
1625 GDALRasterBandH hBand, int nSampleStep, double *pdfMean, double *pdfStdDev,
1626 GDALProgressFunc pfnProgress, void *pProgressData);
1628 int nOverviewCount,
1629 GDALRasterBandH *pahOverviews,
1630 GDALProgressFunc pfnProgress,
1631 void *pProgressData);
1632
1633GDALRasterAttributeTableH CPL_DLL CPL_STDCALL
1635CPLErr CPL_DLL CPL_STDCALL GDALSetDefaultRAT(GDALRasterBandH,
1637CPLErr CPL_DLL CPL_STDCALL GDALAddDerivedBandPixelFunc(
1638 const char *pszName, GDALDerivedPixelFunc pfnPixelFunc);
1640 const char *pszName, GDALDerivedPixelFuncWithArgs pfnPixelFunc,
1641 const char *pszMetadata);
1642
1646
1686 const char *pszFuncName, void *pUserData, CSLConstList papszFunctionArgs,
1687 int nInBands, GDALDataType eInDT, double *padfInNoData, int *pnOutBands,
1688 GDALDataType *peOutDT, double **ppadfOutNoData, const char *pszVRTPath,
1689 VRTPDWorkingDataPtr *ppWorkingData);
1690
1701 const char *pszFuncName, void *pUserData, VRTPDWorkingDataPtr pWorkingData);
1702
1734 const char *pszFuncName, void *pUserData, VRTPDWorkingDataPtr pWorkingData,
1735 CSLConstList papszFunctionArgs, int nBufXSize, int nBufYSize,
1736 const void *pInBuffer, size_t nInBufferSize, GDALDataType eInDT,
1737 int nInBands, const double *padfInNoData, void *pOutBuffer,
1738 size_t nOutBufferSize, GDALDataType eOutDT, int nOutBands,
1739 const double *padfOutNoData, double dfSrcXOff, double dfSrcYOff,
1740 double dfSrcXSize, double dfSrcYSize, const double adfSrcGT[/*6*/],
1741 const char *pszVRTPath, CSLConstList papszExtra);
1742
1744 const char *pszFuncName, void *pUserData, const char *pszXMLMetadata,
1745 GDALDataType eRequestedInputDT, const GDALDataType *paeSupportedInputDT,
1746 size_t nSupportedInputDTSize, const int *panSupportedInputBandCount,
1747 size_t nSupportedInputBandCountSize,
1750 GDALVRTProcessedDatasetFuncProcess pfnProcess, CSLConstList papszOptions);
1751
1752GDALRasterBandH CPL_DLL CPL_STDCALL GDALGetMaskBand(GDALRasterBandH hBand);
1753int CPL_DLL CPL_STDCALL GDALGetMaskFlags(GDALRasterBandH hBand);
1754CPLErr CPL_DLL CPL_STDCALL GDALCreateMaskBand(GDALRasterBandH hBand,
1755 int nFlags);
1756bool CPL_DLL GDALIsMaskBand(GDALRasterBandH hBand);
1757
1759#define GMF_ALL_VALID 0x01
1762#define GMF_PER_DATASET 0x02
1765#define GMF_ALPHA 0x04
1768#define GMF_NODATA 0x08
1769
1773#define GDAL_DATA_COVERAGE_STATUS_UNIMPLEMENTED 0x01
1774
1779#define GDAL_DATA_COVERAGE_STATUS_DATA 0x02
1780
1786#define GDAL_DATA_COVERAGE_STATUS_EMPTY 0x04
1787
1788int CPL_DLL CPL_STDCALL GDALGetDataCoverageStatus(GDALRasterBandH hBand,
1789 int nXOff, int nYOff,
1790 int nXSize, int nYSize,
1791 int nMaskFlagStop,
1792 double *pdfDataPct);
1793
1794/* ==================================================================== */
1795/* GDALAsyncReader */
1796/* ==================================================================== */
1797
1799 GDALAsyncReaderH hARIO, double dfTimeout, int *pnXBufOff, int *pnYBufOff,
1800 int *pnXBufSize, int *pnYBufSize);
1801int CPL_DLL CPL_STDCALL GDALARLockBuffer(GDALAsyncReaderH hARIO,
1802 double dfTimeout);
1803void CPL_DLL CPL_STDCALL GDALARUnlockBuffer(GDALAsyncReaderH hARIO);
1804
1805/* -------------------------------------------------------------------- */
1806/* Helper functions. */
1807/* -------------------------------------------------------------------- */
1808int CPL_DLL CPL_STDCALL GDALGeneralCmdLineProcessor(int nArgc,
1809 char ***ppapszArgv,
1810 int nOptions);
1811void CPL_DLL CPL_STDCALL GDALSwapWords(void *pData, int nWordSize,
1812 int nWordCount, int nWordSkip);
1813void CPL_DLL CPL_STDCALL GDALSwapWordsEx(void *pData, int nWordSize,
1814 size_t nWordCount, int nWordSkip);
1815
1816void CPL_DLL CPL_STDCALL GDALCopyWords(const void *CPL_RESTRICT pSrcData,
1817 GDALDataType eSrcType,
1818 int nSrcPixelOffset,
1819 void *CPL_RESTRICT pDstData,
1820 GDALDataType eDstType,
1821 int nDstPixelOffset, int nWordCount);
1822
1823void CPL_DLL CPL_STDCALL GDALCopyWords64(
1824 const void *CPL_RESTRICT pSrcData, GDALDataType eSrcType,
1825 int nSrcPixelOffset, void *CPL_RESTRICT pDstData, GDALDataType eDstType,
1826 int nDstPixelOffset, GPtrDiff_t nWordCount);
1827
1828void CPL_DLL GDALCopyBits(const GByte *pabySrcData, int nSrcOffset,
1829 int nSrcStep, GByte *pabyDstData, int nDstOffset,
1830 int nDstStep, int nBitCount, int nStepCount);
1831
1832void CPL_DLL GDALDeinterleave(const void *pSourceBuffer, GDALDataType eSourceDT,
1833 int nComponents, void **ppDestBuffer,
1834 GDALDataType eDestDT, size_t nIters);
1835
1836double CPL_DLL GDALGetNoDataReplacementValue(GDALDataType, double);
1837
1838int CPL_DLL CPL_STDCALL GDALLoadWorldFile(const char *, double *);
1839int CPL_DLL CPL_STDCALL GDALReadWorldFile(const char *, const char *, double *);
1840int CPL_DLL CPL_STDCALL GDALWriteWorldFile(const char *, const char *,
1841 double *);
1842int CPL_DLL CPL_STDCALL GDALLoadTabFile(const char *, double *, char **, int *,
1843 GDAL_GCP **);
1844int CPL_DLL CPL_STDCALL GDALReadTabFile(const char *, double *, char **, int *,
1845 GDAL_GCP **);
1846int CPL_DLL CPL_STDCALL GDALLoadOziMapFile(const char *, double *, char **,
1847 int *, GDAL_GCP **);
1848int CPL_DLL CPL_STDCALL GDALReadOziMapFile(const char *, double *, char **,
1849 int *, GDAL_GCP **);
1850
1851const char CPL_DLL *CPL_STDCALL GDALDecToDMS(double, const char *, int);
1852double CPL_DLL CPL_STDCALL GDALPackedDMSToDec(double);
1853double CPL_DLL CPL_STDCALL GDALDecToPackedDMS(double);
1854
1855/* Note to developers : please keep this section in sync with ogr_core.h */
1856
1857#ifndef GDAL_VERSION_INFO_DEFINED
1858#ifndef DOXYGEN_SKIP
1859#define GDAL_VERSION_INFO_DEFINED
1860#endif
1861const char CPL_DLL *CPL_STDCALL GDALVersionInfo(const char *);
1862#endif
1863
1864#ifndef GDAL_CHECK_VERSION
1865
1866int CPL_DLL CPL_STDCALL GDALCheckVersion(int nVersionMajor, int nVersionMinor,
1867 const char *pszCallingComponentName);
1868
1872#define GDAL_CHECK_VERSION(pszCallingComponentName) \
1873 GDALCheckVersion(GDAL_VERSION_MAJOR, GDAL_VERSION_MINOR, \
1874 pszCallingComponentName)
1875
1876#endif
1877
1879#ifdef GDAL_COMPILATION
1880#define GDALExtractRPCInfoV1 GDALExtractRPCInfo
1881#else
1882#define GDALRPCInfo GDALRPCInfoV2
1883#define GDALExtractRPCInfo GDALExtractRPCInfoV2
1884#endif
1885
1886/* Deprecated: use GDALRPCInfoV2 */
1887typedef struct
1888{
1889 double dfLINE_OFF;
1890 double dfSAMP_OFF;
1891 double dfLAT_OFF;
1892 double dfLONG_OFF;
1893 double dfHEIGHT_OFF;
1895 double dfLINE_SCALE;
1896 double dfSAMP_SCALE;
1897 double dfLAT_SCALE;
1898 double dfLONG_SCALE;
1899 double dfHEIGHT_SCALE;
1901 double adfLINE_NUM_COEFF[20];
1902 double adfLINE_DEN_COEFF[20];
1903 double adfSAMP_NUM_COEFF[20];
1904 double adfSAMP_DEN_COEFF[20];
1906 double dfMIN_LONG;
1907 double dfMIN_LAT;
1908 double dfMAX_LONG;
1909 double dfMAX_LAT;
1910} GDALRPCInfoV1;
1911
1916typedef struct
1917{
1918 double dfLINE_OFF;
1919 double dfSAMP_OFF;
1920 double dfLAT_OFF;
1921 double dfLONG_OFF;
1930 double adfLINE_NUM_COEFF[20];
1931 double adfLINE_DEN_COEFF[20];
1932 double adfSAMP_NUM_COEFF[20];
1933 double adfSAMP_DEN_COEFF[20];
1935 double dfMIN_LONG;
1936 double dfMIN_LAT;
1937 double dfMAX_LONG;
1938 double dfMAX_LAT;
1940 /* Those fields should be at the end. And all above fields should be the
1941 * same as in GDALRPCInfoV1 */
1942 double dfERR_BIAS;
1943 double dfERR_RAND;
1945
1947int CPL_DLL CPL_STDCALL GDALExtractRPCInfoV1(CSLConstList, GDALRPCInfoV1 *);
1949int CPL_DLL CPL_STDCALL GDALExtractRPCInfoV2(CSLConstList, GDALRPCInfoV2 *);
1950
1951/* ==================================================================== */
1952/* Color tables. */
1953/* ==================================================================== */
1954
1956typedef struct
1957{
1959 short c1;
1960
1962 short c2;
1963
1965 short c3;
1966
1968 short c4;
1970
1973void CPL_DLL CPL_STDCALL GDALDestroyColorTable(GDALColorTableH);
1976 CPL_DLL CPL_STDCALL GDALGetPaletteInterpretation(GDALColorTableH);
1977int CPL_DLL CPL_STDCALL GDALGetColorEntryCount(GDALColorTableH);
1978const GDALColorEntry CPL_DLL *CPL_STDCALL GDALGetColorEntry(GDALColorTableH,
1979 int);
1980int CPL_DLL CPL_STDCALL GDALGetColorEntryAsRGB(GDALColorTableH, int,
1981 GDALColorEntry *);
1982void CPL_DLL CPL_STDCALL GDALSetColorEntry(GDALColorTableH, int,
1983 const GDALColorEntry *);
1984void CPL_DLL CPL_STDCALL GDALCreateColorRamp(GDALColorTableH hTable,
1985 int nStartIndex,
1986 const GDALColorEntry *psStartColor,
1987 int nEndIndex,
1988 const GDALColorEntry *psEndColor);
1989
1990/* ==================================================================== */
1991/* Raster Attribute Table */
1992/* ==================================================================== */
1993
1995typedef enum
2001
2003typedef enum
2025
2029typedef enum
2034
2035GDALRasterAttributeTableH CPL_DLL CPL_STDCALL
2037
2038void CPL_DLL CPL_STDCALL
2040
2041int CPL_DLL CPL_STDCALL GDALRATGetColumnCount(GDALRasterAttributeTableH);
2042
2043const char CPL_DLL *CPL_STDCALL GDALRATGetNameOfCol(GDALRasterAttributeTableH,
2044 int);
2045GDALRATFieldUsage CPL_DLL CPL_STDCALL
2047GDALRATFieldType CPL_DLL CPL_STDCALL
2049
2050int CPL_DLL CPL_STDCALL GDALRATGetColOfUsage(GDALRasterAttributeTableH,
2052int CPL_DLL CPL_STDCALL GDALRATGetRowCount(GDALRasterAttributeTableH);
2053
2054const char CPL_DLL *CPL_STDCALL
2056int CPL_DLL CPL_STDCALL GDALRATGetValueAsInt(GDALRasterAttributeTableH, int,
2057 int);
2058double CPL_DLL CPL_STDCALL GDALRATGetValueAsDouble(GDALRasterAttributeTableH,
2059 int, int);
2060
2061void CPL_DLL CPL_STDCALL GDALRATSetValueAsString(GDALRasterAttributeTableH, int,
2062 int, const char *);
2063void CPL_DLL CPL_STDCALL GDALRATSetValueAsInt(GDALRasterAttributeTableH, int,
2064 int, int);
2065void CPL_DLL CPL_STDCALL GDALRATSetValueAsDouble(GDALRasterAttributeTableH, int,
2066 int, double);
2067
2068int CPL_DLL CPL_STDCALL
2070
2071CPLErr CPL_DLL CPL_STDCALL GDALRATValuesIOAsDouble(
2072 GDALRasterAttributeTableH hRAT, GDALRWFlag eRWFlag, int iField,
2073 int iStartRow, int iLength, double *pdfData);
2074CPLErr CPL_DLL CPL_STDCALL
2076 int iField, int iStartRow, int iLength, int *pnData);
2077CPLErr CPL_DLL CPL_STDCALL GDALRATValuesIOAsString(
2078 GDALRasterAttributeTableH hRAT, GDALRWFlag eRWFlag, int iField,
2079 int iStartRow, int iLength, char **papszStrList);
2080
2081void CPL_DLL CPL_STDCALL GDALRATSetRowCount(GDALRasterAttributeTableH, int);
2083 const char *, GDALRATFieldType,
2086 double, double);
2088 double *, double *);
2089CPLErr CPL_DLL CPL_STDCALL GDALRATSetTableType(
2090 GDALRasterAttributeTableH hRAT, const GDALRATTableType eInTableType);
2091GDALRATTableType CPL_DLL CPL_STDCALL
2093CPLErr CPL_DLL CPL_STDCALL
2095GDALColorTableH CPL_DLL CPL_STDCALL
2097void CPL_DLL CPL_STDCALL GDALRATDumpReadable(GDALRasterAttributeTableH, FILE *);
2098GDALRasterAttributeTableH CPL_DLL CPL_STDCALL
2100
2101void CPL_DLL *CPL_STDCALL GDALRATSerializeJSON(GDALRasterAttributeTableH)
2103
2104int CPL_DLL CPL_STDCALL GDALRATGetRowOfValue(GDALRasterAttributeTableH, double);
2105void CPL_DLL CPL_STDCALL GDALRATRemoveStatistics(GDALRasterAttributeTableH);
2106
2107/* -------------------------------------------------------------------- */
2108/* Relationships */
2109/* -------------------------------------------------------------------- */
2110
2115typedef enum
2116{
2126
2131typedef enum
2132{
2140
2141GDALRelationshipH CPL_DLL GDALRelationshipCreate(const char *, const char *,
2142 const char *,
2144void CPL_DLL CPL_STDCALL GDALDestroyRelationship(GDALRelationshipH);
2145const char CPL_DLL *GDALRelationshipGetName(GDALRelationshipH);
2152 const char *);
2156 CSLConstList);
2158 CSLConstList);
2162 CSLConstList);
2164 CSLConstList);
2169 const char *);
2172 const char *);
2175 const char *);
2176
2177/* ==================================================================== */
2178/* GDAL Cache Management */
2179/* ==================================================================== */
2180
2181void CPL_DLL CPL_STDCALL GDALSetCacheMax(int nBytes);
2182int CPL_DLL CPL_STDCALL GDALGetCacheMax(void);
2183int CPL_DLL CPL_STDCALL GDALGetCacheUsed(void);
2184void CPL_DLL CPL_STDCALL GDALSetCacheMax64(GIntBig nBytes);
2185GIntBig CPL_DLL CPL_STDCALL GDALGetCacheMax64(void);
2186GIntBig CPL_DLL CPL_STDCALL GDALGetCacheUsed64(void);
2187
2188int CPL_DLL CPL_STDCALL GDALFlushCacheBlock(void);
2189
2190/* ==================================================================== */
2191/* GDAL virtual memory */
2192/* ==================================================================== */
2193
2195 GDALDatasetH hDS, GDALRWFlag eRWFlag, int nXOff, int nYOff, int nXSize,
2196 int nYSize, int nBufXSize, int nBufYSize, GDALDataType eBufType,
2197 int nBandCount, int *panBandMap, int nPixelSpace, GIntBig nLineSpace,
2198 GIntBig nBandSpace, size_t nCacheSize, size_t nPageSizeHint,
2199 int bSingleThreadUsage, CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
2200
2202 GDALRasterBandH hBand, GDALRWFlag eRWFlag, int nXOff, int nYOff, int nXSize,
2203 int nYSize, int nBufXSize, int nBufYSize, GDALDataType eBufType,
2204 int nPixelSpace, GIntBig nLineSpace, size_t nCacheSize,
2205 size_t nPageSizeHint, int bSingleThreadUsage,
2207
2208CPLVirtualMem CPL_DLL *
2210 int *pnPixelSpace, GIntBig *pnLineSpace,
2212
2214typedef enum
2215{
2225 GTO_BSQ
2227
2229 GDALDatasetH hDS, GDALRWFlag eRWFlag, int nXOff, int nYOff, int nXSize,
2230 int nYSize, int nTileXSize, int nTileYSize, GDALDataType eBufType,
2231 int nBandCount, int *panBandMap, GDALTileOrganization eTileOrganization,
2232 size_t nCacheSize, int bSingleThreadUsage,
2234
2236 GDALRasterBandH hBand, GDALRWFlag eRWFlag, int nXOff, int nYOff, int nXSize,
2237 int nYSize, int nTileXSize, int nTileYSize, GDALDataType eBufType,
2238 size_t nCacheSize, int bSingleThreadUsage,
2240
2241/* ==================================================================== */
2242/* VRTPansharpenedDataset class. */
2243/* ==================================================================== */
2244
2246 const char *pszXML, GDALRasterBandH hPanchroBand, int nInputSpectralBands,
2247 GDALRasterBandH *pahInputSpectralBands) CPL_WARN_UNUSED_RESULT;
2248
2249/* =================================================================== */
2250/* Misc API */
2251/* ==================================================================== */
2252
2253CPLXMLNode CPL_DLL *
2254GDALGetJPEG2000Structure(const char *pszFilename,
2256
2257/* ==================================================================== */
2258/* Multidimensional API_api */
2259/* ==================================================================== */
2260
2261GDALDatasetH CPL_DLL
2262GDALCreateMultiDimensional(GDALDriverH hDriver, const char *pszName,
2263 CSLConstList papszRootGroupOptions,
2265
2269 size_t nMaxStringLength) CPL_WARN_UNUSED_RESULT;
2271 size_t nMaxStringLength,
2274 const char *pszName, size_t nTotalSize, size_t nComponents,
2277const char CPL_DLL *GDALExtendedDataTypeGetName(GDALExtendedDataTypeH hEDT);
2280GDALDataType CPL_DLL
2283size_t CPL_DLL
2285GDALEDTComponentH CPL_DLL *
2287 size_t *pnCount) CPL_WARN_UNUSED_RESULT;
2289 size_t nCount);
2291 GDALExtendedDataTypeH hTargetEDT);
2293 GDALExtendedDataTypeH hSecondEDT);
2296
2297GDALEDTComponentH CPL_DLL
2298GDALEDTComponentCreate(const char *pszName, size_t nOffset,
2300void CPL_DLL GDALEDTComponentRelease(GDALEDTComponentH hComp);
2301const char CPL_DLL *GDALEDTComponentGetName(GDALEDTComponentH hComp);
2302size_t CPL_DLL GDALEDTComponentGetOffset(GDALEDTComponentH hComp);
2305
2308void CPL_DLL GDALGroupRelease(GDALGroupH hGroup);
2309const char CPL_DLL *GDALGroupGetName(GDALGroupH hGroup);
2310const char CPL_DLL *GDALGroupGetFullName(GDALGroupH hGroup);
2311char CPL_DLL **
2314GDALMDArrayH CPL_DLL
2315GDALGroupOpenMDArray(GDALGroupH hGroup, const char *pszMDArrayName,
2318 GDALGroupH hGroup, const char *pszMDArrayName,
2321 GDALGroupH hGroup, const char *pszName, const char *pszStartingPoint,
2323char CPL_DLL **
2326GDALGroupH CPL_DLL
2327GDALGroupOpenGroup(GDALGroupH hGroup, const char *pszSubGroupName,
2330 GDALGroupH hGroup, const char *pszMDArrayName,
2332char CPL_DLL **
2335OGRLayerH CPL_DLL
2336GDALGroupOpenVectorLayer(GDALGroupH hGroup, const char *pszVectorLayerName,
2338GDALDimensionH CPL_DLL *
2339GDALGroupGetDimensions(GDALGroupH hGroup, size_t *pnCount,
2342 GDALGroupH hGroup, const char *pszName) CPL_WARN_UNUSED_RESULT;
2343GDALAttributeH CPL_DLL *
2344GDALGroupGetAttributes(GDALGroupH hGroup, size_t *pnCount,
2347GDALGroupH CPL_DLL
2348GDALGroupCreateGroup(GDALGroupH hGroup, const char *pszSubGroupName,
2350bool CPL_DLL GDALGroupDeleteGroup(GDALGroupH hGroup, const char *pszName,
2351 CSLConstList papszOptions);
2353 GDALGroupH hGroup, const char *pszName, const char *pszType,
2354 const char *pszDirection, GUInt64 nSize,
2357 GDALGroupH hGroup, const char *pszName, size_t nDimensions,
2358 GDALDimensionH *pahDimensions, GDALExtendedDataTypeH hEDT,
2360bool CPL_DLL GDALGroupDeleteMDArray(GDALGroupH hGroup, const char *pszName,
2361 CSLConstList papszOptions);
2363 GDALGroupH hGroup, const char *pszName, size_t nDimensions,
2364 const GUInt64 *panDimensions, GDALExtendedDataTypeH hEDT,
2366bool CPL_DLL GDALGroupDeleteAttribute(GDALGroupH hGroup, const char *pszName,
2367 CSLConstList papszOptions);
2368bool CPL_DLL GDALGroupRename(GDALGroupH hGroup, const char *pszNewName);
2370 GDALGroupH hGroup, const char *pszSelection, CSLConstList papszOptions);
2371
2372void CPL_DLL GDALMDArrayRelease(GDALMDArrayH hMDArray);
2373const char CPL_DLL *GDALMDArrayGetName(GDALMDArrayH hArray);
2374const char CPL_DLL *GDALMDArrayGetFullName(GDALMDArrayH hArray);
2376size_t CPL_DLL GDALMDArrayGetDimensionCount(GDALMDArrayH hArray);
2377GDALDimensionH CPL_DLL *
2379 size_t *pnCount) CPL_WARN_UNUSED_RESULT;
2382int CPL_DLL GDALMDArrayRead(GDALMDArrayH hArray, const GUInt64 *arrayStartIdx,
2383 const size_t *count, const GInt64 *arrayStep,
2384 const GPtrDiff_t *bufferStride,
2385 GDALExtendedDataTypeH bufferDatatype,
2386 void *pDstBuffer, const void *pDstBufferAllocStart,
2387 size_t nDstBufferllocSize);
2388int CPL_DLL GDALMDArrayWrite(GDALMDArrayH hArray, const GUInt64 *arrayStartIdx,
2389 const size_t *count, const GInt64 *arrayStep,
2390 const GPtrDiff_t *bufferStride,
2391 GDALExtendedDataTypeH bufferDatatype,
2392 const void *pSrcBuffer,
2393 const void *psrcBufferAllocStart,
2394 size_t nSrcBufferllocSize);
2395int CPL_DLL GDALMDArrayAdviseRead(GDALMDArrayH hArray,
2396 const GUInt64 *arrayStartIdx,
2397 const size_t *count);
2398int CPL_DLL GDALMDArrayAdviseReadEx(GDALMDArrayH hArray,
2399 const GUInt64 *arrayStartIdx,
2400 const size_t *count,
2401 CSLConstList papszOptions);
2403 GDALMDArrayH hArray, const char *pszName) CPL_WARN_UNUSED_RESULT;
2404GDALAttributeH CPL_DLL *
2405GDALMDArrayGetAttributes(GDALMDArrayH hArray, size_t *pnCount,
2408 GDALMDArrayH hArray, const char *pszName, size_t nDimensions,
2409 const GUInt64 *panDimensions, GDALExtendedDataTypeH hEDT,
2411bool CPL_DLL GDALMDArrayDeleteAttribute(GDALMDArrayH hArray,
2412 const char *pszName,
2413 CSLConstList papszOptions);
2414bool CPL_DLL GDALMDArrayResize(GDALMDArrayH hArray,
2415 const GUInt64 *panNewDimSizes,
2416 CSLConstList papszOptions);
2417const void CPL_DLL *GDALMDArrayGetRawNoDataValue(GDALMDArrayH hArray);
2419 int *pbHasNoDataValue);
2420int64_t CPL_DLL GDALMDArrayGetNoDataValueAsInt64(GDALMDArrayH hArray,
2421 int *pbHasNoDataValue);
2422uint64_t CPL_DLL GDALMDArrayGetNoDataValueAsUInt64(GDALMDArrayH hArray,
2423 int *pbHasNoDataValue);
2424int CPL_DLL GDALMDArraySetRawNoDataValue(GDALMDArrayH hArray, const void *);
2426 double dfNoDataValue);
2428 int64_t nNoDataValue);
2430 uint64_t nNoDataValue);
2431int CPL_DLL GDALMDArraySetScale(GDALMDArrayH hArray, double dfScale);
2432int CPL_DLL GDALMDArraySetScaleEx(GDALMDArrayH hArray, double dfScale,
2433 GDALDataType eStorageType);
2434double CPL_DLL GDALMDArrayGetScale(GDALMDArrayH hArray, int *pbHasValue);
2435double CPL_DLL GDALMDArrayGetScaleEx(GDALMDArrayH hArray, int *pbHasValue,
2436 GDALDataType *peStorageType);
2437int CPL_DLL GDALMDArraySetOffset(GDALMDArrayH hArray, double dfOffset);
2438int CPL_DLL GDALMDArraySetOffsetEx(GDALMDArrayH hArray, double dfOffset,
2439 GDALDataType eStorageType);
2440double CPL_DLL GDALMDArrayGetOffset(GDALMDArrayH hArray, int *pbHasValue);
2441double CPL_DLL GDALMDArrayGetOffsetEx(GDALMDArrayH hArray, int *pbHasValue,
2442 GDALDataType *peStorageType);
2443GUInt64 CPL_DLL *GDALMDArrayGetBlockSize(GDALMDArrayH hArray, size_t *pnCount);
2444int CPL_DLL GDALMDArraySetUnit(GDALMDArrayH hArray, const char *);
2445const char CPL_DLL *GDALMDArrayGetUnit(GDALMDArrayH hArray);
2448size_t CPL_DLL *GDALMDArrayGetProcessingChunkSize(GDALMDArrayH hArray,
2449 size_t *pnCount,
2450 size_t nMaxChunkMemory);
2453 const char *pszViewExpr);
2455 size_t nNewAxisCount,
2456 const int *panMapNewAxisToOldAxis);
2459 CSLConstList papszOptions);
2461 size_t iXDim, size_t iYDim);
2463 size_t iXDim, size_t iYDim,
2464 GDALGroupH hRootGroup,
2465 CSLConstList papszOptions);
2467 GDALMDArrayH hArray, GDALDatasetH, int bApproxOK, int bForce,
2468 double *pdfMin, double *pdfMax, double *pdfMean, double *pdfStdDev,
2469 GUInt64 *pnValidCount, GDALProgressFunc pfnProgress, void *pProgressData);
2471 int bApproxOK, double *pdfMin,
2472 double *pdfMax, double *pdfMean,
2473 double *pdfStdDev,
2474 GUInt64 *pnValidCount,
2475 GDALProgressFunc, void *pProgressData);
2477 GDALMDArrayH hArray, GDALDatasetH, int bApproxOK, double *pdfMin,
2478 double *pdfMax, double *pdfMean, double *pdfStdDev, GUInt64 *pnValidCount,
2479 GDALProgressFunc, void *pProgressData, CSLConstList papszOptions);
2481 size_t nNewDimCount,
2482 const GDALDimensionH *pahNewDims,
2483 GDALRIOResampleAlg resampleAlg,
2484 OGRSpatialReferenceH hTargetSRS,
2485 CSLConstList papszOptions);
2487 GDALMDArrayH hArray, const char *pszGridOptions, GDALMDArrayH hXArray,
2488 GDALMDArrayH hYArray, CSLConstList papszOptions) CPL_WARN_UNUSED_RESULT;
2489
2490GDALMDArrayH CPL_DLL *
2492 size_t *pnCount) CPL_WARN_UNUSED_RESULT;
2493void CPL_DLL GDALReleaseArrays(GDALMDArrayH *arrays, size_t nCount);
2494int CPL_DLL GDALMDArrayCache(GDALMDArrayH hArray, CSLConstList papszOptions);
2495bool CPL_DLL GDALMDArrayRename(GDALMDArrayH hArray, const char *pszNewName);
2496
2498 GDALRATTableType eTableType, int nArrays, const GDALMDArrayH *ahArrays,
2499 const GDALRATFieldUsage *paeUsages);
2500
2501void CPL_DLL GDALAttributeRelease(GDALAttributeH hAttr);
2502void CPL_DLL GDALReleaseAttributes(GDALAttributeH *attributes, size_t nCount);
2503const char CPL_DLL *GDALAttributeGetName(GDALAttributeH hAttr);
2504const char CPL_DLL *GDALAttributeGetFullName(GDALAttributeH hAttr);
2507GUInt64 CPL_DLL *
2509 size_t *pnCount) CPL_WARN_UNUSED_RESULT;
2513 size_t *pnSize) CPL_WARN_UNUSED_RESULT;
2514void CPL_DLL GDALAttributeFreeRawResult(GDALAttributeH hAttr, GByte *raw,
2515 size_t nSize);
2516const char CPL_DLL *GDALAttributeReadAsString(GDALAttributeH hAttr);
2517int CPL_DLL GDALAttributeReadAsInt(GDALAttributeH hAttr);
2518double CPL_DLL GDALAttributeReadAsDouble(GDALAttributeH hAttr);
2519char CPL_DLL **
2521int CPL_DLL *GDALAttributeReadAsIntArray(GDALAttributeH hAttr, size_t *pnCount)
2523double CPL_DLL *
2525 size_t *pnCount) CPL_WARN_UNUSED_RESULT;
2526int CPL_DLL GDALAttributeWriteRaw(GDALAttributeH hAttr, const void *, size_t);
2527int CPL_DLL GDALAttributeWriteString(GDALAttributeH hAttr, const char *);
2529int CPL_DLL GDALAttributeWriteInt(GDALAttributeH hAttr, int);
2530int CPL_DLL GDALAttributeWriteDouble(GDALAttributeH hAttr, double);
2531int CPL_DLL GDALAttributeWriteDoubleArray(GDALAttributeH hAttr, const double *,
2532 size_t);
2533bool CPL_DLL GDALAttributeRename(GDALAttributeH hAttr, const char *pszNewName);
2534
2535void CPL_DLL GDALDimensionRelease(GDALDimensionH hDim);
2536void CPL_DLL GDALReleaseDimensions(GDALDimensionH *dims, size_t nCount);
2537const char CPL_DLL *GDALDimensionGetName(GDALDimensionH hDim);
2538const char CPL_DLL *GDALDimensionGetFullName(GDALDimensionH hDim);
2539const char CPL_DLL *GDALDimensionGetType(GDALDimensionH hDim);
2540const char CPL_DLL *GDALDimensionGetDirection(GDALDimensionH hDim);
2545 GDALMDArrayH hArray);
2546bool CPL_DLL GDALDimensionRename(GDALDimensionH hDim, const char *pszNewName);
2547
2549
2550#endif /* ndef GDAL_H_INCLUDED */
CPL error handling services.
CPLErr
Error category.
Definition: cpl_error.h:53
Definitions for CPL mini XML Parser/Serializer.
Core portability definitions for CPL.
int GPtrDiff_t
Integer type large enough to hold the difference between 2 addresses.
Definition: cpl_port.h:256
#define CPL_RESTRICT
restrict keyword to declare that pointers do not alias
Definition: cpl_port.h:1022
unsigned long long GUIntBig
Large unsigned integer type (generally 64-bit unsigned integer type).
Definition: cpl_port.h:218
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:299
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:295
GIntBig GInt64
Signed 64 bit integer type.
Definition: cpl_port.h:236
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1183
GUIntBig GUInt64
Unsigned 64 bit integer type.
Definition: cpl_port.h:238
#define CPL_WARN_UNUSED_RESULT
Qualifier to warn when the return value of a function is not used.
Definition: cpl_port.h:976
unsigned char GByte
Unsigned byte type.
Definition: cpl_port.h:185
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition: cpl_port.h:215
Virtual memory management.
struct CPLVirtualMem CPLVirtualMem
Opaque type that represents a virtual memory mapping.
Definition: cpl_virtualmem.h:62
GIntBig GSpacing
Type to express pixel, line or band spacing.
Definition: gdal.h:315
GDALRasterBandH GDALGetOverview(GDALRasterBandH, int)
Fetch overview raster band object.
Definition: gdalrasterband.cpp:2740
const char * GDALGetDriverShortName(GDALDriverH)
Return the short name of a driver.
Definition: gdaldriver.cpp:1984
CPLErr GDALDatasetCopyWholeRaster(GDALDatasetH hSrcDS, GDALDatasetH hDstDS, CSLConstList papszOptions, GDALProgressFunc pfnProgress, void *pProgressData)
Copy all dataset raster data.
Definition: rasterio.cpp:4578
void(* GDALQueryLoggerFunc)(const char *pszSQL, const char *pszError, int64_t lNumRecords, int64_t lExecutionTimeMilliseconds, void *pQueryLoggerArg)
Type of functions to pass to GDALDatasetSetQueryLoggerFunc.
Definition: gdal.h:1311
GDALRATTableType
RAT table type (thematic or athematic)
Definition: gdal.h:2030
@ GRTT_THEMATIC
Definition: gdal.h:2031
@ GRTT_ATHEMATIC
Definition: gdal.h:2032
const char * GDALEDTComponentGetName(GDALEDTComponentH hComp)
Return the name.
Definition: gdalmultidim.cpp:10639
GDALAccess
Definition: gdal.h:125
@ GA_ReadOnly
Definition: gdal.h:126
@ GA_Update
Definition: gdal.h:127
GDALDriverH GDALIdentifyDriver(const char *pszFilename, CSLConstList papszFileList)
Identify the driver that can open a dataset.
Definition: gdaldriver.cpp:2589
const char * GDALGroupGetFullName(GDALGroupH hGroup)
Return the full name of the group.
Definition: gdalmultidim.cpp:10714
void GDALSetColorEntry(GDALColorTableH, int, const GDALColorEntry *)
Set entry in color table.
Definition: gdalcolortable.cpp:242
CPLErr GDALSetRasterScale(GDALRasterBandH hBand, double dfNewOffset)
Set scaling ratio.
Definition: gdalrasterband.cpp:3098
CPLErr GDALRATSetLinearBinning(GDALRasterAttributeTableH, double, double)
Set linear binning information.
Definition: gdal_rat.cpp:507
struct GDALDimensionHS * GDALDimensionH
Opaque type for C++ GDALDimension.
Definition: gdal.h:352
OGRLayerH GDALDatasetGetLayerByName(GDALDatasetH, const char *)
Fetch a layer by name.
Definition: gdaldataset.cpp:4843
CPLErr GDALWriteBlock(GDALRasterBandH, int, int, void *)
Write a block of image data efficiently.
Definition: gdalrasterband.cpp:776
GDALDatasetH GDALCreate(GDALDriverH hDriver, const char *, int, int, int, GDALDataType, CSLConstList)
Create a new dataset with this driver.
Definition: gdaldriver.cpp:317
double GDALGetRasterNoDataValue(GDALRasterBandH, int *)
Fetch the no data value for this band.
Definition: gdalrasterband.cpp:1828
int GDALMDArraySetRawNoDataValue(GDALMDArrayH hArray, const void *)
Set the nodata value as a "raw" value.
Definition: gdalmultidim.cpp:11743
int GDALGetDataTypeSizeBits(GDALDataType eDataType)
Get data type size in bits.
Definition: gdal_misc.cpp:387
void GDALDatasetClearStatistics(GDALDatasetH hDS)
Clear statistics.
Definition: gdaldataset.cpp:9004
double GDALGetNoDataReplacementValue(GDALDataType, double)
Returns a replacement value for a nodata value or 0 if dfNoDataValue is out of range for the specifie...
Definition: gdal_misc.cpp:4962
int GDALGetRandomRasterSample(GDALRasterBandH, int, float *)
Undocumented.
Definition: gdal_misc.cpp:1154
const char * GDALRelationshipGetForwardPathLabel(GDALRelationshipH)
Get the label of the forward path for the relationship.
Definition: gdalrelationship.cpp:490
int GDALGetCacheUsed(void)
Get cache memory used.
Definition: gdalrasterblock.cpp:325
struct GDALAttributeHS * GDALAttributeH
Opaque type for C++ GDALAttribute.
Definition: gdal.h:350
int GDALRATGetRowOfValue(GDALRasterAttributeTableH, double)
Get row for pixel value.
Definition: gdal_rat.cpp:381
void GDALSetCacheMax64(GIntBig nBytes)
Set maximum cache memory.
Definition: gdalrasterblock.cpp:146
CPLVirtualMem * GDALRasterBandGetTiledVirtualMem(GDALRasterBandH hBand, GDALRWFlag eRWFlag, int nXOff, int nYOff, int nXSize, int nYSize, int nTileXSize, int nTileYSize, GDALDataType eBufType, size_t nCacheSize, int bSingleThreadUsage, CSLConstList papszOptions)
Create a CPLVirtualMem object from a GDAL rasterband object, with tiling organization.
Definition: gdalvirtualmem.cpp:1539
void GDALDeinterleave(const void *pSourceBuffer, GDALDataType eSourceDT, int nComponents, void **ppDestBuffer, GDALDataType eDestDT, size_t nIters)
Definition: rasterio.cpp:5517
GDALMDArrayH GDALRasterBandAsMDArray(GDALRasterBandH)
Return a view of this raster band as a 2D multidimensional GDALMDArray.
Definition: gdalmultidim.cpp:13178
bool GDALGroupDeleteGroup(GDALGroupH hGroup, const char *pszName, CSLConstList papszOptions)
Delete a sub-group from a group.
Definition: gdalmultidim.cpp:11094
bool GDALDatasetAddFieldDomain(GDALDatasetH hDS, OGRFieldDomainH hFieldDomain, char **ppszFailureReason)
Add a field domain to the dataset.
Definition: gdaldataset.cpp:9167
char ** GDALGetMetadata(GDALMajorObjectH, const char *)
Fetch metadata.
Definition: gdalmajorobject.cpp:263
GDALDriverH GDALGetDatasetDriver(GDALDatasetH)
Fetch the driver to which this dataset relates.
Definition: gdaldataset.cpp:1527
GDALAttributeH GDALGroupGetAttribute(GDALGroupH hGroup, const char *pszName)
Return an attribute by its name.
Definition: gdalmultidim.cpp:10976
char ** GDALDatasetGetCompressionFormats(GDALDatasetH hDS, int nXOff, int nYOff, int nXSize, int nYSize, int nBandCount, const int *panBandList)
Return the compression formats that can be natively obtained for the window of interest and requested...
Definition: gdaldataset.cpp:9863
const char * GDALDimensionGetDirection(GDALDimensionH hDim)
Return dimension direction.
Definition: gdalmultidim.cpp:13052
GDALDimensionH * GDALGroupGetDimensions(GDALGroupH hGroup, size_t *pnCount, CSLConstList papszOptions)
Return the list of dimensions contained in this group and used by its arrays.
Definition: gdalmultidim.cpp:10950
CPLVirtualMem * GDALDatasetGetTiledVirtualMem(GDALDatasetH hDS, GDALRWFlag eRWFlag, int nXOff, int nYOff, int nXSize, int nYSize, int nTileXSize, int nTileYSize, GDALDataType eBufType, int nBandCount, int *panBandMap, GDALTileOrganization eTileOrganization, size_t nCacheSize, int bSingleThreadUsage, CSLConstList papszOptions)
Create a CPLVirtualMem object from a GDAL dataset object, with tiling organization.
Definition: gdalvirtualmem.cpp:1433
void GDALRATSetValueAsDouble(GDALRasterAttributeTableH, int, int, double)
Set field value from double.
Definition: gdal_rat.cpp:1860
GDALMDArrayH GDALGroupOpenMDArray(GDALGroupH hGroup, const char *pszMDArrayName, CSLConstList papszOptions)
Open and return a multidimensional array.
Definition: gdalmultidim.cpp:10752
int GDALGetMaskFlags(GDALRasterBandH hBand)
Return the status flags of the mask band associated with the band.
Definition: gdalrasterband.cpp:7486
GDALMDArrayH GDALMDArrayGetResampled(GDALMDArrayH hArray, size_t nNewDimCount, const GDALDimensionH *pahNewDims, GDALRIOResampleAlg resampleAlg, OGRSpatialReferenceH hTargetSRS, CSLConstList papszOptions)
Return an array that is a resampled / reprojected view of the current array.
Definition: gdalmultidim.cpp:12216
CPLErr GDALSetProjection(GDALDatasetH, const char *)
Set the projection reference string for this dataset.
Definition: gdaldataset.cpp:1336
CPLErr GDALRasterBandCopyWholeRaster(GDALRasterBandH hSrcBand, GDALRasterBandH hDstBand, const char *const *constpapszOptions, GDALProgressFunc pfnProgress, void *pProgressData)
Copy a whole raster band.
Definition: rasterio.cpp:4905
GDALAsyncStatusType GDALGetAsyncStatusTypeByName(const char *)
Get AsyncStatusType by symbolic name.
Definition: gdal_misc.cpp:932
void GDALRATSetValueAsString(GDALRasterAttributeTableH, int, int, const char *)
Set field value from string.
Definition: gdal_rat.cpp:1727
void GDALRelationshipSetType(GDALRelationshipH, GDALRelationshipType)
Sets the type of the relationship.
Definition: gdalrelationship.cpp:459
GDALDatasetH GDALMDArrayAsClassicDatasetEx(GDALMDArrayH hArray, size_t iXDim, size_t iYDim, GDALGroupH hRootGroup, CSLConstList papszOptions)
Return a view of this array as a "classic" GDALDataset (ie 2D)
Definition: gdalmultidim.cpp:13238
GUInt64 GDALMDArrayGetTotalElementsCount(GDALMDArrayH hArray)
Return the total number of values in the array.
Definition: gdalmultidim.cpp:11330
void * VRTPDWorkingDataPtr
Generic pointer for the working structure of VRTProcessedDataset function.
Definition: gdal.h:1645
OGRSpatialReferenceH GDALGetSpatialRef(GDALDatasetH)
Fetch the spatial reference for this dataset.
Definition: gdaldataset.cpp:1209
void GDALSwapWordsEx(void *pData, int nWordSize, size_t nWordCount, int nWordSkip)
Byte swap words in-place.
Definition: rasterio.cpp:2076
GDALMDArrayH GDALGroupResolveMDArray(GDALGroupH hGroup, const char *pszName, const char *pszStartingPoint, CSLConstList papszOptions)
Locate an array in a group and its subgroups by name.
Definition: gdalmultidim.cpp:10798
int GDALGetOverviewCount(GDALRasterBandH)
Return the number of overview layers available.
Definition: gdalrasterband.cpp:2697
void GDALAttributeRelease(GDALAttributeH hAttr)
Release the GDAL in-memory object associated with a GDALAttribute.
Definition: gdalmultidim.cpp:12530
void GDALGetBlockSize(GDALRasterBandH, int *pnXSize, int *pnYSize)
Fetch the "natural" block size of this band.
Definition: gdalrasterband.cpp:998
GDALMDArrayH GDALMDArrayGetView(GDALMDArrayH hArray, const char *pszViewExpr)
Return a view of the array using slicing or field access.
Definition: gdalmultidim.cpp:12118
char ** GDALGetMetadataDomainList(GDALMajorObjectH hObject)
Fetch list of metadata domains.
Definition: gdalmajorobject.cpp:217
const char * GDALGetDriverCreationOptionList(GDALDriverH)
Return the list of creation options of the driver.
Definition: gdaldriver.cpp:2060
GDALPaletteInterp
Definition: gdal.h:253
@ GPI_CMYK
Definition: gdal.h:256
@ GPI_HLS
Definition: gdal.h:257
@ GPI_Gray
Definition: gdal.h:254
@ GPI_RGB
Definition: gdal.h:255
CPLErr GDALGetRasterHistogramEx(GDALRasterBandH hBand, double dfMin, double dfMax, int nBuckets, GUIntBig *panHistogram, int bIncludeOutOfRange, int bApproxOK, GDALProgressFunc pfnProgress, void *pProgressData)
Compute raster histogram.
Definition: gdalrasterband.cpp:4040
void GDALSetDescription(GDALMajorObjectH, const char *)
Set object description.
Definition: gdalmajorobject.cpp:134
struct GDALSubdatasetInfo * GDALSubdatasetInfoH
Opaque type used for the C bindings of the C++ GDALSubdatasetInfo class.
Definition: gdal.h:1344
void GDALDimensionRelease(GDALDimensionH hDim)
Release the GDAL in-memory object associated with a GDALDimension.
Definition: gdalmultidim.cpp:12997
int GDALGetRasterCount(GDALDatasetH)
Fetch the number of raster bands on this dataset.
Definition: gdaldataset.cpp:1113
GDALRasterBandH GDALGetRasterSampleOverviewEx(GDALRasterBandH, GUIntBig)
Fetch best sampling overview.
Definition: gdalrasterband.cpp:2836
size_t GDALAttributeGetDimensionCount(GDALAttributeH hAttr)
Return the number of dimensions.
Definition: gdalmultidim.cpp:12590
CPLErr GDALGetRasterStatistics(GDALRasterBandH, int bApproxOK, int bForce, double *pdfMin, double *pdfMax, double *pdfMean, double *pdfStdDev)
Fetch image statistics.
Definition: gdalrasterband.cpp:4463
CPLErr GDALRATInitializeFromColorTable(GDALRasterAttributeTableH, GDALColorTableH)
Initialize from color table.
Definition: gdal_rat.cpp:984
size_t GDALMDArrayGetDimensionCount(GDALMDArrayH hArray)
Return the number of dimensions.
Definition: gdalmultidim.cpp:11344
CPLVirtualMem * GDALGetVirtualMemAuto(GDALRasterBandH hBand, GDALRWFlag eRWFlag, int *pnPixelSpace, GIntBig *pnLineSpace, CSLConstList papszOptions)
Create a CPLVirtualMem object from a GDAL raster band object.
Definition: gdalrasterband.cpp:8022
char ** GDALGroupGetMDArrayNames(GDALGroupH hGroup, CSLConstList papszOptions)
Return the list of multidimensional array names contained in this group.
Definition: gdalmultidim.cpp:10730
GIntBig GDALGetCacheUsed64(void)
Get cache memory used.
Definition: gdalrasterblock.cpp:355
void GDALDatasetSetStyleTableDirectly(GDALDatasetH, OGRStyleTableH)
Set dataset style table.
Definition: gdaldataset.cpp:5435
GDALDataType
Definition: gdal.h:64
@ GDT_UInt32
Definition: gdal.h:70
@ GDT_UInt64
Definition: gdal.h:72
@ GDT_CInt32
Definition: gdal.h:77
@ GDT_Int64
Definition: gdal.h:73
@ GDT_Byte
Definition: gdal.h:66
@ GDT_Int8
Definition: gdal.h:67
@ GDT_CFloat32
Definition: gdal.h:79
@ GDT_CFloat64
Definition: gdal.h:80
@ GDT_Float64
Definition: gdal.h:75
@ GDT_UInt16
Definition: gdal.h:68
@ GDT_Int16
Definition: gdal.h:69
@ GDT_CInt16
Definition: gdal.h:76
@ GDT_Int32
Definition: gdal.h:71
@ GDT_Unknown
Definition: gdal.h:65
@ GDT_Float32
Definition: gdal.h:74
double GDALGetRasterOffset(GDALRasterBandH, int *pbSuccess)
Fetch the raster value offset.
Definition: gdalrasterband.cpp:2942
OGRErr GDALDatasetCommitTransaction(GDALDatasetH hDS)
For datasources which support transactions, CommitTransaction commits a transaction.
Definition: gdaldataset.cpp:8074
void * GDALDatasetH
Opaque type used for the C bindings of the C++ GDALDataset class.
Definition: gdal.h:291
int GDALHasArbitraryOverviews(GDALRasterBandH)
Check for arbitrary overviews.
Definition: gdalrasterband.cpp:2656
const GDALColorEntry * GDALGetColorEntry(GDALColorTableH, int)
Fetch a color entry from table.
Definition: gdalcolortable.cpp:132
int GDALGetAccess(GDALDatasetH hDS)
Return access flag.
Definition: gdaldataset.cpp:2982
int GDALGetRasterBandXSize(GDALRasterBandH)
Fetch XSize of raster.
Definition: gdalrasterband.cpp:3231
GDALRATFieldUsage GDALRATGetUsageOfCol(GDALRasterAttributeTableH, int)
Fetch column usage value.
Definition: gdal_rat.cpp:1333
int GDALAttributeReadAsInt(GDALAttributeH hAttr)
Return the value of an attribute as a integer.
Definition: gdalmultidim.cpp:12730
GDALExtendedDataTypeH GDALExtendedDataTypeCreate(GDALDataType eType)
Return a new GDALExtendedDataType of class GEDTC_NUMERIC.
Definition: gdalmultidim.cpp:10316
GDALRATFieldUsage
Field usage of raster attribute table.
Definition: gdal.h:2004
@ GFU_Min
Definition: gdal.h:2008
@ GFU_AlphaMin
Definition: gdal.h:2018
@ GFU_GreenMin
Definition: gdal.h:2016
@ GFU_Red
Definition: gdal.h:2011
@ GFU_Alpha
Definition: gdal.h:2014
@ GFU_MaxCount
Definition: gdal.h:2023
@ GFU_MinMax
Definition: gdal.h:2010
@ GFU_RedMin
Definition: gdal.h:2015
@ GFU_GreenMax
Definition: gdal.h:2020
@ GFU_Name
Definition: gdal.h:2007
@ GFU_BlueMax
Definition: gdal.h:2021
@ GFU_BlueMin
Definition: gdal.h:2017
@ GFU_RedMax
Definition: gdal.h:2019
@ GFU_Green
Definition: gdal.h:2012
@ GFU_Blue
Definition: gdal.h:2013
@ GFU_AlphaMax
Definition: gdal.h:2022
@ GFU_PixelCount
Definition: gdal.h:2006
@ GFU_Generic
Definition: gdal.h:2005
@ GFU_Max
Definition: gdal.h:2009
double GDALGetRasterScale(GDALRasterBandH, int *pbSuccess)
Fetch the raster value scale.
Definition: gdalrasterband.cpp:3048
int GDALGetColorEntryCount(GDALColorTableH)
Get number of color entries in table.
Definition: gdalcolortable.cpp:314
CPLErr GDALRegisterPlugin(const char *name)
Register a plugin by name, returning an error if not found.
Definition: gdalallregister.cpp:67
GDALRasterBandH GDALGetRasterBand(GDALDatasetH, int)
Fetch a band object for a dataset.
Definition: gdaldataset.cpp:1077
GDALAccess GDALGetRasterAccess(GDALRasterBandH)
Find out if we have update permission for this band.
Definition: gdalrasterband.cpp:1675
int64_t GDALMDArrayGetNoDataValueAsInt64(GDALMDArrayH hArray, int *pbHasNoDataValue)
Return the nodata value as a Int64.
Definition: gdalmultidim.cpp:11695
int GDALGeneralCmdLineProcessor(int nArgc, char ***ppapszArgv, int nOptions)
General utility option processing.
Definition: gdal_misc.cpp:3181
int GDALRATChangesAreWrittenToFile(GDALRasterAttributeTableH hRAT)
Determine whether changes made to this RAT are reflected directly in the dataset.
Definition: gdal_rat.cpp:1891
OGRSpatialReferenceH GDALGetGCPSpatialRef(GDALDatasetH)
Get output spatial reference system for GCPs.
Definition: gdaldataset.cpp:1872
const void * GDALMDArrayGetRawNoDataValue(GDALMDArrayH hArray)
Return the nodata value as a "raw" value.
Definition: gdalmultidim.cpp:11643
int GDALMDArrayWrite(GDALMDArrayH hArray, const GUInt64 *arrayStartIdx, const size_t *count, const GInt64 *arrayStep, const GPtrDiff_t *bufferStride, GDALExtendedDataTypeH bufferDatatype, const void *pSrcBuffer, const void *psrcBufferAllocStart, size_t nSrcBufferllocSize)
Write part or totality of a multidimensional array.
Definition: gdalmultidim.cpp:11457
int GDALDumpOpenDatasets(FILE *)
List open datasets.
Definition: gdaldataset.cpp:4229
void GDALExtendedDataTypeFreeComponents(GDALEDTComponentH *components, size_t nCount)
Free the return of GDALExtendedDataTypeGetComponents().
Definition: gdalmultidim.cpp:10586
const GDAL_GCP * GDALGetGCPs(GDALDatasetH)
Fetch GCPs.
Definition: gdaldataset.cpp:1927
GByte * GDALAttributeReadAsRaw(GDALAttributeH hAttr, size_t *pnSize)
Return the raw value of an attribute.
Definition: gdalmultidim.cpp:12653
size_t GDALExtendedDataTypeGetSize(GDALExtendedDataTypeH hEDT)
Return data type size in bytes.
Definition: gdalmultidim.cpp:10462
GDALDataType GDALGetRasterDataType(GDALRasterBandH)
Fetch the pixel data type for this band.
Definition: gdalrasterband.cpp:931
struct GDALEDTComponentHS * GDALEDTComponentH
Opaque type for C++ GDALEDTComponent.
Definition: gdal.h:344
GDALRasterAttributeTableH GDALCreateRasterAttributeTableFromMDArrays(GDALRATTableType eTableType, int nArrays, const GDALMDArrayH *ahArrays, const GDALRATFieldUsage *paeUsages)
Return a virtual Raster Attribute Table from several GDALMDArray's.
Definition: gdalmultidim_rat.cpp:429
int GDALExtractRPCInfoV2(CSLConstList, GDALRPCInfoV2 *)
Extract RPC info from metadata, and apply to an RPCInfo structure.
Definition: gdal_misc.cpp:3858
GDALMDArrayH GDALGroupOpenMDArrayFromFullname(GDALGroupH hGroup, const char *pszMDArrayName, CSLConstList papszOptions)
Open and return a multidimensional array from its fully qualified name.
Definition: gdalmultidim.cpp:10776
bool GDALGroupDeleteAttribute(GDALGroupH hGroup, const char *pszName, CSLConstList papszOptions)
Delete an attribute from a group.
Definition: gdalmultidim.cpp:11223
GDALColorTableH GDALCreateColorTable(GDALPaletteInterp)
Construct a new color table.
Definition: gdalcolortable.cpp:67
bool GDALIsMaskBand(GDALRasterBandH hBand)
Returns whether a band is a mask band.
Definition: gdalrasterband.cpp:7632
GDALRasterBandH GDALGetMaskBand(GDALRasterBandH hBand)
Return the mask band associated with the band.
Definition: gdalrasterband.cpp:7399
GDALAttributeH GDALMDArrayCreateAttribute(GDALMDArrayH hArray, const char *pszName, size_t nDimensions, const GUInt64 *panDimensions, GDALExtendedDataTypeH hEDT, CSLConstList papszOptions)
Create a attribute within an array.
Definition: gdalmultidim.cpp:11583
void GDALRelationshipSetMappingTableName(GDALRelationshipH, const char *)
Sets the name of the mapping table for many-to-many relationships.
Definition: gdalrelationship.cpp:215
int GDALMDArraySetNoDataValueAsInt64(GDALMDArrayH hArray, int64_t nNoDataValue)
Set the nodata value as a Int64.
Definition: gdalmultidim.cpp:11782
int GDALMDArraySetNoDataValueAsUInt64(GDALMDArrayH hArray, uint64_t nNoDataValue)
Set the nodata value as a UInt64.
Definition: gdalmultidim.cpp:11802
CPLErr GDALOverviewMagnitudeCorrection(GDALRasterBandH hBaseBand, int nOverviewCount, GDALRasterBandH *pahOverviews, GDALProgressFunc pfnProgress, void *pProgressData)
Undocumented.
Definition: overview.cpp:5695
char ** GDALGetOutputDriversForDatasetName(const char *pszDestFilename, int nFlagRasterVector, bool bSingleMatch, bool bEmitWarning)
Return a list of driver short names that are likely candidates for the provided output file name.
Definition: gdaldriver.cpp:2850
bool GDALDatasetDeleteFieldDomain(GDALDatasetH hDS, const char *pszName, char **ppszFailureReason)
Removes a field domain from the dataset.
Definition: gdaldataset.cpp:9244
void GDALReleaseDimensions(GDALDimensionH *dims, size_t nCount)
Free the return of GDALGroupGetDimensions() or GDALMDArrayGetDimensions()
Definition: gdalmultidim.cpp:11391
void GDALRATSetRowCount(GDALRasterAttributeTableH, int)
Set row count.
Definition: gdal_rat.cpp:335
GDALDatasetH GDALOpenShared(const char *, GDALAccess)
Open a raster file as a GDALDataset.
Definition: gdaldataset.cpp:4094
CPLErr GDALSetRasterNoDataValueAsInt64(GDALRasterBandH, int64_t)
Set the no data value for this band.
Definition: gdalrasterband.cpp:2098
void GDALRelationshipSetForwardPathLabel(GDALRelationshipH, const char *)
Sets the label of the forward path for the relationship.
Definition: gdalrelationship.cpp:525
const char * GDALGetDriverHelpTopic(GDALDriverH)
Return the URL to the help that describes the driver.
Definition: gdaldriver.cpp:2036
GDALDriverH GDALIdentifyDriverEx(const char *pszFilename, unsigned int nIdentifyFlags, const char *const *papszAllowedDrivers, const char *const *papszFileList)
Identify the driver that can open a dataset.
Definition: gdaldriver.cpp:2638
int GDALInvGeoTransform(const double *padfGeoTransformIn, double *padfInvGeoTransformOut)
Invert Geotransform.
Definition: gdaltransformer.cpp:4376
GDALExtendedDataTypeH GDALExtendedDataTypeCreateStringEx(size_t nMaxStringLength, GDALExtendedDataTypeSubType eSubType)
Return a new GDALExtendedDataType of class GEDTC_STRING.
Definition: gdalmultidim.cpp:10354
void GDALSwapWords(void *pData, int nWordSize, int nWordCount, int nWordSkip)
Byte swap words in-place.
Definition: rasterio.cpp:1983
void GDALRelationshipSetLeftMappingTableFields(GDALRelationshipH, CSLConstList)
Sets the names of the mapping table fields which correspond to the participating fields from the left...
Definition: gdalrelationship.cpp:396
GDALDriverH GDALGetDriver(int)
Fetch driver by index.
Definition: gdaldrivermanager.cpp:432
void GDALGroupRelease(GDALGroupH hGroup)
Release the GDAL in-memory object associated with a GDALGroupH.
Definition: gdalmultidim.cpp:10683
GDAL_GCP * GDALDuplicateGCPs(int, const GDAL_GCP *)
Duplicate an array of GCPs.
Definition: gdal_misc.cpp:1528
void GDALRATSetValueAsInt(GDALRasterAttributeTableH, int, int, int)
Set field value from integer.
Definition: gdal_rat.cpp:1794
const char * GDALMDArrayGetFullName(GDALMDArrayH hArray)
Return array full name.
Definition: gdalmultidim.cpp:11315
double GDALGetRasterMinimum(GDALRasterBandH, int *pbSuccess)
Fetch the minimum value for this band.
Definition: gdalrasterband.cpp:2429
CPLErr GDALSetRasterCategoryNames(GDALRasterBandH, CSLConstList)
Set the category names for this band.
Definition: gdalrasterband.cpp:1772
GUInt64 GDALDimensionGetSize(GDALDimensionH hDim)
Return the size, that is the number of values along the dimension.
Definition: gdalmultidim.cpp:13066
int GDALMDArraySetOffsetEx(GDALMDArrayH hArray, double dfOffset, GDALDataType eStorageType)
Set the scale value to apply to raw values.
Definition: gdalmultidim.cpp:11912
int GDALMDArrayCache(GDALMDArrayH hArray, CSLConstList papszOptions)
Cache the content of the array into an auxiliary filename.
Definition: gdalmultidim.cpp:12493
GDALDataType GDALGetNonComplexDataType(GDALDataType)
Return the base data type for the specified input.
Definition: gdal_misc.cpp:886
double GDALGetRasterMaximum(GDALRasterBandH, int *pbSuccess)
Fetch the maximum value for this band.
Definition: gdalrasterband.cpp:2323
const char * GDALDimensionGetType(GDALDimensionH hDim)
Return dimension type.
Definition: gdalmultidim.cpp:13038
CPLErr GDALRATValuesIOAsString(GDALRasterAttributeTableH hRAT, GDALRWFlag eRWFlag, int iField, int iStartRow, int iLength, char **papszStrList)
Read or Write a block of strings to/from the Attribute Table.
Definition: gdal_rat.cpp:290
const char * GDALGetDriverLongName(GDALDriverH)
Return the long name of a driver.
Definition: gdaldriver.cpp:2006
int GDALDataTypeIsComplex(GDALDataType)
Is data type complex?
Definition: gdal_misc.cpp:427
const char * GDALGetColorInterpretationName(GDALColorInterp)
Get name of color interpretation.
Definition: gdal_misc.cpp:1046
void GDALRelationshipSetRightMappingTableFields(GDALRelationshipH, CSLConstList)
Sets the names of the mapping table fields which correspond to the participating fields from the righ...
Definition: gdalrelationship.cpp:421
void GDALDestroyDriverManager(void)
Destroy the driver manager.
Definition: gdaldrivermanager.cpp:1697
CPLErr GDALRasterIOEx(GDALRasterBandH hRBand, GDALRWFlag eRWFlag, int nDSXOff, int nDSYOff, int nDSXSize, int nDSYSize, void *pBuffer, int nBXSize, int nBYSize, GDALDataType eBDataType, GSpacing nPixelSpace, GSpacing nLineSpace, GDALRasterIOExtraArg *psExtraArg)
Read/write a region of image data for this band.
Definition: gdalrasterband.cpp:474
int GDALMDArraySetUnit(GDALMDArrayH hArray, const char *)
Set the variable unit.
Definition: gdalmultidim.cpp:12258
const char * GDALRelationshipGetBackwardPathLabel(GDALRelationshipH)
Get the label of the backward path for the relationship.
Definition: gdalrelationship.cpp:558
char ** GDALDatasetGetFieldDomainNames(GDALDatasetH, CSLConstList)
Returns a list of the names of all field domains stored in the dataset.
Definition: gdaldataset.cpp:9055
int GDALValidateCreationOptions(GDALDriverH, CSLConstList papszCreationOptions)
Validate the list of creation options that are handled by a driver.
Definition: gdaldriver.cpp:2101
GDALRelationshipH GDALRelationshipCreate(const char *, const char *, const char *, GDALRelationshipCardinality)
Creates a new relationship.
Definition: gdalrelationship.cpp:66
CPLErr GDALComputeRasterMinMax(GDALRasterBandH hBand, int bApproxOK, double adfMinMax[2])
Compute the min/max values for a band.
Definition: gdalrasterband.cpp:6894
const char * GDALRelationshipGetMappingTableName(GDALRelationshipH)
Get the name of the mapping table for many-to-many relationships.
Definition: gdalrelationship.cpp:190
OGRLayerH GDALDatasetGetLayer(GDALDatasetH, int)
Fetch a layer by index.
Definition: gdaldataset.cpp:4807
CPLErr GDALRenameDataset(GDALDriverH, const char *pszNewName, const char *pszOldName)
Rename a dataset.
Definition: gdaldriver.cpp:1822
void GDALRATDumpReadable(GDALRasterAttributeTableH, FILE *)
Dump RAT in readable form.
Definition: gdal_rat.cpp:1141
CPLErr GDALSetGCPs2(GDALDatasetH, int, const GDAL_GCP *, OGRSpatialReferenceH)
Assign GCPs.
Definition: gdaldataset.cpp:2063
size_t GDALExtendedDataTypeGetMaxStringLength(GDALExtendedDataTypeH hEDT)
Return the maximum length of a string in bytes.
Definition: gdalmultidim.cpp:10478
GDALMDArrayH GDALDimensionGetIndexingVariable(GDALDimensionH hDim)
Return the variable that is used to index the dimension (if there is one).
Definition: gdalmultidim.cpp:13085
char ** GDALGroupGetGroupNames(GDALGroupH hGroup, CSLConstList papszOptions)
Return the list of sub-groups contained in this group.
Definition: gdalmultidim.cpp:10822
OGRErr GDALDatasetRollbackTransaction(GDALDatasetH hDS)
For datasources which support transactions, RollbackTransaction will roll back a datasource to its st...
Definition: gdaldataset.cpp:8126
int GDALAttributeWriteDouble(GDALAttributeH hAttr, double)
Write an attribute from a double value.
Definition: gdalmultidim.cpp:12912
int GDALGetRasterXSize(GDALDatasetH)
Fetch raster width in pixels.
Definition: gdaldataset.cpp:949
void * GDALRATSerializeJSON(GDALRasterAttributeTableH)
Serialize Raster Attribute Table in Json format.
Definition: gdal_rat.cpp:2191
void GDALRegisterPlugins(void)
Register drivers and support code available as a plugin.
Definition: gdalallregister.cpp:94
const char * GDALAttributeReadAsString(GDALAttributeH hAttr)
Return the value of an attribute as a string.
Definition: gdalmultidim.cpp:12710
CSLConstList GDALGroupGetStructuralInfo(GDALGroupH hGroup)
Return structural information on the group.
Definition: gdalmultidim.cpp:11034
GDALExtendedDataTypeClass
Enumeration giving the class of a GDALExtendedDataType.
Definition: gdal.h:321
@ GEDTC_STRING
String value.
Definition: gdal.h:325
@ GEDTC_COMPOUND
Compound data type.
Definition: gdal.h:327
@ GEDTC_NUMERIC
Numeric value.
Definition: gdal.h:323
bool GDALDatasetUpdateFieldDomain(GDALDatasetH hDS, OGRFieldDomainH hFieldDomain, char **ppszFailureReason)
Updates an existing field domain by replacing its definition.
Definition: gdaldataset.cpp:9317
CPLErr GDALDeleteRasterNoDataValue(GDALRasterBandH)
Remove the no data value for this band.
Definition: gdalrasterband.cpp:2218
CPLErr GDALSetMetadataItem(GDALMajorObjectH, const char *, const char *, const char *)
Set single metadata item.
Definition: gdalmajorobject.cpp:411
GDALDataType GDALFindDataTypeForValue(double dValue, int bComplex)
Finds the smallest data type able to support the provided value.
Definition: gdal_misc.cpp:314
GDALGroupH GDALGroupOpenGroup(GDALGroupH hGroup, const char *pszSubGroupName, CSLConstList papszOptions)
Open and return a sub-group.
Definition: gdalmultidim.cpp:10844
OGRFeatureH GDALDatasetGetNextFeature(GDALDatasetH hDS, OGRLayerH *phBelongingLayer, double *pdfProgressPct, GDALProgressFunc pfnProgress, void *pProgressData)
Fetch the next available feature from this dataset.
Definition: gdaldataset.cpp:7794
OGRErr GDALDatasetStartTransaction(GDALDatasetH hDS, int bForce)
For datasources which support transactions, StartTransaction creates a transaction.
Definition: gdaldataset.cpp:8016
CPLErr(* GDALDerivedPixelFuncWithArgs)(void **papoSources, int nSources, void *pData, int nBufXSize, int nBufYSize, GDALDataType eSrcType, GDALDataType eBufType, int nPixelSpace, int nLineSpace, CSLConstList papszFunctionArgs)
Type of functions to pass to GDALAddDerivedBandPixelFuncWithArgs.
Definition: gdal.h:1479
GDALDatasetH GDALCreatePansharpenedVRT(const char *pszXML, GDALRasterBandH hPanchroBand, int nInputSpectralBands, GDALRasterBandH *pahInputSpectralBands)
Create a virtual pansharpened dataset.
Definition: vrtpansharpened.cpp:94
int GDALGetDataCoverageStatus(GDALRasterBandH hBand, int nXOff, int nYOff, int nXSize, int nYSize, int nMaskFlagStop, double *pdfDataPct)
Get the coverage status of a sub-window of the raster.
Definition: gdalrasterband.cpp:8116
GDALGroupH GDALGroupCreateGroup(GDALGroupH hGroup, const char *pszSubGroupName, CSLConstList papszOptions)
Create a sub-group within a group.
Definition: gdalmultidim.cpp:11068
const char * GDALGetPaletteInterpretationName(GDALPaletteInterp)
Get name of palette interpretation.
Definition: gdal_misc.cpp:1006
const char * GDALGetAsyncStatusTypeName(GDALAsyncStatusType)
Get name of AsyncStatus data type.
Definition: gdal_misc.cpp:968
int GDALRATGetLinearBinning(GDALRasterAttributeTableH, double *, double *)
Get linear binning information.
Definition: gdal_rat.cpp:550
GDALAsyncStatusType GDALARGetNextUpdatedRegion(GDALAsyncReaderH hARIO, double dfTimeout, int *pnXBufOff, int *pnYBufOff, int *pnXBufSize, int *pnYBufSize)
Get async IO update.
Definition: gdaldefaultasync.cpp:161
uint64_t GDALGetRasterNoDataValueAsUInt64(GDALRasterBandH, int *)
Fetch the no data value for this band.
Definition: gdalrasterband.cpp:1949
CPLErr GDALGetDefaultHistogramEx(GDALRasterBandH hBand, double *pdfMin, double *pdfMax, int *pnBuckets, GUIntBig **ppanHistogram, int bForce, GDALProgressFunc pfnProgress, void *pProgressData)
Fetch default raster histogram.
Definition: gdalrasterband.cpp:4240
CPLErr GDALAddBand(GDALDatasetH hDS, GDALDataType eType, CSLConstList papszOptions)
Add a band to a dataset.
Definition: gdaldataset.cpp:821
void GDALAttributeFreeRawResult(GDALAttributeH hAttr, GByte *raw, size_t nSize)
Free the return of GDALAttributeAsRaw()
Definition: gdalmultidim.cpp:12674
CPLErr GDALSetDefaultHistogram(GDALRasterBandH hBand, double dfMin, double dfMax, int nBuckets, int *panHistogram)
Set default histogram.
Definition: gdalrasterband.cpp:6942
GDALRelationshipCardinality GDALRelationshipGetCardinality(GDALRelationshipH)
Get the cardinality of the relationship.
Definition: gdalrelationship.cpp:126
char ** GDALRelationshipGetLeftTableFields(GDALRelationshipH)
Get the names of the participating fields from the left table in the relationship.
Definition: gdalrelationship.cpp:238
GUInt64 GDALAttributeGetTotalElementsCount(GDALAttributeH hAttr)
Return the total number of values in the attribute.
Definition: gdalmultidim.cpp:12576
void GDALApplyGeoTransform(const double *, double, double, double *, double *)
Apply GeoTransform to x/y coordinate.
Definition: gdaltransformer.cpp:4350
CPLErr GDALDatasetReadCompressedData(GDALDatasetH hDS, const char *pszFormat, int nXOff, int nYOff, int nXSize, int nYSize, int nBandCount, const int *panBandList, void **ppBuffer, size_t *pnBufferSize, char **ppszDetailedFormat)
Return the compressed content that can be natively obtained for the window of interest and requested ...
Definition: gdaldataset.cpp:10118
int GDALMDArrayComputeStatisticsEx(GDALMDArrayH hArray, GDALDatasetH, int bApproxOK, double *pdfMin, double *pdfMax, double *pdfMean, double *pdfStdDev, GUInt64 *pnValidCount, GDALProgressFunc, void *pProgressData, CSLConstList papszOptions)
Compute statistics.
Definition: gdalmultidim.cpp:12387
GDALColorTableH GDALCloneColorTable(GDALColorTableH)
Make a copy of a color table.
Definition: gdalcolortable.cpp:277
GDALRelationshipCardinality
Cardinality of relationship.
Definition: gdal.h:2116
@ GRC_ONE_TO_ONE
One-to-one.
Definition: gdal.h:2118
@ GRC_MANY_TO_ONE
Many-to-one.
Definition: gdal.h:2122
@ GRC_MANY_TO_MANY
Many-to-many.
Definition: gdal.h:2124
@ GRC_ONE_TO_MANY
One-to-many.
Definition: gdal.h:2120
GDALRIOResampleAlg
RasterIO() resampling method.
Definition: gdal.h:143
@ GRIORA_Mode
Definition: gdal.h:152
@ GRIORA_Lanczos
Definition: gdal.h:148
@ GRIORA_Cubic
Definition: gdal.h:146
@ GRIORA_CubicSpline
Definition: gdal.h:147
@ GRIORA_Average
Definition: gdal.h:149
@ GRIORA_RMS
RMS: Root Mean Square / Quadratic Mean.
Definition: gdal.h:163
@ GRIORA_NearestNeighbour
Definition: gdal.h:144
@ GRIORA_Gauss
Definition: gdal.h:153
@ GRIORA_Bilinear
Definition: gdal.h:145
CPLErr GDALSetRasterUnitType(GDALRasterBandH hBand, const char *pszNewValue)
Set unit type.
Definition: gdalrasterband.cpp:3193
GDALExtendedDataTypeSubType GDALExtendedDataTypeGetSubType(GDALExtendedDataTypeH hEDT)
Return the subtype of a type.
Definition: gdalmultidim.cpp:10537
bool GDALDatasetAddRelationship(GDALDatasetH hDS, GDALRelationshipH hRelationship, char **ppszFailureReason)
Add a relationship to the dataset.
Definition: gdaldataset.cpp:9492
GDALExtendedDataTypeH GDALEDTComponentGetType(GDALEDTComponentH hComp)
Return the data type of the component.
Definition: gdalmultidim.cpp:10667
char ** GDALGetRasterCategoryNames(GDALRasterBandH)
Fetch the list of category names for this raster.
Definition: gdalrasterband.cpp:1721
GDALGroupH GDALGroupOpenGroupFromFullname(GDALGroupH hGroup, const char *pszMDArrayName, CSLConstList papszOptions)
Open and return a sub-group from its fully qualified name.
Definition: gdalmultidim.cpp:10917
void GDALRelationshipSetLeftTableFields(GDALRelationshipH, CSLConstList)
Sets the names of the participating fields from the left table in the relationship.
Definition: gdalrelationship.cpp:292
int GDALWriteWorldFile(const char *, const char *, double *)
Write ESRI world file.
Definition: gdal_misc.cpp:2410
int GDALDataTypeIsInteger(GDALDataType)
Is data type integer? (might be complex)
Definition: gdal_misc.cpp:510
CPLErr GDALRATCreateColumn(GDALRasterAttributeTableH, const char *, GDALRATFieldType, GDALRATFieldUsage)
Create new column.
Definition: gdal_rat.cpp:460
int GDALDimensionSetIndexingVariable(GDALDimensionH hDim, GDALMDArrayH hArray)
Set the variable that is used to index the dimension.
Definition: gdalmultidim.cpp:13107
bool GDALDatasetDeleteRelationship(GDALDatasetH hDS, const char *pszName, char **ppszFailureReason)
Removes a relationship from the dataset.
Definition: gdaldataset.cpp:9561
OGRErr GDALDatasetDeleteLayer(GDALDatasetH, int)
Delete the indicated layer from the datasource.
Definition: gdaldataset.cpp:4908
bool GDALDimensionRename(GDALDimensionH hDim, const char *pszNewName)
Rename the dimension.
Definition: gdalmultidim.cpp:13129
OGRSpatialReferenceH GDALMDArrayGetSpatialRef(GDALMDArrayH hArray)
Return the spatial reference system object associated with the array.
Definition: gdalmultidim.cpp:12315
int GDALCheckVersion(int nVersionMajor, int nVersionMinor, const char *pszCallingComponentName)
Return TRUE if GDAL library version at runtime matches nVersionMajor.nVersionMinor.
Definition: gdal_misc.cpp:2647
GDALEDTComponentH GDALEDTComponentCreate(const char *pszName, size_t nOffset, GDALExtendedDataTypeH hType)
Create a new GDALEDTComponent.
Definition: gdalmultidim.cpp:10606
GDALAttributeH GDALMDArrayGetAttribute(GDALMDArrayH hArray, const char *pszName)
Return an attribute by its name.
Definition: gdalmultidim.cpp:11528
char ** GDALAttributeReadAsStringArray(GDALAttributeH hAttr)
Return the value of an attribute as an array of strings.
Definition: gdalmultidim.cpp:12766
GDALDatasetH GDALGetBandDataset(GDALRasterBandH)
Fetch the owning dataset handle.
Definition: gdalrasterband.cpp:3351
CPLErr GDALDatasetAdviseRead(GDALDatasetH hDS, int nDSXOff, int nDSYOff, int nDSXSize, int nDSYSize, int nBXSize, int nBYSize, GDALDataType eBDataType, int nBandCount, int *panBandCount, CSLConstList papszOptions)
Advise driver of upcoming read requests.
Definition: gdaldataset.cpp:3087
GDALDatasetH OGR_L_GetDataset(OGRLayerH hLayer)
Return the dataset associated with this layer.
Definition: ogrlayer.cpp:5730
GDALExtendedDataTypeH GDALAttributeGetDataType(GDALAttributeH hAttr)
Return the data type.
Definition: gdalmultidim.cpp:12631
void GDALRelationshipSetRelatedTableType(GDALRelationshipH, const char *)
Sets the type string of the related table.
Definition: gdalrelationship.cpp:649
int GDALLoadTabFile(const char *, double *, char **, int *, GDAL_GCP **)
Helper function for translator implementer wanting support for MapInfo .tab files.
Definition: gdal_misc.cpp:1898
int GDALGetRasterBandYSize(GDALRasterBandH)
Fetch YSize of raster.
Definition: gdalrasterband.cpp:3268
void GDALARUnlockBuffer(GDALAsyncReaderH hARIO)
Unlock image buffer.
Definition: gdaldefaultasync.cpp:255
CPLErr GDALSetRasterNoDataValue(GDALRasterBandH, double)
Set the no data value for this band.
Definition: gdalrasterband.cpp:2026
CPLErr GDALDatasetRasterIO(GDALDatasetH hDS, GDALRWFlag eRWFlag, int nDSXOff, int nDSYOff, int nDSXSize, int nDSYSize, void *pBuffer, int nBXSize, int nBYSize, GDALDataType eBDataType, int nBandCount, int *panBandCount, int nPixelSpace, int nLineSpace, int nBandSpace)
Read/write a region of image data from multiple bands.
Definition: gdaldataset.cpp:2852
int GDALExtendedDataTypeCanConvertTo(GDALExtendedDataTypeH hSourceEDT, GDALExtendedDataTypeH hTargetEDT)
Return whether this data type can be converted to the other one.
Definition: gdalmultidim.cpp:10496
int GDALRATGetValueAsInt(GDALRasterAttributeTableH, int, int)
Fetch field value as a integer.
Definition: gdal_rat.cpp:1564
const char * GDALDecToDMS(double, const char *, int)
Translate a decimal degrees value to a DMS string with hemisphere.
Definition: gdal_misc.cpp:2671
GDALDataType GDALExtendedDataTypeGetNumericDataType(GDALExtendedDataTypeH hEDT)
Return numeric data type (only valid when GetClass() == GEDTC_NUMERIC)
Definition: gdalmultidim.cpp:10448
void GDALDeregisterDriver(GDALDriverH)
Deregister the passed driver.
Definition: gdaldrivermanager.cpp:641
CPLErr GDALCopyDatasetFiles(GDALDriverH, const char *pszNewName, const char *pszOldName)
Copy the files of a dataset.
Definition: gdaldriver.cpp:1949
CPLErr GDALGetDefaultHistogram(GDALRasterBandH hBand, double *pdfMin, double *pdfMax, int *pnBuckets, int **ppanHistogram, int bForce, GDALProgressFunc pfnProgress, void *pProgressData)
Fetch default raster histogram.
Definition: gdalrasterband.cpp:4170
OGRErr GDALDatasetAbortSQL(GDALDatasetH)
Abort any SQL statement running in the data store.
Definition: gdaldataset.cpp:5383
void GDALDestroyRasterAttributeTable(GDALRasterAttributeTableH)
Destroys a RAT.
Definition: gdal_rat.cpp:1205
CPLErr GDALCreateDatasetMaskBand(GDALDatasetH hDS, int nFlags)
Adds a mask band to the dataset.
Definition: gdaldataset.cpp:3384
int GDALAttributeWriteString(GDALAttributeH hAttr, const char *)
Write an attribute from a string value.
Definition: gdalmultidim.cpp:12869
int GDALMDArraySetScale(GDALMDArrayH hArray, double dfScale)
Set the scale value to apply to raw values.
Definition: gdalmultidim.cpp:11855
CPLErr GDALGetActualBlockSize(GDALRasterBandH, int nXBlockOff, int nYBlockOff, int *pnXValid, int *pnYValid)
Retrieve the actual block size for a given block offset.
Definition: gdalrasterband.cpp:852
CPLVirtualMem * GDALRasterBandGetVirtualMem(GDALRasterBandH hBand, GDALRWFlag eRWFlag, int nXOff, int nYOff, int nXSize, int nYSize, int nBufXSize, int nBufYSize, GDALDataType eBufType, int nPixelSpace, GIntBig nLineSpace, size_t nCacheSize, size_t nPageSizeHint, int bSingleThreadUsage, CSLConstList papszOptions)
Create a CPLVirtualMem object from a GDAL raster band object.
Definition: gdalvirtualmem.cpp:1016
CPLErr GDALClose(GDALDatasetH)
Close GDAL dataset.
Definition: gdaldataset.cpp:4123
GDALAsyncReaderH GDALBeginAsyncReader(GDALDatasetH hDS, int nXOff, int nYOff, int nXSize, int nYSize, void *pBuf, int nBufXSize, int nBufYSize, GDALDataType eBufType, int nBandCount, int *panBandMap, int nPixelSpace, int nLineSpace, int nBandSpace, CSLConstList papszOptions)
Sets up an asynchronous data request.
Definition: gdaldataset.cpp:4425
char ** GDALRelationshipGetRightTableFields(GDALRelationshipH)
Get the names of the participating fields from the right table in the relationship.
Definition: gdalrelationship.cpp:264
CPLErr GDALSetDefaultHistogramEx(GDALRasterBandH hBand, double dfMin, double dfMax, int nBuckets, GUIntBig *panHistogram)
Set default histogram.
Definition: gdalrasterband.cpp:6985
OGRLayerH GDALDatasetCreateLayer(GDALDatasetH, const char *, OGRSpatialReferenceH, OGRwkbGeometryType, CSLConstList)
This function attempts to create a new layer on the dataset with the indicated name,...
Definition: gdaldataset.cpp:5161
const char * GDALAttributeGetFullName(GDALAttributeH hAttr)
Return the full name of the attribute.
Definition: gdalmultidim.cpp:12561
GDALRelationshipH GDALDatasetGetRelationship(GDALDatasetH hDS, const char *pszName)
Get a relationship from its name.
Definition: gdaldataset.cpp:9414
GDALRATFieldType
Field type of raster attribute table.
Definition: gdal.h:1996
@ GFT_Real
Definition: gdal.h:1998
@ GFT_String
Definition: gdal.h:1999
@ GFT_Integer
Definition: gdal.h:1997
void GDALDatasetResetReading(GDALDatasetH)
Reset feature reading to start on the first feature.
Definition: gdaldataset.cpp:7566
struct GDALMDArrayHS * GDALMDArrayH
Opaque type for C++ GDALMDArray.
Definition: gdal.h:348
const char * GDALMDArrayGetUnit(GDALMDArrayH hArray)
Return the array unit.
Definition: gdalmultidim.cpp:12283
int GDALAttributeWriteDoubleArray(GDALAttributeH hAttr, const double *, size_t)
Write an attribute from an array of double.
Definition: gdalmultidim.cpp:12959
void * GDALRelationshipH
Opaque type used for the C bindings of the C++ GDALRelationship class.
Definition: gdal.h:312
bool GDALGroupDeleteMDArray(GDALGroupH hGroup, const char *pszName, CSLConstList papszOptions)
Delete an array from a group.
Definition: gdalmultidim.cpp:11172
CPLErr(* GDALVRTProcessedDatasetFuncInit)(const char *pszFuncName, void *pUserData, CSLConstList papszFunctionArgs, int nInBands, GDALDataType eInDT, double *padfInNoData, int *pnOutBands, GDALDataType *peOutDT, double **ppadfOutNoData, const char *pszVRTPath, VRTPDWorkingDataPtr *ppWorkingData)
Initialization function to pass to GDALVRTRegisterProcessedDatasetFunc.
Definition: gdal.h:1685
char * GDALSubdatasetInfoGetPathComponent(GDALSubdatasetInfoH hInfo)
Returns the file path component of a subdataset descriptor effectively stripping the information abou...
Definition: gdalsubdatasetinfo.cpp:85
void * GDALRasterAttributeTableH
Opaque type used for the C bindings of the C++ GDALRasterAttributeTable class.
Definition: gdal.h:304
void GDALRATRemoveStatistics(GDALRasterAttributeTableH)
Remove Statistics from RAT.
Definition: gdal_rat.cpp:2211
const char * GDALDimensionGetName(GDALDimensionH hDim)
Return dimension name.
Definition: gdalmultidim.cpp:13010
const char * GDALGetGCPProjection(GDALDatasetH)
Get output projection for GCPs.
Definition: gdaldataset.cpp:1891
GDALDataType GDALDataTypeUnion(GDALDataType, GDALDataType)
Return the smallest data type that can fully express both input data types.
Definition: gdal_misc.cpp:139
GDALColorInterp GDALGetColorInterpretationByName(const char *pszName)
Get color interpretation by symbolic name.
Definition: gdal_misc.cpp:1125
OGRLayerH GDALGroupOpenVectorLayer(GDALGroupH hGroup, const char *pszVectorLayerName, CSLConstList papszOptions)
Open and return a vector layer.
Definition: gdalmultidim.cpp:10895
int GDALMDArrayRead(GDALMDArrayH hArray, const GUInt64 *arrayStartIdx, const size_t *count, const GInt64 *arrayStep, const GPtrDiff_t *bufferStride, GDALExtendedDataTypeH bufferDatatype, void *pDstBuffer, const void *pDstBufferAllocStart, size_t nDstBufferllocSize)
Read part or totality of a multidimensional array.
Definition: gdalmultidim.cpp:11425
int GDALGetColorEntryAsRGB(GDALColorTableH, int, GDALColorEntry *)
Fetch a table entry in RGB format.
Definition: gdalcolortable.cpp:182
char ** GDALGetFileList(GDALDatasetH)
Fetch files forming dataset.
Definition: gdaldataset.cpp:3310
const char * GDALRelationshipGetRightTableName(GDALRelationshipH)
Get the name of the right (or related/destination) table in the relationship.
Definition: gdalrelationship.cpp:166
char ** GDALDatasetGetRelationshipNames(GDALDatasetH, CSLConstList)
Returns a list of the names of all relationships stored in the dataset.
Definition: gdaldataset.cpp:9371
const char * GDALVersionInfo(const char *)
Get runtime version information.
Definition: gdal_misc.cpp:2477
int GDALAttributeWriteRaw(GDALAttributeH hAttr, const void *, size_t)
Write an attribute from raw values expressed in GetDataType()
Definition: gdalmultidim.cpp:12847
int GDALDatasetGetLayerCount(GDALDatasetH)
Get the number of layers in this dataset.
Definition: gdaldataset.cpp:4774
CPLErr GDALSetMetadata(GDALMajorObjectH, CSLConstList, const char *)
Set metadata.
Definition: gdalmajorobject.cpp:315
CPLErr GDALRasterAdviseRead(GDALRasterBandH hRB, int nDSXOff, int nDSYOff, int nDSXSize, int nDSYSize, int nBXSize, int nBYSize, GDALDataType eBDataType, CSLConstList papszOptions)
Advise driver of upcoming read requests.
Definition: gdalrasterband.cpp:4323
int GDALDatasetTestCapability(GDALDatasetH, const char *)
Test if capability is available.
Definition: gdaldataset.cpp:7898
const char * GDALDimensionGetFullName(GDALDimensionH hDim)
Return dimension full name.
Definition: gdalmultidim.cpp:13024
void * GDALAsyncReaderH
Opaque type used for the C bindings of the C++ GDALAsyncReader class.
Definition: gdal.h:307
CPLXMLNode * GDALGetJPEG2000Structure(const char *pszFilename, CSLConstList papszOptions)
Dump the structure of a JPEG2000 file as a XML tree.
Definition: gdaljp2structure.cpp:2362
double GDALAdjustValueToDataType(GDALDataType eDT, double dfValue, int *pbClamped, int *pbRounded)
Adjust a value to the output data type.
Definition: gdal_misc.cpp:796
void GDALEndAsyncReader(GDALDatasetH hDS, GDALAsyncReaderH hAsynchReaderH)
End asynchronous request.
Definition: gdaldataset.cpp:4476
CPLErr GDALCreateMaskBand(GDALRasterBandH hBand, int nFlags)
Adds a mask band to the current band.
Definition: gdalrasterband.cpp:7573
GDALAttributeH GDALGroupCreateAttribute(GDALGroupH hGroup, const char *pszName, size_t nDimensions, const GUInt64 *panDimensions, GDALExtendedDataTypeH hEDT, CSLConstList papszOptions)
Create a attribute within a group.
Definition: gdalmultidim.cpp:11190
int GDALDatasetIsLayerPrivate(GDALDatasetH, int)
Returns true if the layer at the specified index is deemed a private or system table,...
Definition: gdaldataset.cpp:4877
int GDALGetDataTypeSizeBytes(GDALDataType)
Get data type size in bytes.
Definition: gdal_misc.cpp:337
GDALMDArrayH * GDALMDArrayGetCoordinateVariables(GDALMDArrayH hArray, size_t *pnCount)
Return coordinate variables.
Definition: gdalmultidim.cpp:12419
const char * GDALAttributeGetName(GDALAttributeH hAttr)
Return the name of the attribute.
Definition: gdalmultidim.cpp:12545
CPLErr GDALDeleteDataset(GDALDriverH, const char *)
Delete named dataset.
Definition: gdaldriver.cpp:1690
GDALSubdatasetInfoH GDALGetSubdatasetInfo(const char *pszFileName)
Returns a new GDALSubdatasetInfo object with methods to extract and manipulate subdataset information...
Definition: gdalsubdatasetinfo.cpp:38
const char * GDALExtendedDataTypeGetName(GDALExtendedDataTypeH hEDT)
Return type name.
Definition: gdalmultidim.cpp:10419
void GDALExtendedDataTypeRelease(GDALExtendedDataTypeH hEDT)
Release the GDAL in-memory object associated with a GDALExtendedDataTypeH.
Definition: gdalmultidim.cpp:10406
bool GDALGroupRename(GDALGroupH hGroup, const char *pszNewName)
Rename the group.
Definition: gdalmultidim.cpp:11247
GDALMDArrayH GDALMDArrayTranspose(GDALMDArrayH hArray, size_t nNewAxisCount, const int *panMapNewAxisToOldAxis)
Return a view of the array whose axis have been reordered.
Definition: gdalmultidim.cpp:12138
bool GDALAttributeRename(GDALAttributeH hAttr, const char *pszNewName)
Rename the attribute.
Definition: gdalmultidim.cpp:12981
double GDALRATGetValueAsDouble(GDALRasterAttributeTableH, int, int)
Fetch field value as a double.
Definition: gdal_rat.cpp:1622
GDALGroupH GDALDatasetGetRootGroup(GDALDatasetH hDS)
Return the root GDALGroup of this dataset.
Definition: gdalmultidim.cpp:13150
GDALDatasetH GDALOpenEx(const char *pszFilename, unsigned int nOpenFlags, const char *const *papszAllowedDrivers, const char *const *papszOpenOptions, const char *const *papszSiblingFiles)
Open a raster or vector file as a GDALDataset.
Definition: gdaldataset.cpp:3577
const char * GDALGetDataTypeName(GDALDataType)
Get name of data type.
Definition: gdal_misc.cpp:663
void GDALAllRegister(void)
Register all known configured GDAL drivers.
Definition: gdalallregister.cpp:127
GDALRATFieldType GDALRATGetTypeOfCol(GDALRasterAttributeTableH, int)
Fetch column type.
Definition: gdal_rat.cpp:1373
CPLErr GDALDatasetRasterIOEx(GDALDatasetH hDS, GDALRWFlag eRWFlag, int nDSXOff, int nDSYOff, int nDSXSize, int nDSYSize, void *pBuffer, int nBXSize, int nBYSize, GDALDataType eBDataType, int nBandCount, int *panBandCount, GSpacing nPixelSpace, GSpacing nLineSpace, GSpacing nBandSpace, GDALRasterIOExtraArg *psExtraArg)
Read/write a region of image data from multiple bands.
Definition: gdaldataset.cpp:2882
double GDALMDArrayGetOffset(GDALMDArrayH hArray, int *pbHasValue)
Get the scale value to apply to raw values.
Definition: gdalmultidim.cpp:11977
void GDALReleaseArrays(GDALMDArrayH *arrays, size_t nCount)
Free the return of GDALMDArrayGetCoordinateVariables()
Definition: gdalmultidim.cpp:12472
GDALMDArrayH GDALMDArrayGetMask(GDALMDArrayH hArray, CSLConstList papszOptions)
Return an array that is a mask for the current array.
Definition: gdalmultidim.cpp:12192
const char * GDALGetDescription(GDALMajorObjectH)
Fetch object description.
Definition: gdalmajorobject.cpp:93
GDALGroupH GDALGroupSubsetDimensionFromSelection(GDALGroupH hGroup, const char *pszSelection, CSLConstList papszOptions)
Return a virtual group whose one dimension has been subset according to a selection.
Definition: gdalmultidim.cpp:11266
double * GDALAttributeReadAsDoubleArray(GDALAttributeH hAttr, size_t *pnCount)
Return the value of an attribute as an array of doubles.
Definition: gdalmultidim.cpp:12812
uint64_t GDALMDArrayGetNoDataValueAsUInt64(GDALMDArrayH hArray, int *pbHasNoDataValue)
Return the nodata value as a UInt64.
Definition: gdalmultidim.cpp:11721
int GDALGetDriverCount(void)
Fetch the number of registered drivers.
Definition: gdaldrivermanager.cpp:380
CPLErr GDALBuildOverviewsEx(GDALDatasetH, const char *, int, const int *, int, const int *, GDALProgressFunc, void *, CSLConstList papszOptions)
Build raster overview(s)
Definition: gdaldataset.cpp:2201
GDALExtendedDataTypeSubType
Enumeration giving the subtype of a GDALExtendedDataType.
Definition: gdal.h:334
@ GEDTST_JSON
JSon.
Definition: gdal.h:338
@ GEDTST_NONE
None.
Definition: gdal.h:336
GDALEDTComponentH * GDALExtendedDataTypeGetComponents(GDALExtendedDataTypeH hEDT, size_t *pnCount)
Return the components of the data type (only valid when GetClass() == GEDTC_COMPOUND)
Definition: gdalmultidim.cpp:10561
bool GDALMDArrayResize(GDALMDArrayH hArray, const GUInt64 *panNewDimSizes, CSLConstList papszOptions)
Resize an array to new dimensions.
Definition: gdalmultidim.cpp:11830
void GDALDestroyColorTable(GDALColorTableH)
Destroys a color table.
Definition: gdalcolortable.cpp:94
int GDALLoadOziMapFile(const char *, double *, char **, int *, GDAL_GCP **)
Helper function for translator implementer wanting support for OZI .map.
Definition: gdal_misc.cpp:1643
CPLErr GDALAddDerivedBandPixelFuncWithArgs(const char *pszName, GDALDerivedPixelFuncWithArgs pfnPixelFunc, const char *pszMetadata)
This adds a pixel function to the global list of available pixel functions for derived bands.
Definition: vrtderivedrasterband.cpp:308
void GDALDestroyRelationship(GDALRelationshipH)
Destroys a relationship.
Definition: gdalrelationship.cpp:88
GDALDatasetH GDALMDArrayAsClassicDataset(GDALMDArrayH hArray, size_t iXDim, size_t iYDim)
Return a view of this array as a "classic" GDALDataset (ie 2D)
Definition: gdalmultidim.cpp:13207
CPLErr GDALComputeRasterStatistics(GDALRasterBandH, int bApproxOK, double *pdfMin, double *pdfMax, double *pdfMean, double *pdfStdDev, GDALProgressFunc pfnProgress, void *pProgressData)
Compute image statistics.
Definition: gdalrasterband.cpp:6221
int * GDALAttributeReadAsIntArray(GDALAttributeH hAttr, size_t *pnCount)
Return the value of an attribute as an array of integers.
Definition: gdalmultidim.cpp:12784
int GDALAttributeWriteStringArray(GDALAttributeH hAttr, CSLConstList)
Write an attribute from an array of strings.
Definition: gdalmultidim.cpp:12934
CPLErr GDALMDArrayGetStatistics(GDALMDArrayH hArray, GDALDatasetH, int bApproxOK, int bForce, double *pdfMin, double *pdfMax, double *pdfMean, double *pdfStdDev, GUInt64 *pnValidCount, GDALProgressFunc pfnProgress, void *pProgressData)
Fetch statistics.
Definition: gdalmultidim.cpp:12334
int GDALReadOziMapFile(const char *, double *, char **, int *, GDAL_GCP **)
Helper function for translator implementer wanting support for OZI .map.
Definition: gdal_misc.cpp:1852
CPLErr GDALRATSetTableType(GDALRasterAttributeTableH hRAT, const GDALRATTableType eInTableType)
Set RAT Table Type.
Definition: gdal_rat.cpp:591
OGRLayerH GDALDatasetExecuteSQL(GDALDatasetH, const char *, OGRGeometryH, const char *)
Execute an SQL statement against the data store.
Definition: gdaldataset.cpp:5338
CPLErr GDALVRTRegisterProcessedDatasetFunc(const char *pszFuncName, void *pUserData, const char *pszXMLMetadata, GDALDataType eRequestedInputDT, const GDALDataType *paeSupportedInputDT, size_t nSupportedInputDTSize, const int *panSupportedInputBandCount, size_t nSupportedInputBandCountSize, GDALVRTProcessedDatasetFuncInit pfnInit, GDALVRTProcessedDatasetFuncFree pfnFree, GDALVRTProcessedDatasetFuncProcess pfnProcess, CSLConstList papszOptions)
Register a function to be used by VRTProcessedDataset.
Definition: vrtprocesseddataset.cpp:1184
CPLErr GDALSetRasterOffset(GDALRasterBandH hBand, double dfNewOffset)
Set scaling offset.
Definition: gdalrasterband.cpp:2991
CSLConstList GDALMDArrayGetStructuralInfo(GDALMDArrayH hArray)
Return structural information on the array.
Definition: gdalmultidim.cpp:12102
void GDALDeinitGCPs(int, GDAL_GCP *)
De-initialize an array of GCPs (initialized with GDALInitGCPs())
Definition: gdal_misc.cpp:1501
CPLErr GDALReadBlock(GDALRasterBandH, int, int, void *)
Read a block of image data efficiently.
Definition: gdalrasterband.cpp:618
CPLErr(* GDALVRTProcessedDatasetFuncProcess)(const char *pszFuncName, void *pUserData, VRTPDWorkingDataPtr pWorkingData, CSLConstList papszFunctionArgs, int nBufXSize, int nBufYSize, const void *pInBuffer, size_t nInBufferSize, GDALDataType eInDT, int nInBands, const double *padfInNoData, void *pOutBuffer, size_t nOutBufferSize, GDALDataType eOutDT, int nOutBands, const double *padfOutNoData, double dfSrcXOff, double dfSrcYOff, double dfSrcXSize, double dfSrcYSize, const double adfSrcGT[], const char *pszVRTPath, CSLConstList papszExtra)
Processing function to pass to GDALVRTRegisterProcessedDatasetFunc.
Definition: gdal.h:1733
const char * GDALMDArrayGetName(GDALMDArrayH hArray)
Return array name.
Definition: gdalmultidim.cpp:11301
GDALExtendedDataTypeH GDALExtendedDataTypeCreateString(size_t nMaxStringLength)
Return a new GDALExtendedDataType of class GEDTC_STRING.
Definition: gdalmultidim.cpp:10334
const char * GDALGetMetadataItem(GDALMajorObjectH, const char *, const char *)
Fetch single metadata item.
Definition: gdalmajorobject.cpp:358
double GDALMDArrayGetOffsetEx(GDALMDArrayH hArray, int *pbHasValue, GDALDataType *peStorageType)
Get the scale value to apply to raw values.
Definition: gdalmultidim.cpp:12000
CPLErr GDALSetRasterColorInterpretation(GDALRasterBandH, GDALColorInterp)
Set color interpretation of a band.
Definition: gdalrasterband.cpp:2517
CPLErr GDALDropRasterCache(GDALRasterBandH hBand)
Drop raster data cache.
Definition: gdalrasterband.cpp:1217
CPLErr GDALBuildOverviews(GDALDatasetH, const char *, int, const int *, int, const int *, GDALProgressFunc, void *)
Build raster overview(s)
Definition: gdaldataset.cpp:2174
CPLErr GDALRegenerateOverviewsEx(GDALRasterBandH hSrcBand, int nOverviewCount, GDALRasterBandH *pahOverviewBands, const char *pszResampling, GDALProgressFunc pfnProgress, void *pProgressData, CSLConstList papszOptions)
Generate downsampled overviews.
Definition: overview.cpp:4219
GDALDataType GDALFindDataType(int nBits, int bSigned, int bFloating, int bComplex)
Finds the smallest data type able to support the given requirements.
Definition: gdal_misc.cpp:249
int GDALLoadWorldFile(const char *, double *)
Read ESRI world file.
Definition: gdal_misc.cpp:2151
GDALColorTableH GDALGetRasterColorTable(GDALRasterBandH)
Fetch the color table associated with band.
Definition: gdalrasterband.cpp:2559
CPLErr GDALComputeBandStats(GDALRasterBandH hBand, int nSampleStep, double *pdfMean, double *pdfStdDev, GDALProgressFunc pfnProgress, void *pProgressData)
Undocumented.
Definition: overview.cpp:5562
bool GDALMDArrayRename(GDALMDArrayH hArray, const char *pszNewName)
Rename the array.
Definition: gdalmultidim.cpp:12514
GDALExtendedDataTypeClass GDALExtendedDataTypeGetClass(GDALExtendedDataTypeH hEDT)
Return type class.
Definition: gdalmultidim.cpp:10434
CPLErr GDALRATValuesIOAsInteger(GDALRasterAttributeTableH hRAT, GDALRWFlag eRWFlag, int iField, int iStartRow, int iLength, int *pnData)
Read or Write a block of ints to/from the Attribute Table.
Definition: gdal_rat.cpp:224
GDALDimensionH GDALGroupCreateDimension(GDALGroupH hGroup, const char *pszName, const char *pszType, const char *pszDirection, GUInt64 nSize, CSLConstList papszOptions)
Create a dimension within a group.
Definition: gdalmultidim.cpp:11113
int GDALMDArraySetScaleEx(GDALMDArrayH hArray, double dfScale, GDALDataType eStorageType)
Set the scale value to apply to raw values.
Definition: gdalmultidim.cpp:11874
GDALRasterAttributeTableH GDALGetDefaultRAT(GDALRasterBandH hBand)
Fetch default Raster Attribute Table.
Definition: gdalrasterband.cpp:7029
const char * GDALRelationshipGetName(GDALRelationshipH)
Get the name of the relationship.
Definition: gdalrelationship.cpp:106
GDALAttributeH * GDALMDArrayGetAttributes(GDALMDArrayH hArray, size_t *pnCount, CSLConstList papszOptions)
Return the list of attributes contained in this array.
Definition: gdalmultidim.cpp:11557
GDALMDArrayH GDALMDArrayGetGridded(GDALMDArrayH hArray, const char *pszGridOptions, GDALMDArrayH hXArray, GDALMDArrayH hYArray, CSLConstList papszOptions)
Return a gridded array from scattered point data, that is from an array whose last dimension is the i...
Definition: gdalmultidim.cpp:12448
void GDALRelationshipSetBackwardPathLabel(GDALRelationshipH, const char *)
Sets the label of the backward path for the relationship.
Definition: gdalrelationship.cpp:593
OGRFieldDomainH GDALDatasetGetFieldDomain(GDALDatasetH hDS, const char *pszName)
Get a field domain from its name.
Definition: gdaldataset.cpp:9100
const char * GDALRelationshipGetRelatedTableType(GDALRelationshipH)
Get the type string of the related table.
Definition: gdalrelationship.cpp:619
int GDALDereferenceDataset(GDALDatasetH)
Subtract one from dataset reference count.
Definition: gdaldataset.cpp:1603
GDALDimensionH * GDALMDArrayGetDimensions(GDALMDArrayH hArray, size_t *pnCount)
Return the dimensions of the array.
Definition: gdalmultidim.cpp:11367
double GDALMDArrayGetScale(GDALMDArrayH hArray, int *pbHasValue)
Get the scale value to apply to raw values.
Definition: gdalmultidim.cpp:11931
GUInt64 * GDALAttributeGetDimensionsSize(GDALAttributeH hAttr, size_t *pnCount)
Return the dimension sizes of the attribute.
Definition: gdalmultidim.cpp:12609
char ** GDALRelationshipGetLeftMappingTableFields(GDALRelationshipH)
Get the names of the mapping table fields which correspond to the participating fields from the left ...
Definition: gdalrelationship.cpp:341
GIntBig GDALGetCacheMax64(void)
Get maximum cache memory.
Definition: gdalrasterblock.cpp:237
void GDALDatasetReleaseResultSet(GDALDatasetH, OGRLayerH)
Release results of ExecuteSQL().
Definition: gdaldataset.cpp:4745
CPLVirtualMem * GDALDatasetGetVirtualMem(GDALDatasetH hDS, GDALRWFlag eRWFlag, int nXOff, int nYOff, int nXSize, int nYSize, int nBufXSize, int nBufYSize, GDALDataType eBufType, int nBandCount, int *panBandMap, int nPixelSpace, GIntBig nLineSpace, GIntBig nBandSpace, size_t nCacheSize, size_t nPageSizeHint, int bSingleThreadUsage, CSLConstList papszOptions)
Create a CPLVirtualMem object from a GDAL dataset object.
Definition: gdalvirtualmem.cpp:898
GDALRATTableType GDALRATGetTableType(GDALRasterAttributeTableH hRAT)
Get Rat Table Type.
Definition: gdal_rat.cpp:572
GDALAttributeH * GDALGroupGetAttributes(GDALGroupH hGroup, size_t *pnCount, CSLConstList papszOptions)
Return the list of attributes contained in this group.
Definition: gdalmultidim.cpp:11005
CPLErr GDALFillRaster(GDALRasterBandH hBand, double dfRealValue, double dfImaginaryValue)
Fill this band with a constant value.
Definition: gdalrasterband.cpp:1638
OGRStyleTableH GDALDatasetGetStyleTable(GDALDatasetH)
Returns dataset style table.
Definition: gdaldataset.cpp:5406
int GDALRegisterDriver(GDALDriverH)
Register a driver for use.
Definition: gdaldrivermanager.cpp:583
char * GDALSubdatasetInfoModifyPathComponent(GDALSubdatasetInfoH hInfo, const char *pszNewPath)
Replaces the path component of a subdataset descriptor.
Definition: gdalsubdatasetinfo.cpp:95
void GDALInitGCPs(int, GDAL_GCP *)
Initialize an array of GCPs.
Definition: gdal_misc.cpp:1475
struct GDALExtendedDataTypeHS * GDALExtendedDataTypeH
Opaque type for C++ GDALExtendedDataType.
Definition: gdal.h:342
size_t * GDALMDArrayGetProcessingChunkSize(GDALMDArrayH hArray, size_t *pnCount, size_t nMaxChunkMemory)
Return an optimal chunk size for read/write operations, given the natural block size and memory const...
Definition: gdalmultidim.cpp:12074
int GDALReferenceDataset(GDALDatasetH)
Add one to dataset reference count.
Definition: gdaldataset.cpp:1565
int GDALRATGetColumnCount(GDALRasterAttributeTableH)
Fetch table column count.
Definition: gdal_rat.cpp:1253
int GDALGetGCPCount(GDALDatasetH)
Get number of GCPs.
Definition: gdaldataset.cpp:1785
GDALRasterAttributeTableH GDALRATClone(const GDALRasterAttributeTableH)
Copy Raster Attribute Table.
Definition: gdal_rat.cpp:2173
int GDALMDArraySetNoDataValueAsDouble(GDALMDArrayH hArray, double dfNoDataValue)
Set the nodata value as a double.
Definition: gdalmultidim.cpp:11762
int GDALDataTypeIsFloating(GDALDataType)
Is data type floating? (might be complex)
Definition: gdal_misc.cpp:469
const char * GDALGetProjectionRef(GDALDatasetH)
Fetch the projection definition string for this dataset.
Definition: gdaldataset.cpp:1228
int GDALDataTypeIsConversionLossy(GDALDataType eTypeFrom, GDALDataType eTypeTo)
Is conversion from eTypeFrom to eTypeTo potentially lossy.
Definition: gdal_misc.cpp:593
GDALPaletteInterp GDALGetPaletteInterpretation(GDALColorTableH)
Fetch palette interpretation.
Definition: gdalcolortable.cpp:353
CPLErr GDALSetGCPs(GDALDatasetH, int, const GDAL_GCP *, const char *)
Assign GCPs.
Definition: gdaldataset.cpp:2041
int GDALRATGetRowCount(GDALRasterAttributeTableH)
Fetch row count.
Definition: gdal_rat.cpp:1441
bool GDALMDArrayDeleteAttribute(GDALMDArrayH hArray, const char *pszName, CSLConstList papszOptions)
Delete an attribute from an array.
Definition: gdalmultidim.cpp:11618
GDALExtendedDataTypeH GDALMDArrayGetDataType(GDALMDArrayH hArray)
Return the data type.
Definition: gdalmultidim.cpp:11408
void * GDALMajorObjectH
Opaque type used for the C bindings of the C++ GDALMajorObject class.
Definition: gdal.h:288
GDALColorInterp
Definition: gdal.h:227
@ GCI_YCbCr_YBand
Definition: gdal.h:242
@ GCI_Undefined
Definition: gdal.h:228
@ GCI_SaturationBand
Definition: gdal.h:236
@ GCI_LightnessBand
Definition: gdal.h:237
@ GCI_HueBand
Definition: gdal.h:235
@ GCI_CyanBand
Definition: gdal.h:238
@ GCI_MagentaBand
Definition: gdal.h:239
@ GCI_GrayIndex
Definition: gdal.h:229
@ GCI_BlueBand
Definition: gdal.h:233
@ GCI_PaletteIndex
Definition: gdal.h:230
@ GCI_RedBand
Definition: gdal.h:231
@ GCI_AlphaBand
Definition: gdal.h:234
@ GCI_Max
Definition: gdal.h:245
@ GCI_YCbCr_CrBand
Definition: gdal.h:244
@ GCI_GreenBand
Definition: gdal.h:232
@ GCI_YellowBand
Definition: gdal.h:240
@ GCI_BlackBand
Definition: gdal.h:241
@ GCI_YCbCr_CbBand
Definition: gdal.h:243
struct GDALGroupHS * GDALGroupH
Opaque type for C++ GDALGroup.
Definition: gdal.h:346
OGRLayerH GDALDatasetCreateLayerFromGeomFieldDefn(GDALDatasetH, const char *, OGRGeomFieldDefnH, CSLConstList)
This function attempts to create a new layer on the dataset with the indicated name and geometry fiel...
Definition: gdaldataset.cpp:5236
int GDALARLockBuffer(GDALAsyncReaderH hARIO, double dfTimeout)
Lock image buffer.
Definition: gdaldefaultasync.cpp:220
const char * GDALGetRasterUnitType(GDALRasterBandH)
Return raster unit type.
Definition: gdalrasterband.cpp:3140
CPLErr GDALFlushRasterCache(GDALRasterBandH hBand)
Flush raster data cache.
Definition: gdalrasterband.cpp:1153
GDALRelationshipType
Type of relationship.
Definition: gdal.h:2132
@ GRT_AGGREGATION
Aggregation relationship.
Definition: gdal.h:2138
@ GRT_ASSOCIATION
Association relationship.
Definition: gdal.h:2136
@ GRT_COMPOSITE
Composite relationship.
Definition: gdal.h:2134
GDALRasterBandH GDALGetRasterSampleOverview(GDALRasterBandH, int)
Fetch best sampling overview.
Definition: gdalrasterband.cpp:2813
double GDALPackedDMSToDec(double)
Convert a packed DMS value (DDDMMMSSS.SS) into decimal degrees.
Definition: gdal_misc.cpp:2688
int GDALExtendedDataTypeEquals(GDALExtendedDataTypeH hFirstEDT, GDALExtendedDataTypeH hSecondEDT)
Return whether this data type is equal to another one.
Definition: gdalmultidim.cpp:10516
GDALColorTableH GDALRATTranslateToColorTable(GDALRasterAttributeTableH, int nEntryCount)
Translate to a color table.
Definition: gdal_rat.cpp:1091
OGRLayerH GDALDatasetCopyLayer(GDALDatasetH, OGRLayerH, const char *, CSLConstList)
Duplicate an existing layer.
Definition: gdaldataset.cpp:5283
int GDALMDArrayAdviseRead(GDALMDArrayH hArray, const GUInt64 *arrayStartIdx, const size_t *count)
Advise driver of upcoming read requests.
Definition: gdalmultidim.cpp:11492
const char * GDALRATGetNameOfCol(GDALRasterAttributeTableH, int)
Fetch name of indicated column.
Definition: gdal_rat.cpp:1291
GDALDataType GDALDataTypeUnionWithValue(GDALDataType eDT, double dValue, int bComplex)
Union a data type with the one found for a value.
Definition: gdal_misc.cpp:178
GDALAsyncStatusType
status of the asynchronous stream
Definition: gdal.h:111
int GDALReadTabFile(const char *, double *, char **, int *, GDAL_GCP **)
Helper function for translator implementer wanting support for MapInfo .tab files.
Definition: gdal_misc.cpp:2047
GDALRelationshipType GDALRelationshipGetType(GDALRelationshipH)
Get the type of the relationship.
Definition: gdalrelationship.cpp:442
void GDALReleaseAttributes(GDALAttributeH *attributes, size_t nCount)
Free the return of GDALGroupGetAttributes() or GDALMDArrayGetAttributes()
Definition: gdalmultidim.cpp:11049
CPLErr GDALFlushCache(GDALDatasetH hDS)
Flush all write cached data to disk.
Definition: gdaldataset.cpp:608
CPLErr GDALSetDefaultRAT(GDALRasterBandH, GDALRasterAttributeTableH)
Set default Raster Attribute Table.
Definition: gdalrasterband.cpp:7084
void GDALCopyWords(const void *pSrcData, GDALDataType eSrcType, int nSrcPixelOffset, void *pDstData, GDALDataType eDstType, int nDstPixelOffset, int nWordCount)
Copy pixel words from buffer to buffer.
Definition: rasterio.cpp:3254
int GDALReadWorldFile(const char *, const char *, double *)
Read ESRI world file.
Definition: gdal_misc.cpp:2246
GDALMDArrayH GDALGroupCreateMDArray(GDALGroupH hGroup, const char *pszName, size_t nDimensions, GDALDimensionH *pahDimensions, GDALExtendedDataTypeH hEDT, CSLConstList papszOptions)
Create a multidimensional array within a group.
Definition: gdalmultidim.cpp:11138
int GDALReleaseDataset(GDALDatasetH)
Drop a reference to this object, and destroy if no longer referenced.
Definition: gdaldataset.cpp:1644
GUInt64 * GDALMDArrayGetBlockSize(GDALMDArrayH hArray, size_t *pnCount)
Return the "natural" block size of the array along all dimensions.
Definition: gdalmultidim.cpp:12037
int GDALGetDataTypeSize(GDALDataType)
Get data type size in bits.
Definition: gdal_misc.cpp:409
int GDALDataTypeIsSigned(GDALDataType)
Is data type signed?
Definition: gdal_misc.cpp:551
CPLErr GDALSetRasterColorTable(GDALRasterBandH, GDALColorTableH)
Set the raster color table.
Definition: gdalrasterband.cpp:2611
CPLErr GDALGetGeoTransform(GDALDatasetH, double *)
Fetch the affine transformation coefficients.
Definition: gdaldataset.cpp:1402
void GDALSetCacheMax(int nBytes)
Set maximum cache memory.
Definition: gdalrasterblock.cpp:120
void * GDALDriverH
Opaque type used for the C bindings of the C++ GDALDriver class.
Definition: gdal.h:297
int GDALAttributeWriteInt(GDALAttributeH hAttr, int)
Write an attribute from a integer value.
Definition: gdalmultidim.cpp:12890
int GDALFlushCacheBlock(void)
Try to flush one cached raster block.
Definition: gdalrasterblock.cpp:375
double GDALAttributeReadAsDouble(GDALAttributeH hAttr)
Return the value of an attribute as a double.
Definition: gdalmultidim.cpp:12750
int GDALGetRasterYSize(GDALDatasetH)
Fetch raster height in pixels.
Definition: gdaldataset.cpp:986
void GDALEDTComponentRelease(GDALEDTComponentH hComp)
Release the GDAL in-memory object associated with a GDALEDTComponentH.
Definition: gdalmultidim.cpp:10624
CPLErr GDALAddDerivedBandPixelFunc(const char *pszName, GDALDerivedPixelFunc pfnPixelFunc)
This adds a pixel function to the global list of available pixel functions for derived bands.
Definition: vrtderivedrasterband.cpp:266
int GDALRATGetColOfUsage(GDALRasterAttributeTableH, GDALRATFieldUsage)
Fetch column index for given usage.
Definition: gdal_rat.cpp:1413
void GDALGetOpenDatasets(GDALDatasetH **hDS, int *pnCount)
Fetch all open GDAL dataset handles.
Definition: gdaldataset.cpp:2948
int GDALGetBandNumber(GDALRasterBandH)
Fetch the band number.
Definition: gdalrasterband.cpp:3310
GDALDatasetH GDALCreateMultiDimensional(GDALDriverH hDriver, const char *pszName, CSLConstList papszRootGroupOptions, CSLConstList papszOptions)
Create a new multidimensional dataset with this driver.
Definition: gdaldriver.cpp:411
char ** GDALRelationshipGetRightMappingTableFields(GDALRelationshipH)
Get the names of the mapping table fields which correspond to the participating fields from the right...
Definition: gdalrelationship.cpp:368
GDALRWFlag
Definition: gdal.h:132
@ GF_Write
Definition: gdal.h:134
@ GF_Read
Definition: gdal.h:133
int GDALGCPsToGeoTransform(int nGCPCount, const GDAL_GCP *pasGCPs, double *padfGeoTransform, int bApproxOK)
Generate Geotransform from GCPs.
Definition: gdal_misc.cpp:2745
void GDALCopyWords64(const void *pSrcData, GDALDataType eSrcType, int nSrcPixelOffset, void *pDstData, GDALDataType eDstType, int nDstPixelOffset, GPtrDiff_t nWordCount)
Copy pixel words from buffer to buffer.
Definition: rasterio.cpp:3310
CPLErr GDALRATValuesIOAsDouble(GDALRasterAttributeTableH hRAT, GDALRWFlag eRWFlag, int iField, int iStartRow, int iLength, double *pdfData)
Read or Write a block of doubles to/from the Attribute Table.
Definition: gdal_rat.cpp:160
void GDALMDArrayRelease(GDALMDArrayH hMDArray)
Release the GDAL in-memory object associated with a GDALMDArray.
Definition: gdalmultidim.cpp:11288
void GDALDestroySubdatasetInfo(GDALSubdatasetInfoH hInfo)
Destroys a GDALSubdatasetInfo object.
Definition: gdalsubdatasetinfo.cpp:79
int GDALMDArraySetSpatialRef(GDALMDArrayH, OGRSpatialReferenceH)
Assign a spatial reference system object to the array.
Definition: gdalmultidim.cpp:12298
void(* GDALVRTProcessedDatasetFuncFree)(const char *pszFuncName, void *pUserData, VRTPDWorkingDataPtr pWorkingData)
Free function to pass to GDALVRTRegisterProcessedDatasetFunc.
Definition: gdal.h:1700
GDALDriverH GDALGetDriverByName(const char *)
Fetch a driver based on the short name.
Definition: gdaldrivermanager.cpp:691
CPLErr GDALSetGeoTransform(GDALDatasetH, double *)
Set the affine transformation coefficients.
Definition: gdaldataset.cpp:1450
GDALDatasetH GDALOpen(const char *pszFilename, GDALAccess eAccess)
Open a raster file as a GDALDataset.
Definition: gdaldataset.cpp:3435
const char * GDALRelationshipGetLeftTableName(GDALRelationshipH)
Get the name of the left (or base/origin) table in the relationship.
Definition: gdalrelationship.cpp:143
const char * GDALRATGetValueAsString(GDALRasterAttributeTableH, int, int)
Fetch field value as a string.
Definition: gdal_rat.cpp:1507
GDALColorInterp GDALGetRasterColorInterpretation(GDALRasterBandH)
How should this band be interpreted as color?
Definition: gdalrasterband.cpp:2471
CPLErr(* GDALDerivedPixelFunc)(void **papoSources, int nSources, void *pData, int nBufXSize, int nBufYSize, GDALDataType eSrcType, GDALDataType eBufType, int nPixelSpace, int nLineSpace)
Type of functions to pass to GDALAddDerivedBandPixelFunc.
Definition: gdal.h:1471
bool GDALDatasetUpdateRelationship(GDALDatasetH hDS, GDALRelationshipH hRelationship, char **ppszFailureReason)
Updates an existing relationship by replacing its definition.
Definition: gdaldataset.cpp:9632
int GDALMDArrayComputeStatistics(GDALMDArrayH hArray, GDALDatasetH, int bApproxOK, double *pdfMin, double *pdfMax, double *pdfMean, double *pdfStdDev, GUInt64 *pnValidCount, GDALProgressFunc, void *pProgressData)
Compute statistics.
Definition: gdalmultidim.cpp:12360
CPLErr GDALGetRasterHistogram(GDALRasterBandH hBand, double dfMin, double dfMax, int nBuckets, int *panHistogram, int bIncludeOutOfRange, int bApproxOK, GDALProgressFunc pfnProgress, void *pProgressData)
Compute raster histogram.
Definition: gdalrasterband.cpp:3978
void * GDALRasterBandH
Opaque type used for the C bindings of the C++ GDALRasterBand class.
Definition: gdal.h:294
GDALDriverH GDALCreateDriver(void)
Create a GDALDriver.
Definition: gdaldriver.cpp:77
char ** GDALGroupGetVectorLayerNames(GDALGroupH hGroup, CSLConstList papszOptions)
Return the list of layer names contained in this group.
Definition: gdalmultidim.cpp:10867
double GDALMDArrayGetScaleEx(GDALMDArrayH hArray, int *pbHasValue, GDALDataType *peStorageType)
Get the scale value to apply to raw values.
Definition: gdalmultidim.cpp:11954
void * GDALColorTableH
Opaque type used for the C bindings of the C++ GDALColorTable class.
Definition: gdal.h:300
CPLErr GDALRasterIO(GDALRasterBandH hRBand, GDALRWFlag eRWFlag, int nDSXOff, int nDSYOff, int nDSXSize, int nDSYSize, void *pBuffer, int nBXSize, int nBYSize, GDALDataType eBDataType, int nPixelSpace, int nLineSpace)
Read/write a region of image data for this band.
Definition: gdalrasterband.cpp:447
int64_t GDALGetRasterNoDataValueAsInt64(GDALRasterBandH, int *)
Fetch the no data value for this band.
Definition: gdalrasterband.cpp:1888
GDALDatasetH GDALCreateCopy(GDALDriverH, const char *, GDALDatasetH, int, CSLConstList, GDALProgressFunc, void *)
Create a copy of a dataset.
Definition: gdaldriver.cpp:1394
const char * GDALGroupGetName(GDALGroupH hGroup)
Return the name of the group.
Definition: gdalmultidim.cpp:10698
int GDALMDArraySetOffset(GDALMDArrayH hArray, double dfOffset)
Set the scale value to apply to raw values.
Definition: gdalmultidim.cpp:11893
void GDALRelationshipSetRightTableFields(GDALRelationshipH, CSLConstList)
Sets the names of the participating fields from the right table in the relationship.
Definition: gdalrelationship.cpp:317
CPLErr GDALRegenerateOverviews(GDALRasterBandH hSrcBand, int nOverviewCount, GDALRasterBandH *pahOverviewBands, const char *pszResampling, GDALProgressFunc pfnProgress, void *pProgressData)
Generate downsampled overviews.
Definition: overview.cpp:4169
GDALRasterAttributeTableH GDALCreateRasterAttributeTable(void)
Construct empty table.
Definition: gdal_rat.cpp:1181
int GDALGetCacheMax(void)
Get maximum cache memory.
Definition: gdalrasterblock.cpp:198
void GDALComposeGeoTransforms(const double *padfGeoTransform1, const double *padfGeoTransform2, double *padfGeoTransformOut)
Compose two geotransforms.
Definition: gdal_misc.cpp:3040
int GDALMDArrayAdviseReadEx(GDALMDArrayH hArray, const GUInt64 *arrayStartIdx, const size_t *count, CSLConstList papszOptions)
Advise driver of upcoming read requests.
Definition: gdalmultidim.cpp:11510
CPLErr GDALSetRasterNoDataValueAsUInt64(GDALRasterBandH, uint64_t)
Set the no data value for this band.
Definition: gdalrasterband.cpp:2170
void GDALDatasetSetStyleTable(GDALDatasetH, OGRStyleTableH)
Set dataset style table.
Definition: gdaldataset.cpp:5464
void * GDALGetInternalHandle(GDALDatasetH, const char *)
Fetch a format specific internally meaningful handle.
Definition: gdaldataset.cpp:1490
CPLErr GDALSetSpatialRef(GDALDatasetH, OGRSpatialReferenceH)
Set the spatial reference system for this dataset.
Definition: gdaldataset.cpp:1317
void GDALDestroyDriver(GDALDriverH)
Destroy a GDALDriver.
Definition: gdaldriver.cpp:96
size_t GDALEDTComponentGetOffset(GDALEDTComponentH hComp)
Return the offset (in bytes) of the component in the compound data type.
Definition: gdalmultidim.cpp:10653
GDALTileOrganization
! Enumeration to describe the tile organization
Definition: gdal.h:2215
@ GTO_BIT
Definition: gdal.h:2222
@ GTO_BSQ
Definition: gdal.h:2225
@ GTO_TIP
Definition: gdal.h:2218
void GDALCreateColorRamp(GDALColorTableH hTable, int nStartIndex, const GDALColorEntry *psStartColor, int nEndIndex, const GDALColorEntry *psEndColor)
Create color ramp.
Definition: gdalcolortable.cpp:442
GDALExtendedDataTypeH GDALExtendedDataTypeCreateCompound(const char *pszName, size_t nTotalSize, size_t nComponents, const GDALEDTComponentH *comps)
Return a new GDALExtendedDataType of class GEDTC_COMPOUND.
Definition: gdalmultidim.cpp:10380
char * GDALSubdatasetInfoGetSubdatasetComponent(GDALSubdatasetInfoH hInfo)
Returns the subdataset component of a subdataset descriptor descriptor.
Definition: gdalsubdatasetinfo.cpp:90
GDALMDArrayH GDALMDArrayGetUnscaled(GDALMDArrayH hArray)
Return an array that is the unscaled version of the current one.
Definition: gdalmultidim.cpp:12170
CPLErr GDALSetRasterStatistics(GDALRasterBandH hBand, double dfMin, double dfMax, double dfMean, double dfStdDev)
Set statistics on band.
Definition: gdalrasterband.cpp:6296
CPLErr GDALDropCache(GDALDatasetH hDS)
Drop all write cached data.
Definition: gdaldataset.cpp:661
double GDALMDArrayGetNoDataValueAsDouble(GDALMDArrayH hArray, int *pbHasNoDataValue)
Return the nodata value as a double.
Definition: gdalmultidim.cpp:11669
double GDALDecToPackedDMS(double)
Convert decimal degrees into packed DMS value (DDDMMMSSS.SS).
Definition: gdal_misc.cpp:2704
GDALDataType GDALGetDataTypeByName(const char *)
Get data type by symbolic name.
Definition: gdal_misc.cpp:734
void GDALCopyBits(const GByte *pabySrcData, int nSrcOffset, int nSrcStep, GByte *pabyDstData, int nDstOffset, int nDstStep, int nBitCount, int nStepCount)
Bitwise word copying.
Definition: rasterio.cpp:3536
bool GDALDatasetSetQueryLoggerFunc(GDALDatasetH hDS, GDALQueryLoggerFunc pfnQueryLoggerFunc, void *poQueryLoggerArg)
Sets the SQL query logger callback.
Definition: gdaldataset.cpp:9671
C API and defines for OGRFeature, OGRGeometry, and OGRDataSource related classes.
void * OGRGeometryH
Opaque type for a geometry.
Definition: ogr_api.h:66
void * OGRSpatialReferenceH
Opaque type for a spatial reference system.
Definition: ogr_api.h:81
void * OGRLayerH
Opaque type for a layer (OGRLayer)
Definition: ogr_api.h:688
void * OGRFeatureH
Opaque type for a feature (OGRFeature)
Definition: ogr_api.h:422
struct OGRFieldDomainHS * OGRFieldDomainH
Opaque type for a field domain definition (OGRFieldDomain)
Definition: ogr_api.h:430
struct OGRGeomFieldDefnHS * OGRGeomFieldDefnH
Opaque type for a geometry field definition (OGRGeomFieldDefn)
Definition: ogr_api.h:427
void * OGRStyleTableH
Opaque type for a style table (OGRStyleTable)
Definition: ogr_api.h:424
OGRwkbGeometryType
List of well known binary geometry types.
Definition: ogr_core.h:416
int OGRErr
Type for a OGR error.
Definition: ogr_core.h:387
Document node structure.
Definition: cpl_minixml.h:71
Color tuple.
Definition: gdal.h:1957
short c4
Definition: gdal.h:1968
short c2
Definition: gdal.h:1962
short c3
Definition: gdal.h:1965
short c1
Definition: gdal.h:1959
Structure to store Rational Polynomial Coefficients / Rigorous Projection Model.
Definition: gdal.h:1917
double dfLAT_OFF
Definition: gdal.h:1920
double dfLONG_SCALE
Definition: gdal.h:1927
double dfHEIGHT_OFF
Definition: gdal.h:1922
double dfMAX_LAT
Definition: gdal.h:1938
double dfMIN_LAT
Definition: gdal.h:1936
double dfLINE_OFF
Definition: gdal.h:1918
double dfLONG_OFF
Definition: gdal.h:1921
double dfSAMP_SCALE
Definition: gdal.h:1925
double dfMAX_LONG
Definition: gdal.h:1937
double dfERR_BIAS
Definition: gdal.h:1942
double dfERR_RAND
Definition: gdal.h:1943
double dfLINE_SCALE
Definition: gdal.h:1924
double dfHEIGHT_SCALE
Definition: gdal.h:1928
double dfMIN_LONG
Definition: gdal.h:1935
double dfLAT_SCALE
Definition: gdal.h:1926
double dfSAMP_OFF
Definition: gdal.h:1919
Structure to pass extra arguments to RasterIO() method, must be initialized with INIT_RASTERIO_EXTRA_...
Definition: gdal.h:176
void * pProgressData
Definition: gdal.h:186
GDALRIOResampleAlg eResampleAlg
Definition: gdal.h:181
double dfXOff
Definition: gdal.h:196
int nVersion
Definition: gdal.h:178
double dfYSize
Definition: gdal.h:205
double dfYOff
Definition: gdal.h:199
double dfXSize
Definition: gdal.h:202
GDALProgressFunc pfnProgress
Definition: gdal.h:184
int bFloatingPointWindowValidity
Definition: gdal.h:193
The GDALSubdatasetInfo abstract class provides methods to extract and manipulate subdataset informati...
Definition: gdalsubdatasetinfo.h:43
Ground Control Point.
Definition: gdal.h:1077
double dfGCPLine
Line (y) location of GCP on raster.
Definition: gdal.h:1087
double dfGCPX
X position of GCP in georeferenced space.
Definition: gdal.h:1090
char * pszId
Unique identifier, often numeric.
Definition: gdal.h:1079
char * pszInfo
Informational message or "".
Definition: gdal.h:1082
double dfGCPPixel
Pixel (x) location of GCP on raster.
Definition: gdal.h:1085
double dfGCPY
Y position of GCP in georeferenced space.
Definition: gdal.h:1093
double dfGCPZ
Elevation of GCP, or zero if not known.
Definition: gdal.h:1096