com.esri.arcgis.spatialanalyst
Class RasterExtractionOp

java.lang.Object
  extended by com.esri.arcgis.spatialanalyst.RasterExtractionOp
All Implemented Interfaces:
IGeoAnalysisEnvironment, IRasterAnalysisEnvironment, com.esri.arcgis.interop.RemoteObjRef, IExtractionOp, IExtractionOp2, ISupportErrorInfo, Serializable

public class RasterExtractionOp
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterAnalysisEnvironment, IExtractionOp, IExtractionOp2, ISupportErrorInfo

A mechanism for performing operations that extract cells from rasters.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
RasterExtractionOp()
          Constructs a RasterExtractionOp using ArcGIS Engine.
RasterExtractionOp(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterExtractionOp theRasterExtractionOp = (RasterExtractionOp) obj;
 
Method Summary
 IGeoDataset attribute(IRasterDescriptor raster)
          Extracts the cells of a raster based on a logical query.
 IGeoDataset circle(IGeoDataset geoDataset, ICircularArc circle, boolean selectInside)
          Extracts the cells of a raster based on a circle.
 boolean equals(Object o)
          Compare this object with another
 IGeoDataset extractValuesToPoints(IGeoDataset pointDataset, IGeoDataset valueRaster, boolean interpolateValues, boolean allAttributes)
          Extracts cell values from point features overlayed on a raster.
 void getCellSize(int[] envType, double[] cellSize)
          Gets the type and value of cell size in the RasterAnalysis.
static String getClsid()
          getClsid.
 String getDefaultOutputRasterPrefix()
          The default output raster prefix.
 String getDefaultOutputVectorPrefix()
          The default output vector prefix.
 void getExtent(int[] envType, IEnvelope[] extent)
          Gets the type and values of extent in the RasterAnalysis.
 IGeoDataset getMask()
          Mask allows processing to occur only for a selected set of cells.
 ISpatialReference getOutSpatialReference()
          The output spatial reference of GeoAnalysis.
 IWorkspace getOutWorkspace()
          The output workspace of GeoAnalysis.
 int getVerifyType()
          The verify type of the RasterAnalysis.
 int hashCode()
          the hashcode for this object
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 IGeoDataset points(IGeoDataset geoDataset, IPointCollection points, boolean selectInside)
          Extracts the cells of a raster based on points.
 IGeoDataset polygon(IGeoDataset geoDataset, IPolygon polygon, boolean selectInside)
          Extracts the cells of a raster based on a polygon.
 IGeoDataset raster(IGeoDataset geoDataset, IGeoDataset maskRaster)
          Extracts the cells of a raster whose corresponding cells in the mask raster have valid value.
 IGeoDataset rectangle(IGeoDataset geoDataset, IEnvelope rectangleEnvelope, boolean selectInside)
          Extracts the cells of a raster based on a rectangle.
 void reset()
          Remove all previously stored default rasteranalysis environments.
 void restoreToPreviousDefaultEnvironment()
          Restores to the previous default raster analysis environment.
 ITable sample(IGeoDataset locationDataset, IGeoDataset collectionOfRasters, int resampleType)
          Extracts the cells of a raster based on a sample.
 void setAsNewDefaultEnvironment()
          Sets the raster analysis environment of the object as new default environment.
 void setCellSize(int envType, Object cellSizeProvider)
          Sets the type and value of cell size in the RasterAnalysis.
 void setDefaultOutputRasterPrefix(String rasterPrefix)
          The default output raster prefix.
 void setDefaultOutputVectorPrefix(String vectorPrefix)
          The default output vector prefix.
 void setExtent(int envType, Object extentProvider, Object snapRasterData)
          Sets the type and values of extent in the RasterAnalysis.
 void setMaskByRef(IGeoDataset mask)
          Mask allows processing to occur only for a selected set of cells.
 void setOutSpatialReferenceByRef(ISpatialReference spatialReference)
          The output spatial reference of GeoAnalysis.
 void setOutWorkspaceByRef(IWorkspace workspace)
          The output workspace of GeoAnalysis.
 void setVerifyType(int verifyType)
          The verify type of the RasterAnalysis.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

RasterExtractionOp

public RasterExtractionOp()
                   throws IOException,
                          UnknownHostException
Constructs a RasterExtractionOp using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

RasterExtractionOp

public RasterExtractionOp(Object obj)
                   throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterExtractionOp theRasterExtractionOp = (RasterExtractionOp) obj;

Construct a RasterExtractionOp using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to RasterExtractionOp.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

setCellSize

public void setCellSize(int envType,
                        Object cellSizeProvider)
                 throws IOException,
                        AutomationException
Sets the type and value of cell size in the RasterAnalysis.

Remarks

envType

An enumeration type specifying the raster cellsize environment settings for analysis. All subsequent results will be to the value specified. It can be of type

esriRasterEnvMaxOf The largest cell size of all input raster datasets that are specifed in the function. This is the default.

This option is not suitable for methods such as IInterpolationOp::IDW, IDensityOp:KernalDensity etc. where features are the only inputs. Use esriRasterEnvValue instead.

esriRasterEnvMinOf - Smallest cell size of all input raster datasets.

This option is not suitable for methods such as IInterpolationOp::IDW, IDensityOp:KernalDensity etc. where features are the only inputs. Use esriRasterEnvValue instead

esriRasterEnvValue - Any user specified value for the cell size.

Use this option to specify a particular value for a cell size or for methods such as IInterpolationOp::IDW, IDensityOp:KernalDensity etc. where features are the only input.

[cellSizeProvider]

A specified value (double) or RasterDataset that is used to provide the cellsize environment value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCellSize in interface IRasterAnalysisEnvironment
Parameters:
envType - A com.esri.arcgis.geoanalyst.esriRasterEnvSettingEnum constant (in)
cellSizeProvider - A Variant (in, optional, pass null if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCellSize

public void getCellSize(int[] envType,
                        double[] cellSize)
                 throws IOException,
                        AutomationException
Gets the type and value of cell size in the RasterAnalysis.

Remarks

envType

will return an enumeration type constant specifying the raster cellsize environment settings for analysis. It can be of type

esriRasterEnvMaxOf - largest cell size of all input datasets. This is the default.

esriRasterEnvMinOf - smallest cell size of all input datasets

esriRasterEnvValue - User specified value.

cellsize

returns a value that specifying the current environment setting for cellsize

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getCellSize in interface IRasterAnalysisEnvironment
Parameters:
envType - A com.esri.arcgis.geoanalyst.esriRasterEnvSettingEnum constant (out: use single element array)
cellSize - The cellSize (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExtent

public void setExtent(int envType,
                      Object extentProvider,
                      Object snapRasterData)
               throws IOException,
                      AutomationException
Sets the type and values of extent in the RasterAnalysis.

Remarks

envType

An enumeration type specifying the raster extent environment settings for analysis. All subsequent results will be to this extent. It can be of type

esriRasterEnvMinOf Intersection of Inputs - All input feature extents are intersected and the extent common to all is used as the extent values for the study area. This is the default.

esriRasterEnvMaxOf - Union of Inputs - All input feature extents are combined and the outer extent of the union is used.

esriRasterEnvValue - Value - User specified values for the Left, Right, Top and Bottom extent (x, y values) of the study area.

[extentProvider]

An envelope object supporting IEnvelope interface or RasterDataset that is used to provide the environment values of the analysis extent.

[snapRasterData]

A RasterDataset that can be used to snap all output raster datasets to the cell registration of the specified raster. All subsequent results will share the lower-left corner and cell size of the specified raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setExtent in interface IRasterAnalysisEnvironment
Parameters:
envType - A com.esri.arcgis.geoanalyst.esriRasterEnvSettingEnum constant (in)
extentProvider - A Variant (in, optional, pass null if not required)
snapRasterData - A Variant (in, optional, pass null if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtent

public void getExtent(int[] envType,
                      IEnvelope[] extent)
               throws IOException,
                      AutomationException
Gets the type and values of extent in the RasterAnalysis.

Remarks

envType

will return an enumeration constant specifying the raster extent environment settings for analysis. It can be of type,

esriRasterEnvMinOf Intersection of Inputs - All input feature extents are intersected and the extent common to all is used as the extent values for the study area. This is the default.

esriRasterEnvMaxOf - Union of Inputs - All input feature extents are combined and the outer extent of the union is used.

esriRasterEnvValue - Value - User specified values for the Left, Right, Top and Bottom extent (x, y values) of the study area.

extent

An envelope object supporting IEnvelope interface used to describe the values of the analysis extent.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getExtent in interface IRasterAnalysisEnvironment
Parameters:
envType - A com.esri.arcgis.geoanalyst.esriRasterEnvSettingEnum constant (out: use single element array)
extent - A reference to a com.esri.arcgis.geometry.IEnvelope (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaskByRef

public void setMaskByRef(IGeoDataset mask)
                  throws IOException,
                         AutomationException
Mask allows processing to occur only for a selected set of cells.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMaskByRef in interface IRasterAnalysisEnvironment
Parameters:
mask - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMask

public IGeoDataset getMask()
                    throws IOException,
                           AutomationException
Mask allows processing to occur only for a selected set of cells.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMask in interface IRasterAnalysisEnvironment
Returns:
A reference to a com.esri.arcgis.geodatabase.IGeoDataset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setVerifyType

public void setVerifyType(int verifyType)
                   throws IOException,
                          AutomationException
The verify type of the RasterAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setVerifyType in interface IRasterAnalysisEnvironment
Parameters:
verifyType - A com.esri.arcgis.geoanalyst.esriRasterVerifyEnum constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getVerifyType

public int getVerifyType()
                  throws IOException,
                         AutomationException
The verify type of the RasterAnalysis.

Remarks

The value is an enumeration environment setting that contols the way that an output RasterDatasets are written to file when during analysis. The verify enumeration can be of type

esriRasterEnvVerifyOn - specifies that the user will be prompted to verify the output already exists and it is okay to overwrite it

esriRasterEnvVerifyOff - specifies that output data will be automatically overwritten if already exists. This is the default environment setting.

esriRasterEnvVerifyError - specifies that an error will be produced when the output already exists.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getVerifyType in interface IRasterAnalysisEnvironment
Returns:
A com.esri.arcgis.geoanalyst.esriRasterVerifyEnum constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultOutputRasterPrefix

public String getDefaultOutputRasterPrefix()
                                    throws IOException,
                                           AutomationException
The default output raster prefix.

Remarks

The user specified prefix which is included to all temporary output RasterDatasets during analysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDefaultOutputRasterPrefix in interface IRasterAnalysisEnvironment
Returns:
The rasterPrefix
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultOutputRasterPrefix

public void setDefaultOutputRasterPrefix(String rasterPrefix)
                                  throws IOException,
                                         AutomationException
The default output raster prefix.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDefaultOutputRasterPrefix in interface IRasterAnalysisEnvironment
Parameters:
rasterPrefix - The rasterPrefix (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultOutputVectorPrefix

public String getDefaultOutputVectorPrefix()
                                    throws IOException,
                                           AutomationException
The default output vector prefix.

Remarks

The user specified prefix which is included to all temporary output Shapefiles during analysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDefaultOutputVectorPrefix in interface IRasterAnalysisEnvironment
Returns:
The vectorPrefix
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultOutputVectorPrefix

public void setDefaultOutputVectorPrefix(String vectorPrefix)
                                  throws IOException,
                                         AutomationException
The default output vector prefix.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDefaultOutputVectorPrefix in interface IRasterAnalysisEnvironment
Parameters:
vectorPrefix - The vectorPrefix (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAsNewDefaultEnvironment

public void setAsNewDefaultEnvironment()
                                throws IOException,
                                       AutomationException
Sets the raster analysis environment of the object as new default environment.

Remarks

Will set all current environment settings of the RasterAnalysis object as the new default environment. All subsequent analysis will use the set object properties unless otherwise specified.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setAsNewDefaultEnvironment in interface IRasterAnalysisEnvironment
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

restoreToPreviousDefaultEnvironment

public void restoreToPreviousDefaultEnvironment()
                                         throws IOException,
                                                AutomationException
Restores to the previous default raster analysis environment.

Remarks

This will restore the default environment to the settings of the "previous" RasterAnalysisEnvironment object used to set the default environement. Note: If multiple default environments have been set it will reference the past settings one at a time in order of sequence.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
restoreToPreviousDefaultEnvironment in interface IRasterAnalysisEnvironment
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws IOException,
                  AutomationException
Remove all previously stored default rasteranalysis environments.

Remarks

This method can be used to restore the system default raster environment settings for extent, cell size, precision, spatial reference and/or current workspace for analysis. This will change all previously altered environment settings made to the RasterAnlaysis object back to the original settings.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
reset in interface IRasterAnalysisEnvironment
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOutWorkspaceByRef

public void setOutWorkspaceByRef(IWorkspace workspace)
                          throws IOException,
                                 AutomationException
The output workspace of GeoAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setOutWorkspaceByRef in interface IGeoAnalysisEnvironment
Parameters:
workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOutWorkspace

public IWorkspace getOutWorkspace()
                           throws IOException,
                                  AutomationException
The output workspace of GeoAnalysis.

Remarks

The variable is an object specifying the directory or subdirectory to contain the output rasterdataset

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getOutWorkspace in interface IGeoAnalysisEnvironment
Returns:
A reference to a com.esri.arcgis.geodatabase.IWorkspace
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOutSpatialReferenceByRef

public void setOutSpatialReferenceByRef(ISpatialReference spatialReference)
                                 throws IOException,
                                        AutomationException
The output spatial reference of GeoAnalysis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setOutSpatialReferenceByRef in interface IGeoAnalysisEnvironment
Parameters:
spatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOutSpatialReference

public ISpatialReference getOutSpatialReference()
                                         throws IOException,
                                                AutomationException
The output spatial reference of GeoAnalysis.

Remarks

The variable references an object that specifies the output features spatial reference. If not explicitly set the spatial reference of the input features will be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getOutSpatialReference in interface IGeoAnalysisEnvironment
Returns:
A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

attribute

public IGeoDataset attribute(IRasterDescriptor raster)
                      throws IOException,
                             AutomationException
Extracts the cells of a raster based on a logical query.

Remarks

raster

an input RasterDescriptor that was created by a logical expression based on the attributes in a Raster. Those cells for which the logical expression evaluated to True in the RasterDescriptor are selected. Those cells that are not selected will be set to NoData.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
attribute in interface IExtractionOp
Specified by:
attribute in interface IExtractionOp2
Parameters:
raster - A reference to a com.esri.arcgis.geoanalyst.IRasterDescriptor (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGeoDataset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

circle

public IGeoDataset circle(IGeoDataset geoDataset,
                          ICircularArc circle,
                          boolean selectInside)
                   throws IOException,
                          AutomationException
Extracts the cells of a raster based on a circle.

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 circle.

Circle

an ICircularArc defining circle 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 circle

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
circle in interface IExtractionOp
Specified by:
circle in interface IExtractionOp2
Parameters:
geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
circle - A reference to a com.esri.arcgis.geometry.ICircularArc (in)
selectInside - The selectInside (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGeoDataset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

raster

public IGeoDataset raster(IGeoDataset geoDataset,
                          IGeoDataset maskRaster)
                   throws IOException,
                          AutomationException
Extracts the cells of a raster whose corresponding cells in the mask raster have valid value.

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.

maskRaster

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
raster in interface IExtractionOp
Specified by:
raster in interface IExtractionOp2
Parameters:
geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
maskRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGeoDataset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

points

public IGeoDataset points(IGeoDataset geoDataset,
                          IPointCollection points,
                          boolean selectInside)
                   throws IOException,
                          AutomationException
Extracts the cells of a raster based on points.

Remarks

geoDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

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

Points

an IPointsCollection identifying the coordinates of the points to be selected

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 cell containing the selected point

If True, the cell in which the selected point falls will be written to the output Raster. All cells outside the box will receive NoData on the output Raster.

If the Boolean is False, the cells outside the input cells should be selected and written to the output Raster. The cell within which the selected point falls will receive NoData on the output Raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
points in interface IExtractionOp
Specified by:
points in interface IExtractionOp2
Parameters:
geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
points - A reference to a com.esri.arcgis.geometry.IPointCollection (in)
selectInside - The selectInside (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGeoDataset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

polygon

public IGeoDataset polygon(IGeoDataset geoDataset,
                           IPolygon polygon,
                           boolean selectInside)
                    throws IOException,
                           AutomationException
Extracts the cells of a raster based on a polygon.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
polygon in interface IExtractionOp
Specified by:
polygon in interface IExtractionOp2
Parameters:
geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
polygon - A reference to a com.esri.arcgis.geometry.IPolygon (in)
selectInside - The selectInside (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGeoDataset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

rectangle

public IGeoDataset rectangle(IGeoDataset geoDataset,
                             IEnvelope rectangleEnvelope,
                             boolean selectInside)
                      throws IOException,
                             AutomationException
Extracts the cells of a raster based on a rectangle.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
rectangle in interface IExtractionOp
Specified by:
rectangle in interface IExtractionOp2
Parameters:
geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
rectangleEnvelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
selectInside - The selectInside (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGeoDataset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

sample

public ITable sample(IGeoDataset locationDataset,
                     IGeoDataset collectionOfRasters,
                     int resampleType)
              throws IOException,
                     AutomationException
Extracts the cells of a raster based on a sample.

Remarks

locationDataset

an input Raster, RasterDataset, RasterBand, RasterDescriptor, FeatureClass or FeatureClassDescriptor which defines the cells to sample

Cells in the locationDataSet with valid values will be sampled.

collectionOfRasters

a multiband input Raster, RasterDataset, RasterBand, or RasterDescriptor whose values will be sampled based upon the locationDataset

resampleType

an esriGeoAnalysisResampleEnum specifing the resampling algorithm to be used when sampling a Raster

resample enumeration types are,

esriGeoAnalysisBilinear - bilinear interpolation

esriGeoAnalysisCubic - cubic convolution

esriGeoAnalysisNearest - nearest neighbor assignment

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
sample in interface IExtractionOp
Specified by:
sample in interface IExtractionOp2
Parameters:
locationDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
collectionOfRasters - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
resampleType - A com.esri.arcgis.geoanalyst.esriGeoAnalysisResampleEnum constant (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

extractValuesToPoints

public IGeoDataset extractValuesToPoints(IGeoDataset pointDataset,
                                         IGeoDataset valueRaster,
                                         boolean interpolateValues,
                                         boolean allAttributes)
                                  throws IOException,
                                         AutomationException
Extracts cell values from point features overlayed on a raster.

Remarks

pointDataset

an input point featureclass or feature class descriptor containing the points of interests to identify cell values from the input raster.

valueRaster

an input Raster, RasterDataset, RasterBand, or RasterDescriptor.

The geoDataset contains the cell values which determine the output RASTERVALU attribute of the output point geoDataset.

[interpolateValues]

a boolean specifying if the value of the RASTERVALU attribute will be interpolated between neighboring cells or given the value of the cell in which it is found to occur.

If TRUE, then the attribute value will be determined by the bilinear interpolation method.

If FALSE, then the attribute value will be determined by the cell value from the input raster. This is the default option.

[allAttributes]

a boolean specifying if the all attributes from the input value raster are to be included in the output geoDatatset.

If TRUE, all attributes of the input raster are included in the output.

If FALSE, attributes from the input raster are not included. This is the default option.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
extractValuesToPoints in interface IExtractionOp2
Parameters:
pointDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
valueRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
interpolateValues - The interpolateValues (in, optional, pass false if not required)
allAttributes - The allAttributes (in, optional, pass false if not required)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGeoDataset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException
interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.