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


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

IExtractionOp2.Rectangle Method

Extracts the cells of a raster based on a rectangle.

[Visual Basic .NET]
Public Function Rectangle ( _
    ByVal geoDataset As IGeoDataset, _
    ByVal rectangleEnvelope As IEnvelope, _
    ByVal selectInside As Boolean _
) As IGeoDataset

[C#]
public IGeoDataset Rectangle (
    IGeoDataset geoDataset,
    IEnvelope rectangleEnvelope,
    bool selectInside
);

[C++]
HRESULT Rectangle(
  IGeoDataset* geoDataset,
  IEnvelope* rectangleEnvelope,
  VARIANT_BOOL selectInside
);

[C++]

Parameters
geoDataset [in]

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

  rectangleEnvelope is a parameter of type IEnvelope*
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 identifying the cell values which will be selected inside or outside a specified rectangle

rectangleEnvelope

an IEnvelope identifying the lower-left and upper-right coordinates of the rectangle defining the selection criteria

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

selectInside

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

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

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

 

See Also

IExtractionOp2 Interface