GDAL

gdalgrid.h
Go to the documentation of this file.
1/******************************************************************************
2 * $Id$
3 *
4 * Project: GDAL Gridding API.
5 * Purpose: Prototypes, and definitions for of GDAL scattered data gridder.
6 * Author: Andrey Kiselev, dron@ak4719.spb.edu
7 *
8 ******************************************************************************
9 * Copyright (c) 2007, Andrey Kiselev <dron@ak4719.spb.edu>
10 * Copyright (c) 2012, Even Rouault <even dot rouault at spatialys.com>
11 *
12 * SPDX-License-Identifier: MIT
13 ****************************************************************************/
14
15#ifndef GDALGRID_H_INCLUDED
16#define GDALGRID_H_INCLUDED
17
24#include "gdal_alg.h"
25
26/*
27 * GridCreate Algorithm names
28 */
29
30 static const char szAlgNameInvDist[] = "invdist";
31 static const char szAlgNameInvDistNearestNeighbor[] = "invdistnn";
32 static const char szAlgNameAverage[] = "average";
33 static const char szAlgNameNearest[] = "nearest";
34 static const char szAlgNameMinimum[] = "minimum";
35 static const char szAlgNameMaximum[] = "maximum";
36 static const char szAlgNameRange[] = "range";
37 static const char szAlgNameCount[] = "count";
38 static const char szAlgNameAverageDistance[] = "average_distance";
39 static const char szAlgNameAverageDistancePts[] = "average_distance_pts";
40 static const char szAlgNameLinear[] = "linear";
41
42 CPL_C_START
43
45 typedef CPLErr (*GDALGridFunction)(const void *, GUInt32, const double *,
46 const double *, const double *, double,
47 double, double *, void *);
50 CPLErr GDALGridInverseDistanceToAPower(const void *, GUInt32, const double *,
51 const double *, const double *, double,
52 double, double *, void *);
53 CPLErr GDALGridInverseDistanceToAPowerNearestNeighbor(const void *, GUInt32,
54 const double *,
55 const double *,
56 const double *, double,
57 double, double *, void *);
58 CPLErr GDALGridInverseDistanceToAPowerNoSearch(const void *, GUInt32,
59 const double *, const double *,
60 const double *, double, double,
61 double *, void *);
62 CPLErr GDALGridMovingAverage(const void *, GUInt32, const double *,
63 const double *, const double *, double, double,
64 double *, void *);
65 CPLErr GDALGridNearestNeighbor(const void *, GUInt32, const double *,
66 const double *, const double *, double, double,
67 double *, void *);
68 CPLErr GDALGridDataMetricMinimum(const void *, GUInt32, const double *,
69 const double *, const double *, double, double,
70 double *, void *);
71 CPLErr GDALGridDataMetricMaximum(const void *, GUInt32, const double *,
72 const double *, const double *, double, double,
73 double *, void *);
74 CPLErr GDALGridDataMetricRange(const void *, GUInt32, const double *,
75 const double *, const double *, double, double,
76 double *, void *);
77 CPLErr GDALGridDataMetricCount(const void *, GUInt32, const double *,
78 const double *, const double *, double, double,
79 double *, void *);
80 CPLErr GDALGridDataMetricAverageDistance(const void *, GUInt32, const double *,
81 const double *, const double *, double,
82 double, double *, void *);
83 CPLErr GDALGridDataMetricAverageDistancePts(const void *, GUInt32,
84 const double *, const double *,
85 const double *, double, double,
86 double *, void *);
87 CPLErr GDALGridLinear(const void *, GUInt32, const double *, const double *,
88 const double *, double, double, double *, void *);
89
90#ifndef GDAL_COMPILATION
91/* ParseAlgorithmAndOptions() is used by PostGIS Raster, hence this alias */
92
94#define ParseAlgorithmAndOptions GDALGridParseAlgorithmAndOptions
95#endif
96
97 CPLErr CPL_DLL GDALGridParseAlgorithmAndOptions(const char *,
98 GDALGridAlgorithm *, void **);
99
100 CPL_C_END
101
102#endif /* GDALGRID_H_INCLUDED */
CPLErr
CPLErr
Error category.
Definition: cpl_error.h:37
CPL_C_END
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:283
CPL_C_START
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:279
GUInt32
unsigned int GUInt32
Unsigned int32 type.
Definition: cpl_port.h:161
gdal_alg.h
Public (C callable) GDAL algorithm entry points, and definitions.
GDALGridAlgorithm
GDALGridAlgorithm
Gridding Algorithms.
Definition: gdal_alg.h:389
GDALGridDataMetricMaximum
CPLErr GDALGridDataMetricMaximum(const void *, GUInt32, const double *, const double *, const double *, double, double, double *, void *)
Maximum data value (data metric).
Definition: gdalgrid.cpp:1327
GDALGridDataMetricMinimum
CPLErr GDALGridDataMetricMinimum(const void *, GUInt32, const double *, const double *, const double *, double, double, double *, void *)
Minimum data value (data metric).
Definition: gdalgrid.cpp:1033
GDALGridMovingAverage
CPLErr GDALGridMovingAverage(const void *, GUInt32, const double *, const double *, const double *, double, double, double *, void *)
Moving average.
Definition: gdalgrid.cpp:629
GDALGridLinear
CPLErr GDALGridLinear(const void *, GUInt32, const double *, const double *, const double *, double, double, double *, void *)
Linear interpolation.
Definition: gdalgrid.cpp:2459
GDALGridInverseDistanceToAPowerNearestNeighbor
CPLErr GDALGridInverseDistanceToAPowerNearestNeighbor(const void *, GUInt32, const double *, const double *, const double *, double, double, double *, void *)
Inverse distance to a power with nearest neighbor search, ideal when max_points used.
Definition: gdalgrid.cpp:241
GDALGridInverseDistanceToAPowerNoSearch
CPLErr GDALGridInverseDistanceToAPowerNoSearch(const void *, GUInt32, const double *, const double *, const double *, double, double, double *, void *)
Inverse distance to a power for whole data set.
Definition: gdalgrid.cpp:497
GDALGridDataMetricCount
CPLErr GDALGridDataMetricCount(const void *, GUInt32, const double *, const double *, const double *, double, double, double *, void *)
Number of data points (data metric).
Definition: gdalgrid.cpp:1755
GDALGridDataMetricAverageDistancePts
CPLErr GDALGridDataMetricAverageDistancePts(const void *, GUInt32, const double *, const double *, const double *, double, double, double *, void *)
Average distance between points (data metric).
Definition: gdalgrid.cpp:2283
GDALGridParseAlgorithmAndOptions
CPLErr GDALGridParseAlgorithmAndOptions(const char *, GDALGridAlgorithm *, void **)
Translates mnemonic gridding algorithm names into GDALGridAlgorithm code, parse control parameters an...
Definition: gdalgrid.cpp:3668
GDALGridNearestNeighbor
CPLErr GDALGridNearestNeighbor(const void *, GUInt32, const double *, const double *, const double *, double, double, double *, void *)
Nearest neighbor.
Definition: gdalgrid.cpp:879
GDALGridInverseDistanceToAPower
CPLErr GDALGridInverseDistanceToAPower(const void *, GUInt32, const double *, const double *, const double *, double, double, double *, void *)
Inverse distance to a power.
Definition: gdalgrid.cpp:109
GDALGridDataMetricAverageDistance
CPLErr GDALGridDataMetricAverageDistance(const void *, GUInt32, const double *, const double *, const double *, double, double, double *, void *)
Average distance (data metric).
Definition: gdalgrid.cpp:2014
GDALGridDataMetricRange
CPLErr GDALGridDataMetricRange(const void *, GUInt32, const double *, const double *, const double *, double, double, double *, void *)
Data range (data metric).
Definition: gdalgrid.cpp:1484