This document is archived and information here might be outdated.  Recommended version.


IRasterAnalysisEnvironment.Mask Property (ArcObjects .NET 10.5 SDK)
ArcObjects Library Reference (GeoAnalyst)  

IRasterAnalysisEnvironment.Mask Property

Mask allows processing to occur only for a selected set of cells.

[Visual Basic .NET]
Public Property Mask As IGeoDataset
[C#]
public IGeoDataset Mask {get; set;}
[C++]
HRESULT get_Mask(
  IGeoDataset** Mask
);
[C++]
HRESULT putref_Mask(
  IGeoDataset* Mask
);
[C++]

Parameters Mask [out, retval]
Mask is a parameter of type IGeoDataset Mask [in]
Mask is a parameter of type IGeoDataset

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Remarks

The mask can be a reference to a Raster, RasterDataset, RasterBand, or RasterDescriptor object or FeatureClass, FeatureClassDescriptor object.

The mask identifies only those cells within the analysis extent that will be considered when performing an action. Only the identified cells will be processed in subsequent output raster datasets. All other cells are characterized as nodata.

See Also

IRasterAnalysisEnvironment Interface

.NET Related Topics

GeoAnalyst | Working with the analysis environment