View in QML C++ View on GitHub Sample viewer app
Use a stretch renderer to enhance the visual contrast of raster data for analysis.
Use case
An appropriate stretch renderer can enhance the contrast of raster imagery, allowing the user to control how their data is displayed for efficient imagery analysis.
How to use the sample
Choose one of the stretch parameter types:
Standard deviation - a linear stretch defined by the standard deviation of the pixel values
Min-max - a linear stretch based on minimum and maximum pixel values
Percent clip - a linear stretch between the defined percent clip minimum and percent clip maximum pixel values
Then configure the parameters and click 'Edit renderer'.
How it works
To apply a StretchRenderer
to a RasterLayer
:
Create a Raster
from a raster file.
Create a RasterLayer
from the raster.
Create a Basemap
from the raster layer and set it to the map.
Create a StretchRenderer
, specifying the StretchParameters
and other properties.
Set the renderer on the raster layer with rasterLayer.renderer = renderer
.
Relevant API
ColorRamp
MinMaxStretchParameters
PercentClipStretchParameters
Raster
RasterLayer
StandardDeviationStretchParameters
StretchParameters
Offline Data
To set up the sample's offline data, see the Use offline data in the samples section of the Qt Samples repository overview.
Link
Local Location
Shasta.tif raster
<userhome>
/ArcGIS/Runtime/Data/raster/Shasta.tif
About the data
This sample uses a raster imagery tile of an area of forested mountainous terrain and rivers.
See Stretch function in the ArcMap documentation for more information about the types of stretches that can be performed.
analysis, deviation, histogram, imagery, interpretation, min-max, percent clip, pixel, raster, stretch, symbology, visualization
Sample CodeRasterStretchRenderer.qml RasterStretchRenderer.qml InputWithLabel.qml
Use dark colors for code blocks Copy
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
// [WriteFile Name=RasterStretchRenderer, Category=Layers]
// [Legal]
// Copyright 2017 Esri.
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// [Legal]
import QtQuick
import QtQuick.Controls
import Esri.ArcGISRuntime
import Esri.ArcGISExtras
Rectangle {
id: rootRectangle
clip : true
width : 800
height : 600
readonly property url dataPath : {
Qt.platform.os === "ios" ?
System.writableLocationUrl(System.StandardPathsDocumentsLocation) + "/ArcGIS/Runtime/Data/raster" :
System.writableLocationUrl(System.StandardPathsHomeLocation) + "/ArcGIS/Runtime/Data/raster"
}
readonly property string minMax : "Min Max"
readonly property string percentClip : "Percent Clip"
readonly property string stdDeviation : "Standard Deviation"
readonly property var stretchTypes : [minMax, percentClip, stdDeviation]
property bool editingRenderer : false
MapView {
anchors.fill : parent
Component.onCompleted : {
// Set the focus on MapView to initially enable keyboard navigation
forceActiveFocus();
}
Map {
Basemap {
RasterLayer {
id: rasterLayer
Raster {
path : dataPath + "/Shasta.tif"
}
}
}
}
}
MinMaxStretchParameters {
id: minMaxParams
}
PercentClipStretchParameters {
id: percentClipParams
}
StandardDeviationStretchParameters {
id: stdDevParams
}
Rectangle {
visible : editButton.visible
anchors.centerIn : editButton
radius : 8
height : editButton.height + ( 16 )
width : editButton.width + ( 16 )
color : "lightgrey"
border.color : "darkgrey"
border.width : 2
opacity : 0.75
}
Button {
id: editButton
anchors {
bottom : parent .bottom
horizontalCenter : parent .horizontalCenter
margins : 32
}
visible : rendererBox.width === 0
text : "Edit Renderer"
onClicked : editingRenderer = true ;
}
Rectangle {
id: rendererBox
clip : true
anchors {
right : parent .right
top : parent .top
bottom : parent .bottom
}
color : "white"
opacity : 0.75
width : editingRenderer ? parent.width : 0
Column {
anchors {
top : parent .top
bottom : parent .bottom
margins : 24
}
width : parent .width
spacing : 16
ComboBox {
id: stretchTypeCombo
anchors.horizontalCenter : parent .horizontalCenter
property int modelWidth : 0
width : modelWidth + leftPadding + rightPadding
model : stretchTypes
Component.onCompleted : {
for ( let i = 0 ; i < model.length; ++i) {
metrics.text = model[i];
modelWidth = Math .max(modelWidth, metrics.width);
}
}
TextMetrics {
id: metrics
font : stretchTypeCombo.font
}
}
InputWithLabel {
id: minMaxMin
visible : stretchTypeCombo.currentText === minMax
spacing : 8
label : "min value"
maxRange : 255
value : 0
}
InputWithLabel {
id: minMaxMax
visible : stretchTypeCombo.currentText === minMax
spacing : 8
label : "max value"
maxRange : 255
value : 255
}
InputWithLabel {
id: percentClipMin
visible : stretchTypeCombo.currentText === percentClip
spacing : 8
label : "min value"
maxRange : 100
value : 0
}
InputWithLabel {
id: percentClipMax
visible : stretchTypeCombo.currentText === percentClip
spacing : 8
label : "max value"
maxRange : 100
value : 100
}
InputWithLabel {
id: sdFactor
visible : stretchTypeCombo.currentText === stdDeviation
spacing : 8
label : "factor"
maxRange : 25
value : 0
}
Button {
text : "Render"
anchors.horizontalCenter : parent .horizontalCenter
onClicked : {
editingRenderer = false ;
applyRendererSettings();
}
}
}
Behavior on width { PropertyAnimation { duration : 500 } }
}
//! [RasterStretchRenderer qml set renderers]
function applyRendererSettings ( ) {
const rgbRenderer = ArcGISRuntimeEnvironment.createObject( "StretchRenderer" );
if (stretchTypeCombo.currentText === minMax){
minMaxParams.minValues = [minMaxMin.value];
minMaxParams.maxValues = [minMaxMax.value];
rgbRenderer.stretchParameters = minMaxParams;
}
else if (stretchTypeCombo.currentText === percentClip){
percentClipParams.min = percentClipMin.value;
percentClipParams.max = 100 - percentClipMax.value;
rgbRenderer.stretchParameters = percentClipParams;
}
else if (stretchTypeCombo.currentText === stdDeviation){
stdDevParams.factor = sdFactor.value;
rgbRenderer.stretchParameters = stdDevParams;
}
rasterLayer.renderer = rgbRenderer;
}
//! [RasterStretchRenderer qml set renderers]
}