1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/analysis/raster/qgskde.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsKernelDensityEstimation
{
%Docstring(signature="appended")
Performs Kernel Density Estimation ("heatmap") calculations on a vector
layer.
%End
%TypeHeaderCode
#include "qgskde.h"
%End
public:
enum KernelShape /BaseType=IntEnum/
{
KernelQuartic,
KernelTriangular,
KernelUniform,
KernelTriweight,
KernelEpanechnikov,
};
enum OutputValues /BaseType=IntEnum/
{
OutputRaw,
OutputScaled,
};
enum Result /BaseType=IntEnum/
{
Success,
DriverError,
InvalidParameters,
FileCreationError,
RasterIoError,
};
struct Parameters
{
QgsFeatureSource *source;
double radius;
QString radiusField;
QString weightField;
double pixelSize;
QgsKernelDensityEstimation::KernelShape shape;
double decayRatio;
QgsKernelDensityEstimation::OutputValues outputValues;
};
QgsKernelDensityEstimation( const Parameters ¶meters, const QString &outputFile, const QString &outputFormat );
%Docstring
Constructor for QgsKernelDensityEstimation. Requires a Parameters object
specifying the options to use to generate the surface. The output path
and file format are also required.
%End
Result run();
%Docstring
Runs the KDE calculation across the whole layer at once. Either call
this method, or manually call
:py:func:`~QgsKernelDensityEstimation.run`,
:py:func:`~QgsKernelDensityEstimation.addFeature` and
:py:func:`~QgsKernelDensityEstimation.finalise` separately.
%End
Result prepare();
%Docstring
Prepares the output file for writing and setups up the surface
calculation. This must be called before adding features via
:py:func:`~QgsKernelDensityEstimation.addFeature`.
.. seealso:: :py:func:`addFeature`
.. seealso:: :py:func:`finalise`
%End
Result addFeature( const QgsFeature &feature );
%Docstring
Adds a single feature to the KDE surface.
:py:func:`~QgsKernelDensityEstimation.prepare` must be called before
adding features.
.. seealso:: :py:func:`prepare`
.. seealso:: :py:func:`finalise`
%End
Result finalise();
%Docstring
Finalises the output file. Must be called after adding all features via
:py:func:`~QgsKernelDensityEstimation.addFeature`.
.. seealso:: :py:func:`prepare`
.. seealso:: :py:func:`addFeature`
%End
private:
QgsKernelDensityEstimation( const QgsKernelDensityEstimation &other );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/analysis/raster/qgskde.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
