GDAL
gdalgrid.h
Go to the documentation of this file.
1 /******************************************************************************
2  * $Id: gdalgrid.h 34931 2016-08-05 17:13:05Z rouault $
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 mines-paris dot org>
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 GDALGRID_H_INCLUDED
32 #define GDALGRID_H_INCLUDED
33 
40 #include "gdal_alg.h"
41 
42 /*
43  * GridCreate Algorithm names
44  */
45 
46 static const char szAlgNameInvDist[] = "invdist";
47 static const char szAlgNameInvDistNearestNeighbor[] = "invdistnn";
48 static const char szAlgNameAverage[] = "average";
49 static const char szAlgNameNearest[] = "nearest";
50 static const char szAlgNameMinimum[] = "minimum";
51 static const char szAlgNameMaximum[] = "maximum";
52 static const char szAlgNameRange[] = "range";
53 static const char szAlgNameCount[] = "count";
54 static const char szAlgNameAverageDistance[] = "average_distance";
55 static const char szAlgNameAverageDistancePts[] = "average_distance_pts";
56 static const char szAlgNameLinear[] = "linear";
57 
59 
61 typedef CPLErr (*GDALGridFunction)( const void *, GUInt32,
62  const double *, const double *,
63  const double *,
64  double, double, double *,
65  void* );
68 CPLErr
70  const double *, const double *,
71  const double *,
72  double, double, double *,
73  void* );
74 CPLErr
76  const double *, const double *,
77  const double *,
78  double, double, double *,
79  void* );
80 CPLErr
82  const double *, const double *,
83  const double *,
84  double, double, double *,
85  void* );
86 CPLErr
87 GDALGridMovingAverage( const void *, GUInt32,
88  const double *, const double *, const double *,
89  double, double, double *,
90  void* );
91 CPLErr
92 GDALGridNearestNeighbor( const void *, GUInt32,
93  const double *, const double *, const double *,
94  double, double, double *,
95  void* );
96 CPLErr
97 GDALGridDataMetricMinimum( const void *, GUInt32,
98  const double *, const double *, const double *,
99  double, double, double *,
100  void* );
101 CPLErr
102 GDALGridDataMetricMaximum( const void *, GUInt32,
103  const double *, const double *, const double *,
104  double, double, double *,
105  void* );
106 CPLErr
107 GDALGridDataMetricRange( const void *, GUInt32,
108  const double *, const double *, const double *,
109  double, double, double *,
110  void* );
111 CPLErr
112 GDALGridDataMetricCount( const void *, GUInt32,
113  const double *, const double *, const double *,
114  double, double, double *,
115  void* );
116 CPLErr
118  const double *, const double *,
119  const double *, double, double, double *,
120  void* );
121 CPLErr
123  const double *, const double *,
124  const double *, double, double,
125  double *,
126  void* );
127 CPLErr
128 GDALGridLinear( const void *, GUInt32,
129  const double *, const double *,
130  const double *,
131  double, double, double *,
132  void* );
133 
134 CPLErr CPL_DLL
135 ParseAlgorithmAndOptions( const char *,
137  void ** );
138 CPL_C_END
139 
140 #endif /* GDALGRID_H_INCLUDED */
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:352
CPLErr GDALGridDataMetricAverageDistance(const void *, GUInt32, const double *, const double *, const double *, double, double, double *, void *)
Average distance (data metric).
Definition: gdalgrid.cpp:1218
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:267
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:413
CPLErr GDALGridDataMetricMinimum(const void *, GUInt32, const double *, const double *, const double *, double, double, double *, void *)
Minimum data value (data metric).
Definition: gdalgrid.cpp:791
CPLErr GDALGridDataMetricRange(const void *, GUInt32, const double *, const double *, const double *, double, double, double *, void *)
Data range (data metric).
Definition: gdalgrid.cpp:1009
unsigned int GUInt32
Unsigned int32 type.
Definition: cpl_port.h:199
GDALGridAlgorithm
Gridding Algorithms.
Definition: gdal_alg.h:365
CPLErr GDALGridNearestNeighbor(const void *, GUInt32, const double *, const double *, const double *, double, double, double *, void *)
Nearest neighbor.
Definition: gdalgrid.cpp:638
CPLErr GDALGridDataMetricMaximum(const void *, GUInt32, const double *, const double *, const double *, double, double, double *, void *)
Maximum data value (data metric).
Definition: gdalgrid.cpp:899
CPLErr GDALGridDataMetricCount(const void *, GUInt32, const double *, const double *, const double *, double, double, double *, void *)
Number of data points (data metric).
Definition: gdalgrid.cpp:1118
CPLErr GDALGridInverseDistanceToAPower(const void *, GUInt32, const double *, const double *, const double *, double, double, double *, void *)
Inverse distance to a power.
Definition: gdalgrid.cpp:134
CPLErr GDALGridMovingAverage(const void *, GUInt32, const double *, const double *, const double *, double, double, double *, void *)
Moving average.
Definition: gdalgrid.cpp:549
CPLErr GDALGridLinear(const void *, GUInt32, const double *, const double *, const double *, double, double, double *, void *)
Linear interpolation.
Definition: gdalgrid.cpp:1444
Public (C callable) GDAL algorithm entry points, and definitions.
CPLErr ParseAlgorithmAndOptions(const char *, GDALGridAlgorithm *, void **)
Translates mnemonic gridding algorithm names into GDALGridAlgorithm code, parse control parameters an...
Definition: gdalgrid.cpp:2452
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:354
CPLErr GDALGridDataMetricAverageDistancePts(const void *, GUInt32, const double *, const double *, const double *, double, double, double *, void *)
Average distance between points (data metric).
Definition: gdalgrid.cpp:1323
CPLErr
Error category.
Definition: cpl_error.h:52

Generated for GDAL by doxygen 1.8.8.