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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/raster/qgsrasterlayerelevationproperties.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsRasterLayerElevationProperties : QgsMapLayerElevationProperties
{
%Docstring(signature="appended")
Raster layer specific subclass of
:py:class:`QgsMapLayerElevationProperties`.
.. versionadded:: 3.26
%End
%TypeHeaderCode
#include "qgsrasterlayerelevationproperties.h"
%End
public:
QgsRasterLayerElevationProperties( QObject *parent /TransferThis/ );
%Docstring
Constructor for QgsRasterLayerElevationProperties, with the specified
``parent`` object.
%End
~QgsRasterLayerElevationProperties();
virtual bool hasElevation() const;
virtual QDomElement writeXml( QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context );
virtual bool readXml( const QDomElement &element, const QgsReadWriteContext &context );
virtual QgsRasterLayerElevationProperties *clone() const /Factory/;
virtual QString htmlSummary() const;
virtual bool isVisibleInZRange( const QgsDoubleRange &range, QgsMapLayer *layer = 0 ) const;
virtual QgsDoubleRange calculateZRange( QgsMapLayer *layer ) const;
virtual QList< double > significantZValues( QgsMapLayer *layer ) const;
virtual bool showByDefaultInElevationProfilePlots() const;
virtual QgsMapLayerElevationProperties::Flags flags() const;
bool isEnabled() const;
%Docstring
Returns ``True`` if the elevation properties are enabled, i.e. the
raster layer values represent an elevation surface.
.. seealso:: :py:func:`setEnabled`
%End
void setEnabled( bool enabled );
%Docstring
Sets whether the elevation properties are enabled, i.e. the raster layer
values represent an elevation surface.
.. seealso:: :py:func:`isEnabled`
%End
Qgis::RasterElevationMode mode() const;
%Docstring
Returns the elevation mode.
.. seealso:: :py:func:`setMode`
.. versionadded:: 3.38
%End
void setMode( Qgis::RasterElevationMode mode );
%Docstring
Sets the elevation ``mode``.
.. seealso:: :py:func:`mode`
.. versionadded:: 3.38
%End
int bandNumber() const;
%Docstring
Returns the band number from which the elevation should be taken.
.. note::
This is only considered when :py:func:`~QgsRasterLayerElevationProperties.mode` is :py:class:`Qgis`.RasterElevationMode.RepresentsElevationSurface.
.. seealso:: :py:func:`setBandNumber`
%End
void setBandNumber( int band );
%Docstring
Sets the ``band`` number from which the elevation should be taken.
.. note::
This is only considered when :py:func:`~QgsRasterLayerElevationProperties.mode` is :py:class:`Qgis`.RasterElevationMode.RepresentsElevationSurface.
.. seealso:: :py:func:`bandNumber`
%End
QgsDoubleRange fixedRange() const;
%Docstring
Returns the fixed elevation range for the raster.
.. note::
This is only considered when :py:func:`~QgsRasterLayerElevationProperties.mode` is :py:class:`Qgis`.RasterElevationMode.FixedElevationRange.
.. note::
When a fixed range is set any :py:func:`~QgsRasterLayerElevationProperties.zOffset` and :py:func:`~QgsRasterLayerElevationProperties.zScale` is ignored.
.. seealso:: :py:func:`setFixedRange`
.. versionadded:: 3.38
%End
void setFixedRange( const QgsDoubleRange &range );
%Docstring
Sets the fixed elevation ``range`` for the raster.
.. note::
This is only considered when :py:func:`~QgsRasterLayerElevationProperties.mode` is :py:class:`Qgis`.RasterElevationMode.FixedElevationRange.
.. note::
When a fixed range is set any :py:func:`~QgsRasterLayerElevationProperties.zOffset` and :py:func:`~QgsRasterLayerElevationProperties.zScale` is ignored.
.. seealso:: :py:func:`fixedRange`
.. versionadded:: 3.38
%End
QMap<int, QgsDoubleRange> fixedRangePerBand() const;
%Docstring
Returns the fixed elevation range for each band.
.. note::
This is only considered when :py:func:`~QgsRasterLayerElevationProperties.mode` is :py:class:`Qgis`.RasterElevationMode.FixedRangePerBand.
.. note::
When a fixed range is set any :py:func:`~QgsRasterLayerElevationProperties.zOffset` and :py:func:`~QgsRasterLayerElevationProperties.zScale` is ignored.
.. seealso:: :py:func:`setFixedRangePerBand`
.. versionadded:: 3.38
%End
void setFixedRangePerBand( const QMap<int, QgsDoubleRange> &ranges );
%Docstring
Sets the fixed elevation range for each band.
.. note::
This is only considered when :py:func:`~QgsRasterLayerElevationProperties.mode` is :py:class:`Qgis`.RasterElevationMode.FixedRangePerBand.
.. note::
When a fixed range is set any :py:func:`~QgsRasterLayerElevationProperties.zOffset` and :py:func:`~QgsRasterLayerElevationProperties.zScale` is ignored.
.. seealso:: :py:func:`fixedRangePerBand`
.. versionadded:: 3.38
%End
QgsDoubleRange elevationRangeForPixelValue( QgsRasterLayer *layer, int band, double pixelValue ) const;
%Docstring
Returns the elevation range corresponding to a raw pixel value from the
specified ``band``.
Returns an infinite range if the pixel value does not correspond to an
elevation value.
.. versionadded:: 3.38
%End
int bandForElevationRange( QgsRasterLayer *layer, const QgsDoubleRange &range ) const;
%Docstring
Returns the band corresponding to the specified ``range``.
.. note::
This is only considered when :py:func:`~QgsRasterLayerElevationProperties.mode` is :py:class:`Qgis`.RasterElevationMode.FixedRangePerBand or
:py:class:`Qgis`.RasterElevationMode.DynamicRangePerBand. For other modes it will always return -1.
.. versionadded:: 3.38
%End
QgsLineSymbol *profileLineSymbol() const;
%Docstring
Returns the line symbol used to render the raster profile in elevation
profile plots.
.. seealso:: :py:func:`setProfileLineSymbol`
%End
void setProfileLineSymbol( QgsLineSymbol *symbol /Transfer/ );
%Docstring
Sets the line ``symbol`` used to render the raster profile in elevation
profile plots.
Ownership of ``symbol`` is transferred to the plot.
.. seealso:: :py:func:`profileLineSymbol`
%End
QgsFillSymbol *profileFillSymbol() const;
%Docstring
Returns the fill symbol used to render the raster profile in elevation
profile plots.
.. seealso:: :py:func:`setProfileFillSymbol`
%End
void setProfileFillSymbol( QgsFillSymbol *symbol /Transfer/ );
%Docstring
Sets the fill ``symbol`` used to render the raster profile in elevation
profile plots.
Ownership of ``symbol`` is transferred to the plot.
.. seealso:: :py:func:`profileFillSymbol`
%End
Qgis::ProfileSurfaceSymbology profileSymbology() const;
%Docstring
Returns the symbology option used to render the raster profile in
elevation profile plots.
.. seealso:: :py:func:`setProfileSymbology`
%End
void setProfileSymbology( Qgis::ProfileSurfaceSymbology symbology );
%Docstring
Sets the ``symbology`` option used to render the raster profile in
elevation profile plots.
.. seealso:: :py:func:`setProfileSymbology`
%End
double elevationLimit() const;
%Docstring
Returns the elevation limit, which is used when
:py:func:`~QgsRasterLayerElevationProperties.profileSymbology` is
:py:class:`Qgis`.ProfileSurfaceSymbology.FillBelow or
:py:class:`Qgis`.ProfileSurfaceSymbology.FillAbove to limit the fill to
a specific elevation range.
By default this is NaN, which indicates that there is no elevation
limit.
.. seealso:: :py:func:`setElevationLimit`
.. versionadded:: 3.32
%End
void setElevationLimit( double limit );
%Docstring
Sets the elevation ``limit``, which is used when
:py:func:`~QgsRasterLayerElevationProperties.profileSymbology` is
:py:class:`Qgis`.ProfileSurfaceSymbology.FillBelow or
:py:class:`Qgis`.ProfileSurfaceSymbology.FillAbove to limit the fill to
a specific elevation range.
Set to NaN to indicate that there is no elevation limit.
.. seealso:: :py:func:`elevationLimit`
.. versionadded:: 3.32
%End
static bool layerLooksLikeDem( QgsRasterLayer *layer );
%Docstring
Returns ``True`` if a raster ``layer`` looks like a DEM.
This method applies some heuristics to ``layer`` to determine whether it
looks like a candidate for a DEM layer.
Specifically, it checks:
- the layer's name for DEM-like wording hints
- whether the layer contains a single band
- whether the layer contains an attribute table (if so, it's unlikely to
be a DEM)
- the layer's data type
.. versionadded:: 3.32
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/raster/qgsrasterlayerelevationproperties.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
