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


IExtractionOp2.Polygon Method (ArcObjects .NET 10.6 SDK)
ArcObjects Library Reference (SpatialAnalyst)  

IExtractionOp2.Polygon Method

Extracts the cells of a raster based on a polygon.

[Visual Basic .NET]
Public Function Polygon ( _
    ByVal geoDataset As IGeoDataset, _
    ByVal Polygon As IPolygon, _
    ByVal selectInside As Boolean _
) As IGeoDataset

[C#]
public IGeoDataset Polygon (
    IGeoDataset geoDataset,
    IPolygon Polygon,
    bool selectInside
);

[C++]
HRESULT Polygon(
  IGeoDataset* geoDataset,
  IPolygon* Polygon,
  VARIANT_BOOL selectInside
);

[C++]

Parameters
geoDataset [in]

  geoDataset is a parameter of type IGeoDataset*
Polygon [in]

  Polygon is a parameter of type IPolygon*
selectInside [in]

  selectInside is a parameter of type bool

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Remarks

geoDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

The geoDataset identifies the cell values which will be selected inside or outside of a specified polygon.

Polygon

an IPolygon defining polygon for the selection criteria

The coordinates are specified in map units and are in the same units as the geoDataset.

selectInside

a Boolean identifying which cells should be selected, those contained in or external to the input polygon

If True, the cells inside the input Polygon should be selected and written to the output Raster. All cells outside the polygon will receive NoData on the output Raster.

If False, the cells outside the input polygon should be selected and written to the output Raster. All cells inside the polygon will receive NoData on the output Raster.

 

See Also

IExtractionOp2 Interface