Latest Contributions by XuguangWang

ArcGIS Pro SDK for .Net allows you to extend the ArcGIS Pro user interface by creating custom add-ins leveraging different GIS functionalities. In this blog, we will take a look at how to execute Spatial Analyst tools in your add-in using the ArcGIS Pro SDK. How to execute a geoprocessing tool The ArcGIS.Desktop.Core.Geoprocessing namespace in the SDK provides a Geoprocessing class to help execute a geoprocessing tool. The Geoprocessing class within the namespace offers necessary methods to specify the input parameters, set up environment settings, and execute the geoprocessing tool. The static method, ExecuteToolAsync is used to execute the tool. The first argument for ExecuteToolAsync is the geoprocessing tool name as a string. To specify a tool uniquely, the tool name must be appended with its toolbox alias. For example, the Copy Features tool is in the data management toolbox, and the alias of the data management toolbox is management. Therefore, to execute the Copy Features tool, the tool name should be specified as CopyFeatures_management. Without the toolbox alias, or with a misspelled toolbox alias, an error will be returned and the tool will not be executed because the geoprocessing framework is not able to find the tool. The second argument for ExecuteToolAsync is the tool parameter values array, which holds all the input and output parameter values for the geoprocessing tool. Do not create the array yourself. Simply call the method MakeValueArray, to create it, passing in all input and output parameter values as arguments. Additionally, you may want to specify an environment setting for the tool execution. The third argument for ExecuteToolAsync allows you to do that. Like the input/output parameters, the environment settings also need to be specified in an array. Again, no need to create the array by yourself, simply call the method MakeEnvironmentArray to make one. The rest of the arguments for ExecuteToolAsync are optional. As an asynchronous method, ExecuteToolAsync will start the geoprocessing tool execution in a different thread other than the user interface (UI) thread, which allows the ArcGIS Pro UI to remain active while the tool executes. How to execute a Spatial Analyst tool Executing a Spatial Analyst tool is no different than any other geoprocessing tool. All we need to do is supply a tool name with an appropriate toolbox alias, which is sa. The following example will walk you through a C# example on how to execute the Zonal Statistics tool to calculate average elevation for each zone, using SDK. Let’s start by specifying the tool input and output parameters: // declaring tool parameter variables string inZoneRas = @" c:\data\county.tif"  ; // input zone raster string zoneField = "Value"; // zone field string inValueRas = @" c:\data\elevation.tif"  ; // input valueraster string outRaster = @" c:\output\outzs01.tif"  ; // output raster string statType =  "MEAN"  ; // statistics type bool ignoreNoData = true ; // ignore NoData option Now let’s create the first array with the above parameter values using the Geoprocessing.MakeValueArray method: // create an array for the input parameter values var valueArray = Geoprocessing.MakeValueArray(inZoneRas, zoneField, inValueRas, outRaster, statType, ignoreNoData); Next, create another array for environment settings using Geoprocessing.MakeEnvironmentArray to set the cell size for analysis and to overwrite output if it exists: // create an array for the environment settings var envArray = Geoprocessing.MakeEnvironmentArray(overwriteoutput: true, cellSize: 30); Finally, let’s execute the tool by calling the ExecuteToolAsync method, passing in the tool name, the tool parameter values array, and the environment settings array that we created above. Notice that the tool name ‘ZonalStatistics’ is appended with its toolbox alias ‘sa’, which refers to the Spatial Analyst toolbox: // run ZonalStatistics var gpresult1 = await Geoprocessing.ExecuteToolAsync( "ZonalStatistics_sa" , valueArray, envArray); Because the Spatial Analyst is an extension product, a license is required in order to use its capabilities. However, we did not enable the license in the preceding code snippet as in our case, it is enabled through the ArcGIS Pro application. If the Spatial Analyst license is not already enabled, the tool execution will fail with a licensing error. To enable the Spatial Analyst license, configure your licensing options from the ArcGIS Pro application. How to execute a map algebra expression Now that we have learned how to execute a Spatial Analyst tool using the ArcGIS Pro SDK, let’s look at another example. In raster modeling, we often need to execute map algebra expression to solve a complex problem. In the Spatial Analyst toolbox, the tool that allows us to execute map algebra expression is called Raster Calculator. In your add-in, you may take advantage of the Raster Calculator tool to execute single-line map algebra expressions. The Raster Calculator tool has two parameters only. The first parameter is the map algebra expression itself. The second parameter is the output raster, which saves the result of the calculation. In the example below, let’s build a map algebra expression to find the land uses for areas with slope greater than 30 degrees and aspect less than 120 degrees, and use the Raster Calculator tool to execute it. First, let’s specify the input raster datasets that will be used in our map algebra expression: // input raster datasets for the map algebra expression string inRas1 = @" c:\data\in_slope.tif"  ; string inRas2 = @" c:\data\in_aspect.tif"  ; string inRas3 = @" c:\data\in_landuse.tif"  ; Now, let’s build the map algebra expression. Notice that the input raster datasets are embedded in the expression itself, enclosed by single quotation marks: // define the map algebra expression string maExpression = String.Format( "Con((‘{0}’ > 30) & (‘{1}’ < 120), ‘{2}’)" ,inRas1, inRas2, inRas3); We need another variable to specify the output raster: // define the output raster string outRaster = @ "c:\output\outrascal01.tif"  ; Now we can create an array using maExpression and outRaster: // make the input parameter values array var valueArray = Geoprocessing.MakeValueArray(maExpression, outRaster); Finally, we kick off the Raster Calculator tool, which will execute the map algebra expression and save the result in outRaster: // execute the Raster calculator tool to process the map algebra expression var gpresult1 = await Geoprocessing.ExecuteToolAsync( "RasterCalculator_sa" , valueArray); Summary Now that you are comfortable executing Spatial Analyst tools and map algebra expressions, you can perform raster modeling in your add-ins. If you need more information, check out our help pages on ArcGIS Pro SDK and ArcGIS Pro Spatial Analyst. ... View more

The Viewshed 2 tool is a new visibility analysis tool released in ArcGIS 10.3 and ArcGIS Pro 1.0. The tool takes advantage of a GPU processor by default if one is available on your computer. As GPU graphics cards are commonly available on most of the recent computers, GPU (or CUDA) related error is likely the most common error that you may run into when the Viewshed 2 tool is used for the first time. This blog aims to explain how to resolve the most typical GPU errors that you can encounter while trying to execute the Viewshed 2 tool. There are two types of errors: I. GPU error at the beginning of the tool execution When the Viewshed 2 tool just starts to execute, a GPU error occurs and the tool fails. Example error messages are as follows: ERROR 010514: GPU exception: CUDA Exception. Driver code: CUDA_ERROR_NO_BINARY_FOR_GPU (209). ERROR 010461: GPU exception: CUDA Exception. Driver code: CUDA_ERROR_INVALID_VALUE (1). These errors usually indicate that your GPU driver is out of date. To fix this issue, go to the NVIDIA driver update page and search for and install the latest driver for your GPU card. To take this into effect you may have to restart the computer. Rerun the Viewshed 2 tool again. II. GPU error during the tool execution If your computer has only one GPU card, by default it will be shared between Windows display and the Viewshed 2 analysis. In this case, the following warning message will be reported at the beginning of the tool execution: WARNING 010453: The GPU being used is connected to your display. This may cause the computer to appear unresponsive. The display driver may reboot the GPU if the computation takes too long. If an individual GPU task takes longer than the number of seconds set by the Windows TdrDelay (Timeout Detection and Recovery Delay) registry key the OS may reboot the GPU. This will cause the tool to fail during tool execution. The tool may return the following error messages: ERROR 010461: GPU exception: CUDA Exception. Driver code: CUDA_ERROR_LAUNCH_TIMEOUT (702). ERROR 010461: GPU exception: CUDA Exception. Driver code: CUDA_ERROR_LAUNCH_FAILED (719). To fix such errors, the value of the registry key TdrDelay needs to be increased. By default, the TdrDelay key value is 2 seconds, it needs to be set to a larger value, such as 100 seconds. This registry key is usually found under the registry path HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\GraphicsDrivers. If it does not exist, you may need to add it and set the value appropriately. Restart the computer for the change to take effect. Please take caution when modifying the system registry by either making backup or having a qualified system analyst to perform the change. If you have more than one GPU card in your system, you may still run into this error if the tool uses the display GPU to perform analysis. To avoid this error is it is recommended to direct the analysis computation to other non-display GPU devices. Follow the given steps below to accomplish this: Add a new OS environment variable CUDA_VISIBLE_DEVICES, if it does not exist. Set the value of the environment variable CUDA_VISIBLE_DEVICES to the GPU ID (0 for the first GPU, 1 for the second GPU, etc.) that you want to use for analysis. Restart ArcMap or ArcGIS Pro application, if you are using it for the analysis. Rerun the tool again. These are some of the common GPU errors and solutions to fix them. If the Viewshed 2 tool still fails to execute due to other GPU or CUDA issues, remember that you can always disable GPU from being used and perform the analysis using CPU only. You can do this using the following steps: Add a new OS environment variable CUDA_VISIBLE_DEVICES, if it does not exist. Set the value of the environment variable CUDA_VISIBLE_DEVICES to -1 (or a number larger than the count of GPU devices on your computer). Restart ArcMap or ArcGIS Pro application, if you are using it for the analysis. Rerun the tool again. For more details on how to configure GPU devices for analysis, see GPU processing with Spatial Analyst. ... View more