How to create a Hillshade function dataset


Creating a Hillshade function dataset

To create a Hillshade function dataset, follow these steps:
  1. Create the Function Arguments object.
  2. Specify the altitude, azimuth, and z factor (the scale factor for z values).
  3. Create a Raster Function object.
  4. Create a Function Raster Dataset object.
  5. Create a name object for the function raster dataset.
  6. Specify the output file name for the new dataset.
  7. Initialize the new function raster dataset with the raster function and its arguments.
The following code example shows how to create a Hillshade function raster dataset by applying the Hillshade raster function to an image:
[C#]
double altitude = 45;
double azimuth = 215;
double zFactor = (1 / 111111.0);
// Create the Function Arguments object.
IHillshadeFunctionArguments rasterFunctionArguments = (IHillshadeFunctionArguments)
    new HillshadeFunctionArguments();
// The input data can be of type IRasterDataset, IRasterBand, or IRaster.
rasterFunctionArguments.DEM = inputData;
// Specify the altitude, azimuth, and z factor (the scale factor for z values).
rasterFunctionArguments.Altitude = altitude;
rasterFunctionArguments.Azimuth = azimuth;
rasterFunctionArguments.ZFactor = zFactor;

// Create the Raster Function object.
IRasterFunction rasterFunction = new HillshadeFunction();
// Create the Function Raster Dataset object.
IFunctionRasterDataset functionRasterDataset = new FunctionRasterDataset();
// Create a name object for the Function Raster Dataset.
IFunctionRasterDatasetName functionRasterDatasetName = (IFunctionRasterDatasetName)
    new FunctionRasterDatasetName();
// Specify the output file name for the new dataset (including the .afr extension at the end).
functionRasterDatasetName.FullName = @"c:\temp\Hillshade.afr";
functionRasterDataset.FullName = (IName)functionRasterDatasetName;
// Initialize the new Function Raster Dataset with the Raster Function and its arguments.
functionRasterDataset.Init(rasterFunction, rasterFunctionArguments);
[VB.NET]
Dim altitude As Double = 45
Dim azimuth As Double = 215
Dim zFactor As Double = (1 / 111111.0)
' Create the Function Arguments object.
Dim rasterFunctionArguments As IHillshadeFunctionArguments
rasterFunctionArguments = New HillshadeFunctionArguments()
' The input data can be of type IRasterDataset, IRasterBand, or IRaster.
rasterFunctionArguments.DEM = inputData
'  Specify the altitude, azimuth, and z factor (the scale factor for z values).
rasterFunctionArguments.Altitude = altitude
rasterFunctionArguments.Azimuth = azimuth
rasterFunctionArguments.ZFactor = zFactor

' Create the Raster Function object.
Dim rasterFunction As IRasterFunction
rasterFunction = New HillshadeFunction()
' Create the Function Raster Dataset object.
Dim functionRasterDataset As IFunctionRasterDataset
functionRasterDataset = New FunctionRasterDataset()
' Create a name object for the Function Raster Dataset.
Dim functionRasterDatasetName As IFunctionRasterDatasetName
functionRasterDatasetName = New FunctionRasterDatasetName()
' Specify the output file name for the new dataset (including the .afr extension at the end).
functionRasterDatasetName.FullName = "c:\temp\Hillshade.afr"
functionRasterDataset.FullName = functionRasterDatasetName
' Initialize the new Function Raster Dataset with the Raster Function and its arguments.
functionRasterDataset.Init(rasterFunction, rasterFunctionArguments)






To use the code in this topic, reference the following assemblies in your Visual Studio project. In the code files, you will need using (C#) or Imports (VB .NET) directives for the corresponding namespaces (given in parenthesis below if different from the assembly name):
Development licensing Deployment licensing
ArcGIS for Desktop Advanced ArcGIS for Desktop Advanced
ArcGIS for Desktop Standard ArcGIS for Desktop Standard
ArcGIS for Desktop Basic ArcGIS for Desktop Basic