Raster function (service)

View inC++QMLView on GitHubSample viewer app

Load a raster from a service, then apply a function to it.

screenshot

Use case

Raster functions allow processing operations that can be applied to one or more rasters on the fly. Functions can be applied to rasters that come from a service. A land survey agency may apply hillshade and aspect functions to rasters with elevation data in order to better determine the topography of a landscape and to make further planning decisions.

How to use the sample

The raster function is applied automatically when the sample starts and the result is displayed.

How it works

  1. Create the ImageServiceRaster referring to the image server URL.
  2. Create the RasterFunction from a JSON string.
  3. Set the raster argument with rasterFunction.setRaster(rasterName, imageServiceRaster).
  4. Create a new Raster referring to the raster function.
  5. Create a RasterLayer to visualize the computed raster.
  6. Display the raster.

Relevant API

  • ImageServiceRaster
  • Raster
  • RasterFunction
  • RasterFunctionArguments
  • RasterLayer

About the data

The sample applies a hillshade function to a raster produced from the National Land Cover Database, NLCDLandCover2001. You can learn more about the hillshade function in the ArcMap documentation.

Additional information

The raster function computation happens locally on the client device.

Tags

function, layer, raster, raster function, service

Sample Code

RasterFunctionService.qml
Use dark colors for code blocksCopy
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
// [WriteFile Name=RasterFunctionService, 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 2.6
import QtQuick.Controls 2.2
import Esri.ArcGISRuntime 100.15
import Esri.ArcGISExtras 1.1

Rectangle {
    id: rootRectangle
    clip: true
    width: 800
    height: 600

    readonly property string dataPath: System.userHomePath + "/ArcGIS/Runtime/Data/raster/"

    MapView {
        id: mapView
        anchors.fill: parent

        Component.onCompleted: {
            // Set the focus on MapView to initially enable keyboard navigation
            forceActiveFocus();
        }

        Map {
            // create a basemap from a tiled layer and add to the map
            Basemap {
                initStyle: Enums.BasemapStyleArcGISStreets
            }

            // create and add a raster layer to the map
            RasterLayer {
                // create the raster layer from an image service raster
                ImageServiceRaster {
                    id: imageServiceRaster
                    url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/NLCDLandCover2001/ImageServer"

                    // zoom to the extent of the raster once it's loaded
                    onLoadStatusChanged: {
                        if (loadStatus === Enums.LoadStatusLoaded) {
                            const scale = 50000000;
                            mapView.setViewpointCenterAndScale(imageServiceRaster.serviceInfo.fullExtent.center, scale);
                        }
                    }
                }
            }
        }
    }

    // Create a button to apply the raster function
    Rectangle {
        id: button
        property bool pressed: false

        anchors {
            right: parent.right
            bottom: parent.bottom
            rightMargin: 20
            bottomMargin: 40
        }

        width: 45
        height: width
        color: pressed ? "#959595" : "#D6D6D6"
        radius: 100
        border {
            color: "#585858"
            width: 1
        }

        Image {
            anchors {
                centerIn: parent
            }
            width: 26
            height: width
            source: "qrc:/Samples/Layers/RasterFunctionService/RasterImageAnalysisHillshade.png"
        }

        MouseArea {
            anchors.fill: parent
            onPressed: button.pressed = true
            onReleased: button.pressed = false
            onClicked: applyRasterFunction()
        }
    }

    function applyRasterFunction() {
        if (!hillShadeJson.exists) {
            console.log("JSON file for the raster function does not exist");
            return;
        }

        //! [ImageServiceRaster Apply a raster function]
        // create raster function
        const rasterFunction = ArcGISRuntimeEnvironment.createObject("RasterFunction", {path: dataPath + "/hillshade_simplified.json"});
        // get the arguments
        const rasterFunctionArguments = rasterFunction.arguments;
        // set the raster
        rasterFunctionArguments.setRaster("raster", imageServiceRaster);

        // create the raster from the raster function
        const raster = ArcGISRuntimeEnvironment.createObject("Raster", { rasterFunction: rasterFunction });

        // create raster layer from raster
        const rasterLayer = ArcGISRuntimeEnvironment.createObject("RasterLayer", { raster: raster });
        //! [ImageServiceRaster Apply a raster function]

        // add raster to map
        mapView.map.operationalLayers.clear();
        //! [ImageServiceRaster qml add raster operational]
        mapView.map.operationalLayers.append(rasterLayer);
        //! [ImageServiceRaster qml add raster operational]
    }

    FileInfo {
        id: hillShadeJson
        url: dataPath + "/hillshade_simplified.json"
    }
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.