Skip to content

Apply function to raster from service

View on GitHub

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

Image of Apply function to raster from service sample

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. Get the name of the raster argument to the function with rasterFunction.arguments!.rasterNames[0].
  4. Set the raster argument with setRaster(_:forArgumentNamed:).
  5. Create a new Raster referring to the raster function.
  6. Create a RasterLayer to visualize the computed raster.
  7. 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 ArcGIS Pro documentation.

Additional information

The raster function computation happens locally on the client device.

Tags

function, layer, raster, raster function, service

Sample Code

ApplyFunctionToRasterFromServiceView.swift
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
// Copyright 2025 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
//
//   https://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.

import ArcGIS
import SwiftUI

struct ApplyFunctionToRasterFromServiceView: View {
    /// The map that will be shown.
    @State private var map = Map(basemapStyle: .arcGISStreets)

    var body: some View {
        MapViewReader { mapViewProxy in
            // Creates a map view to display the map.
            MapView(map: map)
                .task {
                    // Creates an image service raster.
                    let imageServiceRaster = ImageServiceRaster(
                        url: URL(string: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/NLCDLandCover2001/ImageServer")!
                    )
                    // Creates a raster function from a json string.
                    let function = try! RasterFunction.fromJSON(rasterFunctionJSON) // swiftlint:disable:this force_try
                    // Sets the arguments on the function.
                    function.arguments!.setRaster(
                        imageServiceRaster,
                        forArgumentNamed: function.arguments!.rasterNames.first!
                    )
                    // Creates a raster layer from the raster function.
                    let rasterLayer = RasterLayer(raster: Raster(rasterFunction: function))
                    // Adds the raster layer to the map.
                    map.addOperationalLayer(rasterLayer)
                    // Loads the raster layer so that we can zoom to its extent.
                    try? await rasterLayer.load()
                    if let extent = rasterLayer.fullExtent {
                        await mapViewProxy.setViewpointGeometry(extent)
                    }
                }
        }
    }

    /// The raster function json string to apply to the image service raster.
    private var rasterFunctionJSON: Data {
        Data(
            #"""
            {
              "raster_function_arguments":
              {
                "z_factor":{"double":25.0,"type":"Raster_function_variable"},
                "slope_type":{"raster_slope_type":"none","type":"Raster_function_variable"},
                "azimuth":{"double":315,"type":"Raster_function_variable"},
                "altitude":{"double":45,"type":"Raster_function_variable"},
                "type":"Raster_function_arguments",
                "raster":{"name":"raster","is_raster":true,"type":"Raster_function_variable"},
                "nbits":{"int":8,"type":"Raster_function_variable"}
              },
              "raster_function":{"type":"Hillshade_function"},
              "type":"Raster_function_template"
            }
            """#.utf8
        )
    }
}

#Preview {
    ApplyFunctionToRasterFromServiceView()
}

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