How to create a Clip function dataset (ArcObjects .NET 10.6 SDK)
ArcObjects Help for .NET developers > Developing with ArcGIS > Learning ArcObjects > Managing data > Working with image and raster data > Processing raster data > Function raster datasets and raster functions > How to create a Clip function dataset (ArcObjects .NET 10.6 SDK)

How to create a Clip function dataset


Creating a Clip function dataset

To create a Clip function dataset, follow these steps:
  1. Create the Function Arguments object.
  2. Set the parameters for the function.
    1. Set the clipping type.
    2. Set the extents to clip to by providing a raster envelope object.
  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 Clip function raster dataset by applying the Clip raster function to an image:
[C#]
// Create the Function Arguments object.
IClipFunctionArguments rasterFunctionArguments=(IClipFunctionArguments)new
    ClipFunctionArguments();
// The input data can be of type IRasterDataset, IRasterBand, or IRaster.
rasterFunctionArguments.Raster=inputData;
// Set the parameters for the function:
// Set the clipping type (clip outside leaves the area inside the envelope untouched)
rasterFunctionArguments.ClippingType =
    esriRasterClippingType.esriRasterClippingOutside;
// Set the extents to clip to by providing a raster envelope object.
rasterFunctionArguments.ClippingGeometry=rasterEnvelope;

// Create the Raster Function object.
IRasterFunction rasterFunction=new ClipFunction();
// 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\Clip.afr";
functionRasterDataset.FullName=(IName)functionRasterDatasetName;
// Initialize the new Function Raster Dataset with the Raster Function and its arguments.
functionRasterDataset.Init(rasterFunction, rasterFunctionArguments);
[VB.NET]
' Create the Function Arguments object.
Dim rasterFunctionArguments As IClipFunctionArguments
rasterFunctionArguments=New ClipFunctionArguments()
' The input data can be of type IRasterDataset, IRasterBand, or IRaster.
rasterFunctionArguments.Raster=inputData
' Set the parameters for the function:
' Set the clipping type (clip outside leaves the area inside the envelope untouched).
rasterFunctionArguments.ClippingType=esriRasterClippingType.esriRasterClippingOutside
' Set the extents to clip to by providing a raster envelope object.
rasterFunctionArguments.ClippingGeometry=rasterEnvelope

' Create the Raster Function object.
Dim rasterFunction As IRasterFunction
rasterFunction=New ClipFunction()
' 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\Clip.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 Desktop Advanced ArcGIS Desktop Advanced
ArcGIS Desktop Standard ArcGIS Desktop Standard
ArcGIS Desktop Basic ArcGIS Desktop Basic