Viewshed geoprocessing

View on GitHub
Sample viewer app

Calculate a viewshed using a geoprocessing service, in this case showing what parts of a landscape are visible from points on mountainous terrain.

Image of viewshed geoprocessing

Use case

A viewshed is used to highlight what is visible from a given point. A viewshed could be created to show what a hiker might be able to see from a given point at the top of a mountain. Equally, a viewshed could also be created from a point representing the maximum height of a proposed wind turbine to see from what areas the turbine would be visible.

How to use the sample

Click the map to see all areas visible from that point within a 15km radius. Clicking on an elevated area will highlight a larger part of the surrounding landscape. It may take a few seconds for the task to run and send back the results.

How it works

  1. Create a GeoprocessingTask object with the URL set to a geoprocessing service endpoint.
  2. Create a FeatureCollectionTable object and add a new Feature object whose geometry is the viewshed's observer Point.
  3. Make a GeoprocessingParameters object passing in the observer point.
  4. Use the geoprocessing task to create a GeoprocessingJob object with the parameters.
  5. Start the job and wait for it to complete and return a GeoprocessingResult object.
  6. Get the resulting GeoprocessingFeatures object.
  7. Iterate through the viewshed features to use their geometry or display the geometry in a new Graphic object.

Relevant API

  • FeatureCollectionTable
  • GeoprocessingFeatures
  • GeoprocessingJob
  • GeoprocessingParameters
  • GeoprocessingResult
  • GeoprocessingTask

Tags

geoprocessing, heat map, heatmap, viewshed

Sample Code

ViewshedGeoprocessingSample.java
                                                                                                                                                                                                                                                  
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
/*
 * Copyright 2018 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.
 */

package com.esri.samples.viewshed_geoprocessing;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.concurrent.ExecutionException;

import javafx.application.Application;
import javafx.geometry.Point2D;
import javafx.geometry.Pos;
import javafx.scene.Scene;
import javafx.scene.control.Alert;
import javafx.scene.control.Alert.AlertType;
import javafx.scene.control.ProgressIndicator;
import javafx.scene.input.MouseButton;
import javafx.scene.layout.StackPane;
import javafx.scene.paint.Color;
import javafx.stage.Stage;

import com.esri.arcgisruntime.ArcGISRuntimeEnvironment;
import com.esri.arcgisruntime.concurrent.Job;
import com.esri.arcgisruntime.concurrent.ListenableFuture;
import com.esri.arcgisruntime.data.Feature;
import com.esri.arcgisruntime.data.FeatureCollectionTable;
import com.esri.arcgisruntime.data.FeatureSet;
import com.esri.arcgisruntime.data.Field;
import com.esri.arcgisruntime.geometry.GeometryType;
import com.esri.arcgisruntime.geometry.Point;
import com.esri.arcgisruntime.loadable.LoadStatus;
import com.esri.arcgisruntime.mapping.ArcGISMap;
import com.esri.arcgisruntime.mapping.BasemapStyle;
import com.esri.arcgisruntime.mapping.Viewpoint;
import com.esri.arcgisruntime.mapping.view.Graphic;
import com.esri.arcgisruntime.mapping.view.GraphicsOverlay;
import com.esri.arcgisruntime.mapping.view.MapView;
import com.esri.arcgisruntime.symbology.ColorUtil;
import com.esri.arcgisruntime.symbology.FillSymbol;
import com.esri.arcgisruntime.symbology.SimpleFillSymbol;
import com.esri.arcgisruntime.symbology.SimpleMarkerSymbol;
import com.esri.arcgisruntime.symbology.SimpleRenderer;
import com.esri.arcgisruntime.tasks.geoprocessing.GeoprocessingFeatures;
import com.esri.arcgisruntime.tasks.geoprocessing.GeoprocessingJob;
import com.esri.arcgisruntime.tasks.geoprocessing.GeoprocessingParameters;
import com.esri.arcgisruntime.tasks.geoprocessing.GeoprocessingResult;
import com.esri.arcgisruntime.tasks.geoprocessing.GeoprocessingTask;

public class ViewshedGeoprocessingSample extends Application {

  private MapView mapView;
  private GeoprocessingJob geoprocessingJob;
  // keep loadables in scope to avoid garbage collection
  private GeoprocessingTask geoprocessingTask;
  private FeatureCollectionTable featureCollectionTable;

  @Override
  public void start(Stage stage) {

    try {
      // create stack pane and application scene
      StackPane stackPane = new StackPane();
      Scene scene = new Scene(stackPane);

      // set title, size, and add scene to stage
      stage.setTitle("Viewshed Geoprocessing Sample");
      stage.setWidth(800);
      stage.setHeight(700);
      stage.setScene(scene);
      stage.show();

      // authentication with an API key or named user is required to access basemaps and other location services
      String yourAPIKey = System.getProperty("apiKey");
      ArcGISRuntimeEnvironment.setApiKey(yourAPIKey);

      // create a map with the topographic basemap style
      ArcGISMap map = new ArcGISMap(BasemapStyle.ARCGIS_TOPOGRAPHIC);

      // create a map view and set the map to it
      mapView = new MapView();
      mapView.setMap(map);

      // set a viewpoint on the map view
      mapView.setViewpoint(new Viewpoint(45.3790902612337, 6.84905317262762, 144447));

      // create an input graphics overlay to show red point markers where the user clicks
      SimpleMarkerSymbol pointSymbol = new SimpleMarkerSymbol(SimpleMarkerSymbol.Style.CIRCLE, 0xFFFF0000, 10);
      SimpleRenderer renderer = new SimpleRenderer(pointSymbol);
      GraphicsOverlay inputGraphicsOverlay = new GraphicsOverlay();
      inputGraphicsOverlay.setRenderer(renderer);

      // create an output graphics overlay to show the viewsheds as orange areas
      int fillColor = ColorUtil.colorToArgb(Color.rgb(226, 119, 40, 0.5));
      FillSymbol fillSymbol = new SimpleFillSymbol(SimpleFillSymbol.Style.SOLID, fillColor, null);
      GraphicsOverlay outputGraphicsOverlay = new GraphicsOverlay();
      outputGraphicsOverlay.setRenderer(new SimpleRenderer(fillSymbol));

      // add the graphics overlays to the map view
      mapView.getGraphicsOverlays().addAll(Arrays.asList(inputGraphicsOverlay, outputGraphicsOverlay));

      // show progress indicator when geoprocessing task is loading or geoprocessing job is running
      ProgressIndicator progress = new ProgressIndicator(ProgressIndicator.INDETERMINATE_PROGRESS);
      progress.setMaxWidth(30);

      // create the geoprocessing task with the service URL and load it
      geoprocessingTask = new GeoprocessingTask("https://sampleserver6.arcgisonline" +
          ".com/arcgis/rest/services/Elevation/ESRI_Elevation_World/GPServer/Viewshed");
      geoprocessingTask.loadAsync();

      geoprocessingTask.addDoneLoadingListener(() -> {
        if (geoprocessingTask.getLoadStatus() == LoadStatus.LOADED) {
          // hide the progress when the geoprocessing task is done loading and enable the click event
          progress.setVisible(false);

          mapView.setOnMouseClicked(e -> {
            // check that the primary mouse button was clicked and any previous geoprocessing job has been canceled
            if (e.isStillSincePress() && e.getButton() == MouseButton.PRIMARY && geoprocessingJob == null) {

              // clear previous user click location and the viewshed geoprocessing task results
              inputGraphicsOverlay.getGraphics().clear();
              outputGraphicsOverlay.getGraphics().clear();

              // show a graphic in the input graphics overlay at the clicked location
              Point2D point2D = new Point2D(e.getX(), e.getY());
              Point point = mapView.screenToLocation(point2D);
              Graphic inputGraphic = new Graphic(point);
              inputGraphicsOverlay.getGraphics().add(inputGraphic);

              progress.setVisible(true);
              // get the default geoprocessing parameters
              ListenableFuture<GeoprocessingParameters> defaultParameters = geoprocessingTask.createDefaultParametersAsync();
              defaultParameters.addDoneListener(() -> {
                try {
                  GeoprocessingParameters parameters = defaultParameters.get();

                  // create required viewshed fields
                  List<Field> fields = Collections.singletonList(Field.createString("observer", "", 8));

                  // create a feature collection table (used as a parameter to the geoprocessing job)
                  featureCollectionTable = new FeatureCollectionTable(fields,
                      GeometryType.POINT, point.getSpatialReference());
                  featureCollectionTable.loadAsync();

                  featureCollectionTable.addDoneLoadingListener(() -> {
                    // create a new feature with the geometry of the clicked location and add it to the table
                    Feature newFeature = featureCollectionTable.createFeature();
                    newFeature.setGeometry(point);

                    featureCollectionTable.addFeatureAsync(newFeature).addDoneListener(() -> {
                      // set the required parameters for viewshed
                      parameters.setProcessSpatialReference(featureCollectionTable.getSpatialReference());
                      parameters.setOutputSpatialReference(featureCollectionTable.getSpatialReference());
                      parameters.getInputs().put("Input_Observation_Point", new GeoprocessingFeatures(featureCollectionTable));

                      // create a geoprocessing job from the task with the parameters
                      geoprocessingJob = geoprocessingTask.createJob(parameters);

                      // start the job and wait for the result
                      geoprocessingJob.start();
                      geoprocessingJob.addJobDoneListener(() -> {
                        if (geoprocessingJob.getStatus() == Job.Status.SUCCEEDED) {
                          // get the viewshed from the job's result
                          GeoprocessingResult geoprocessingResult = geoprocessingJob.getResult();
                          GeoprocessingFeatures resultFeatures = (GeoprocessingFeatures) geoprocessingResult.getOutputs().get("Viewshed_Result");

                          // loop through the result features to get the viewshed geometries
                          FeatureSet featureSet = resultFeatures.getFeatures();
                          for (Feature feature : featureSet) {
                            // add the viewshed geometry as a graphic to the output graphics overlay
                            Graphic graphic = new Graphic(feature.getGeometry());
                            outputGraphicsOverlay.getGraphics().add(graphic);
                          }
                        } else {
                          // remove the input and show an error if the job fails
                          inputGraphicsOverlay.getGraphics().remove(inputGraphic);
                          new Alert(AlertType.ERROR, "Geoprocessing job failed. Try again.").show();
                        }
                        // hide the progress when the job is complete
                        progress.setVisible(false);
                        // cancel the job if it's still going and set it to null to re-enable the mouse click listener
                        if (geoprocessingJob != null) {
                          geoprocessingJob.cancel();
                          geoprocessingJob = null;
                        }
                      });
                    });
                  });
                } catch (InterruptedException | ExecutionException ex) {
                  new Alert(AlertType.ERROR, "Error creating default geoprocessing parameters").show();
                }
              });
            }
          });
        } else {
          new Alert(AlertType.ERROR, "Failed to load geoprocessing task").show();
        }
      });

      // and the mapView and progress indicator to the stack pane
      stackPane.getChildren().addAll(mapView, progress);
      StackPane.setAlignment(progress, Pos.CENTER);
    } catch (Exception e) {
      // on any error, display the stack trace.
      e.printStackTrace();
    }
  }

  /**
   * Stops and releases all resources used in application.
   */
  @Override
  public void stop() {

    if (mapView != null) {
      mapView.dispose();
    }
  }

  /**
   * Opens and runs application.
   *
   * @param args arguments passed to this application
   */
  public static void main(String[] args) {

    Application.launch(args);
  }
}

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