com.esri.arcgis.spatialanalyst
Class RasterMathOps

java.lang.Object
  extended by com.esri.arcgis.spatialanalyst.RasterMathOps
All Implemented Interfaces:
IGeoAnalysisEnvironment, IRasterAnalysisEnvironment, com.esri.arcgis.interop.RemoteObjRef, IBitwiseOp, ILogicalOp, ILogicalOperatorOp, IMathOp, ITrigOp, ISupportErrorInfo, Serializable

public class RasterMathOps
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterAnalysisEnvironment, IMathOp, ITrigOp, ILogicalOp, IBitwiseOp, ILogicalOperatorOp, ISupportErrorInfo

A mechanism for performing mathematical operations on 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
RasterMathOps()
          Constructs a RasterMathOps using ArcGIS Engine.
RasterMathOps(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterMathOps theRasterMathOps = (RasterMathOps) obj;
 
Method Summary
 IGeoDataset abs(IGeoDataset geoDataset)
          Calculates the absolute value of cells in a raster.
 IGeoDataset aCos(IGeoDataset geoDataset)
          Calculates the inverse cosine of cells in a GeoDataset.
 IGeoDataset aCosH(IGeoDataset geoDataset)
          Calculates the inverse hyperbolic cosine of cells in a GeoDataset.
 IGeoDataset and(IGeoDataset geoDataset1, IGeoDataset geoDataset2)
          Performs a bitwise 'and' operation on the binary value of two input GeoDatasets.
 IGeoDataset aSin(IGeoDataset geoDataset)
          Calculates the inverse sine of cells in a GeoDataset.
 IGeoDataset aSinH(IGeoDataset geoDataset)
          Calculates the inverse hyperbolic sine of cells in a GeoDataset.
 IGeoDataset aTan(IGeoDataset geoDataset)
          Calculates the inverse tangent of cells in a GeoDataset.
 IGeoDataset aTan2(IGeoDataset geoDatasetX, IGeoDataset geoDatasetY)
          Calculates the calculates the inverse tangent (based on x/y) of cells in a GeoDataset.
 IGeoDataset aTanH(IGeoDataset geoDataset)
          Calculates the inverse hyperbolic tangent of cells in a GeoDataset.
 IGeoDataset booleanAnd(IGeoDataset geoDataset1, IGeoDataset geoDataset2)
          Performs a boolean 'and' operation on two input rasters.
 IGeoDataset booleanNot(IGeoDataset geoDataset)
          Perorms a boolean 'complement' operation on two input rasters.
 IGeoDataset booleanOr(IGeoDataset geoDataset1, IGeoDataset geoDataset2)
          Performs a boolean 'or' operation on two input rasters.
 IGeoDataset booleanXOr(IGeoDataset geoDataset1, IGeoDataset geoDataset2)
          Performs a boolean 'exclusive or' operation on two input rasters.
 IGeoDataset combinatorialAnd(IGeoDataset geoDataset1, IGeoDataset geoDataset2)
          Performs a combinatorial 'and' operation on two input rasters.
 IGeoDataset combinatorialOr(IGeoDataset geoDataset1, IGeoDataset geoDataset2)
          Performs a combinatorial 'or' operation on two input rasters.
 IGeoDataset combinatorialXOr(IGeoDataset geoDataset1, IGeoDataset geoDataset2)
          Performs a combinatorial 'exclusive or' operation on two input rasters.
 IGeoDataset cos(IGeoDataset geoDataset)
          Calculates the cosine of cells in a GeoDataset.
 IGeoDataset cosH(IGeoDataset geoDataset)
          Calculates the hyperbolic cosine of cells in a GeoDataset.
 IGeoDataset diff(IGeoDataset geoDataset1, IGeoDataset geoDataset2)
          Determines which values from the first input are logically different from the values of the second.
 IGeoDataset divide(IGeoDataset geoDataset1, IGeoDataset geoDataset2)
          Divides the values of two inputs.
 boolean equals(Object o)
          Compare this object with another
 IGeoDataset equalTo(IGeoDataset geoDataset1, IGeoDataset geoDataset2)
          Returns 1 for cells where the first raster equals than the second raster.
 IGeoDataset esri_float(IGeoDataset geoDataset)
          Converts a raster into floating point representation.
 IGeoDataset esri_int(IGeoDataset geoDataset)
          Converts a raster to integer by truncation.
 IGeoDataset exp(IGeoDataset geoDataset)
          Calculates the base e exponential of cells in a raster.
 IGeoDataset exp10(IGeoDataset geoDataset)
          Calculates the base 10 exponential of cells in a raster.
 IGeoDataset exp2(IGeoDataset geoDataset)
          Calculates the base 2 exponential of cells in 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.
 IGeoDataset greaterThan(IGeoDataset geoDataset1, IGeoDataset geoDataset2)
          Returns 1 for cells where the first raster is greater than the second raster.
 IGeoDataset greaterThanEqual(IGeoDataset geoDataset1, IGeoDataset geoDataset2)
          Returns 1 for cells where the first raster is greater than or equal to the second raster.
 int hashCode()
          the hashcode for this object
 IGeoDataset inList(IGeoDataset geoDataset1, IGeoDataset geoDataset2)
          Determines which values from the first input are contained in list of geodata in the second input.
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 IGeoDataset isNull(IGeoDataset geoDataset)
          On a cell by cell basis, returns 1 if the input value is NoData, and 0 if it is not.
 IGeoDataset leftShift(IGeoDataset geoDataset1, IGeoDataset geoDataset2)
          Performs a bitwise 'left shift' operation on the binary value of two input GeoDatasets.
 IGeoDataset lessThan(IGeoDataset geoDataset1, IGeoDataset geoDataset2)
          Returns 1 for cells where the first raster is less than the second raster.
 IGeoDataset lessThanEqual(IGeoDataset geoDataset1, IGeoDataset geoDataset2)
          Returns 1 for cells where the first raster less than or equal to the second raster.
 IGeoDataset ln(IGeoDataset geoDataset)
          Calculates the natural logarithm (base e) of cells in a raster.
 IGeoDataset log10(IGeoDataset geoDataset)
          Calculates the base 10 logarithm of cells in a raster.
 IGeoDataset log2(IGeoDataset geoDataset)
          Calculates the base 2 logarithm of cells in a raster.
 IGeoDataset minus(IGeoDataset geoDataset1, IGeoDataset geoDataset2)
          Subtracts the values of two inputs.
 IGeoDataset mod(IGeoDataset geoDataset1, IGeoDataset geoDataset2)
          Finds the remainder of the first input when divided by the second.
 IGeoDataset negate(IGeoDataset geoDataset)
          Changes the sign of the input raster (multiplies by -1).
 IGeoDataset not(IGeoDataset geoDataset)
          Performs a bitwise 'complement' operation on the binary value of an input GeoDataset.
 IGeoDataset notEqual(IGeoDataset geoDataset1, IGeoDataset geoDataset2)
          Returns 1 for cells where the first raster is not equal to the second raster.
 IGeoDataset or(IGeoDataset geoDataset1, IGeoDataset geoDataset2)
          Performs a bitwise 'or' operation on the binary value of two input GeoDatasets.
 IGeoDataset over(IGeoDataset geoDataset1, IGeoDataset geoDataset2)
          Returns those values from the first input that are nonzero; otherwise, returns the value from the second.
 IGeoDataset plus(IGeoDataset geoDataset1, IGeoDataset geoDataset2)
          Adds the values of two inputs.
 IGeoDataset power(IGeoDataset geoDataset, double power)
          Raises the cells in a raster to the Nth power.
 IGeoDataset powerByCellValue(IGeoDataset geoDataset, IGeoDataset powerDataset)
          Raises the cells in a raster to the power of values found in another raster.
 void reset()
          Remove all previously stored default rasteranalysis environments.
 void restoreToPreviousDefaultEnvironment()
          Restores to the previous default raster analysis environment.
 IGeoDataset rightShift(IGeoDataset geoDataset1, IGeoDataset geoDataset2)
          Performs a bitwise 'right shift' operation on the binary value of two input GeoDatasets.
 IGeoDataset roundDown(IGeoDataset geoDataset)
          Returns the next lower whole number for each cell in a raster.
 IGeoDataset roundUp(IGeoDataset geoDataset)
          Returns the next higher whole number for each cell in a raster.
 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.
 IGeoDataset sin(IGeoDataset geoDataset)
          Calculates the sine of cells in a GeoDataset.
 IGeoDataset sinH(IGeoDataset geoDataset)
          Calculates the hyperbolic sine of cells in a GeoDataset.
 IGeoDataset square(IGeoDataset geoDataset)
          Calculates the square of cells in a raster.
 IGeoDataset squareRoot(IGeoDataset geoDataset)
          Calculates the square root of cells in a raster.
 IGeoDataset tan(IGeoDataset geoDataset)
          Calculates the tangent of cells in a GeoDataset.
 IGeoDataset tanH(IGeoDataset geoDataset)
          Calculates the hyperbolic tangent of cells in a GeoDataset.
 IGeoDataset test(IRasterDescriptor geoDataset)
          Sets the output to 1 or 0 on a cell-by-cell basis based on evaluation of a boolean logical expression.
 IGeoDataset times(IGeoDataset geoDataset1, IGeoDataset geoDataset2)
          Multiplies the values of two inputs.
 IGeoDataset xOr(IGeoDataset geoDataset1, IGeoDataset geoDataset2)
          Performs a bitwise 'exclusive or' operation on the binary value of two input GeoDatasets.
 
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

RasterMathOps

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

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

RasterMathOps

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

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

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.

divide

public IGeoDataset divide(IGeoDataset geoDataset1,
                          IGeoDataset geoDataset2)
                   throws IOException,
                          AutomationException
Divides the values of two inputs.

Remarks

geoDataset1

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

geoDataset2

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
divide in interface IMathOp
Parameters:
geoDataset1 - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
geoDataset2 - 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.

minus

public IGeoDataset minus(IGeoDataset geoDataset1,
                         IGeoDataset geoDataset2)
                  throws IOException,
                         AutomationException
Subtracts the values of two inputs.

Remarks

geoDataset1

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

geoDataset2

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
minus in interface IMathOp
Parameters:
geoDataset1 - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
geoDataset2 - 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.

plus

public IGeoDataset plus(IGeoDataset geoDataset1,
                        IGeoDataset geoDataset2)
                 throws IOException,
                        AutomationException
Adds the values of two inputs.

Remarks

geoDataset1

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

geoDataset2

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
plus in interface IMathOp
Parameters:
geoDataset1 - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
geoDataset2 - 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.

times

public IGeoDataset times(IGeoDataset geoDataset1,
                         IGeoDataset geoDataset2)
                  throws IOException,
                         AutomationException
Multiplies the values of two inputs.

Remarks

geoDataset1

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

geoDataset2

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
times in interface IMathOp
Parameters:
geoDataset1 - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
geoDataset2 - 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.

mod

public IGeoDataset mod(IGeoDataset geoDataset1,
                       IGeoDataset geoDataset2)
                throws IOException,
                       AutomationException
Finds the remainder of the first input when divided by the second.

Remarks

geoDataset1

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

geoDataset2

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
mod in interface IMathOp
Parameters:
geoDataset1 - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
geoDataset2 - 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.

abs

public IGeoDataset abs(IGeoDataset geoDataset)
                throws IOException,
                       AutomationException
Calculates the absolute value of cells in a raster.

Remarks

geoDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
abs in interface IMathOp
Parameters:
geoDataset - 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.

esri_float

public IGeoDataset esri_float(IGeoDataset geoDataset)
                       throws IOException,
                              AutomationException
Converts a raster into floating point representation.

Product Availability

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

Specified by:
esri_float in interface IMathOp
Parameters:
geoDataset - 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.

exp

public IGeoDataset exp(IGeoDataset geoDataset)
                throws IOException,
                       AutomationException
Calculates the base e exponential of cells in a raster.

Remarks

geoDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
exp in interface IMathOp
Parameters:
geoDataset - 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.

exp2

public IGeoDataset exp2(IGeoDataset geoDataset)
                 throws IOException,
                        AutomationException
Calculates the base 2 exponential of cells in a raster.

Remarks

geoDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
exp2 in interface IMathOp
Parameters:
geoDataset - 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.

exp10

public IGeoDataset exp10(IGeoDataset geoDataset)
                  throws IOException,
                         AutomationException
Calculates the base 10 exponential of cells in a raster.

Remarks

geoDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
exp10 in interface IMathOp
Parameters:
geoDataset - 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.

ln

public IGeoDataset ln(IGeoDataset geoDataset)
               throws IOException,
                      AutomationException
Calculates the natural logarithm (base e) of cells in a raster.

Remarks

geoDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
ln in interface IMathOp
Parameters:
geoDataset - 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.

log2

public IGeoDataset log2(IGeoDataset geoDataset)
                 throws IOException,
                        AutomationException
Calculates the base 2 logarithm of cells in a raster.

Remarks

geoDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
log2 in interface IMathOp
Parameters:
geoDataset - 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.

log10

public IGeoDataset log10(IGeoDataset geoDataset)
                  throws IOException,
                         AutomationException
Calculates the base 10 logarithm of cells in a raster.

Remarks

geoDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
log10 in interface IMathOp
Parameters:
geoDataset - 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.

negate

public IGeoDataset negate(IGeoDataset geoDataset)
                   throws IOException,
                          AutomationException
Changes the sign of the input raster (multiplies by -1).

Remarks

geoDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
negate in interface IMathOp
Parameters:
geoDataset - 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.

power

public IGeoDataset power(IGeoDataset geoDataset,
                         double power)
                  throws IOException,
                         AutomationException
Raises the cells in a raster to the Nth power.

Remarks

geoDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Power

defines the power to which to raise the input

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
power in interface IMathOp
Parameters:
geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
power - The power (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.

roundDown

public IGeoDataset roundDown(IGeoDataset geoDataset)
                      throws IOException,
                             AutomationException
Returns the next lower whole number for each cell in a raster.

Remarks

geoDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
roundDown in interface IMathOp
Parameters:
geoDataset - 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.

roundUp

public IGeoDataset roundUp(IGeoDataset geoDataset)
                    throws IOException,
                           AutomationException
Returns the next higher whole number for each cell in a raster.

Remarks

geoDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
roundUp in interface IMathOp
Parameters:
geoDataset - 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.

square

public IGeoDataset square(IGeoDataset geoDataset)
                   throws IOException,
                          AutomationException
Calculates the square of cells in a raster.

Remarks

geoDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
square in interface IMathOp
Parameters:
geoDataset - 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.

squareRoot

public IGeoDataset squareRoot(IGeoDataset geoDataset)
                       throws IOException,
                              AutomationException
Calculates the square root of cells in a raster.

Remarks

geoDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
squareRoot in interface IMathOp
Parameters:
geoDataset - 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.

esri_int

public IGeoDataset esri_int(IGeoDataset geoDataset)
                     throws IOException,
                            AutomationException
Converts a raster to integer by truncation.

Product Availability

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

Specified by:
esri_int in interface IMathOp
Parameters:
geoDataset - 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.

powerByCellValue

public IGeoDataset powerByCellValue(IGeoDataset geoDataset,
                                    IGeoDataset powerDataset)
                             throws IOException,
                                    AutomationException
Raises the cells in a raster to the power of values found in another raster.

Remarks

geoDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

powerDataset

an input Raster, RasterDataset, RasterBand, or RasterDescriptor. It

defines the power to which to raise the input on a cell by cell basis

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
powerByCellValue in interface IMathOp
Parameters:
geoDataset - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
powerDataset - 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.

aCos

public IGeoDataset aCos(IGeoDataset geoDataset)
                 throws IOException,
                        AutomationException
Calculates the inverse cosine of cells in a GeoDataset.

Remarks

geoDataset an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
aCos in interface ITrigOp
Parameters:
geoDataset - 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.

aCosH

public IGeoDataset aCosH(IGeoDataset geoDataset)
                  throws IOException,
                         AutomationException
Calculates the inverse hyperbolic cosine of cells in a GeoDataset.

Remarks

geoDataset an input Raster, RasterDataset, RasterBand, or RasterDescriptor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
aCosH in interface ITrigOp
Parameters:
geoDataset - 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.

aSin

public IGeoDataset aSin(IGeoDataset geoDataset)
                 throws IOException,
                        AutomationException
Calculates the inverse sine of cells in a GeoDataset.

Remarks

geoDataset an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
aSin in interface ITrigOp
Parameters:
geoDataset - 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.

aSinH

public IGeoDataset aSinH(IGeoDataset geoDataset)
                  throws IOException,
                         AutomationException
Calculates the inverse hyperbolic sine of cells in a GeoDataset.

Remarks

geoDataset an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
aSinH in interface ITrigOp
Parameters:
geoDataset - 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.

aTan

public IGeoDataset aTan(IGeoDataset geoDataset)
                 throws IOException,
                        AutomationException
Calculates the inverse tangent of cells in a GeoDataset.

Remarks

geoDataset an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
aTan in interface ITrigOp
Parameters:
geoDataset - 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.

aTan2

public IGeoDataset aTan2(IGeoDataset geoDatasetX,
                         IGeoDataset geoDatasetY)
                  throws IOException,
                         AutomationException
Calculates the calculates the inverse tangent (based on x/y) of cells in a GeoDataset.

Remarks

geoDatasetX specifies the numerator for the inverse tangent

Valid input include a Raster, RasterDataset, RasterBand, or RasterDescriptor.

geoDatasetY specifies the denominator for the inverse tangent

Valid input include a Raster, RasterDataset, RasterBand, or RasterDescriptor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
aTan2 in interface ITrigOp
Parameters:
geoDatasetX - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
geoDatasetY - 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.

aTanH

public IGeoDataset aTanH(IGeoDataset geoDataset)
                  throws IOException,
                         AutomationException
Calculates the inverse hyperbolic tangent of cells in a GeoDataset.

Remarks

geoDataset an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
aTanH in interface ITrigOp
Parameters:
geoDataset - 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.

cos

public IGeoDataset cos(IGeoDataset geoDataset)
                throws IOException,
                       AutomationException
Calculates the cosine of cells in a GeoDataset.

Remarks

geoDataset an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
cos in interface ITrigOp
Parameters:
geoDataset - 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.

cosH

public IGeoDataset cosH(IGeoDataset geoDataset)
                 throws IOException,
                        AutomationException
Calculates the hyperbolic cosine of cells in a GeoDataset.

Remarks

geoDataset an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
cosH in interface ITrigOp
Parameters:
geoDataset - 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.

sin

public IGeoDataset sin(IGeoDataset geoDataset)
                throws IOException,
                       AutomationException
Calculates the sine of cells in a GeoDataset.

Remarks

geoDataset an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
sin in interface ITrigOp
Parameters:
geoDataset - 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.

sinH

public IGeoDataset sinH(IGeoDataset geoDataset)
                 throws IOException,
                        AutomationException
Calculates the hyperbolic sine of cells in a GeoDataset.

Remarks

geoDataset an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
sinH in interface ITrigOp
Parameters:
geoDataset - 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.

tan

public IGeoDataset tan(IGeoDataset geoDataset)
                throws IOException,
                       AutomationException
Calculates the tangent of cells in a GeoDataset.

Remarks

geoDataset an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
tan in interface ITrigOp
Parameters:
geoDataset - 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.

tanH

public IGeoDataset tanH(IGeoDataset geoDataset)
                 throws IOException,
                        AutomationException
Calculates the hyperbolic tangent of cells in a GeoDataset.

Remarks

geoDataset an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
tanH in interface ITrigOp
Parameters:
geoDataset - 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.

booleanAnd

public IGeoDataset booleanAnd(IGeoDataset geoDataset1,
                              IGeoDataset geoDataset2)
                       throws IOException,
                              AutomationException
Performs a boolean 'and' operation on two input rasters.

Remarks

geoDataset1 the first input Raster, RasterDataset, RasterBand, or RasterDescriptor
geoDataset2 the second input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
booleanAnd in interface ILogicalOp
Parameters:
geoDataset1 - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
geoDataset2 - 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.

booleanNot

public IGeoDataset booleanNot(IGeoDataset geoDataset)
                       throws IOException,
                              AutomationException
Perorms a boolean 'complement' operation on two input rasters.

Remarks

geoDataset the first input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
booleanNot in interface ILogicalOp
Parameters:
geoDataset - 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.

booleanOr

public IGeoDataset booleanOr(IGeoDataset geoDataset1,
                             IGeoDataset geoDataset2)
                      throws IOException,
                             AutomationException
Performs a boolean 'or' operation on two input rasters.

Remarks

geoDataset1 the first input Raster, RasterDataset, RasterBand, or RasterDescriptor
geoDataset2 the second input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
booleanOr in interface ILogicalOp
Parameters:
geoDataset1 - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
geoDataset2 - 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.

booleanXOr

public IGeoDataset booleanXOr(IGeoDataset geoDataset1,
                              IGeoDataset geoDataset2)
                       throws IOException,
                              AutomationException
Performs a boolean 'exclusive or' operation on two input rasters.

Remarks

geoDataset1 the first input Raster, RasterDataset, RasterBand, or RasterDescriptor
geoDataset2 the second input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
booleanXOr in interface ILogicalOp
Parameters:
geoDataset1 - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
geoDataset2 - 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.

combinatorialAnd

public IGeoDataset combinatorialAnd(IGeoDataset geoDataset1,
                                    IGeoDataset geoDataset2)
                             throws IOException,
                                    AutomationException
Performs a combinatorial 'and' operation on two input rasters.

Remarks

geoDataset1 a positive integer input Raster, RasterDataset, RasterBand, or RasterDescriptor
geoDataset2 a positive integer input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
combinatorialAnd in interface ILogicalOp
Parameters:
geoDataset1 - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
geoDataset2 - 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.

combinatorialOr

public IGeoDataset combinatorialOr(IGeoDataset geoDataset1,
                                   IGeoDataset geoDataset2)
                            throws IOException,
                                   AutomationException
Performs a combinatorial 'or' operation on two input rasters.

Remarks

geoDataset1 a positive integer input Raster, RasterDataset, RasterBand, or RasterDescriptor
geoDataset2 a positive integer input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
combinatorialOr in interface ILogicalOp
Parameters:
geoDataset1 - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
geoDataset2 - 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.

combinatorialXOr

public IGeoDataset combinatorialXOr(IGeoDataset geoDataset1,
                                    IGeoDataset geoDataset2)
                             throws IOException,
                                    AutomationException
Performs a combinatorial 'exclusive or' operation on two input rasters.

Remarks

geoDataset1 a positive integer input Raster, RasterDataset, RasterBand, or RasterDescriptor
geoDataset2 a positive integer input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
combinatorialXOr in interface ILogicalOp
Parameters:
geoDataset1 - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
geoDataset2 - 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.

greaterThan

public IGeoDataset greaterThan(IGeoDataset geoDataset1,
                               IGeoDataset geoDataset2)
                        throws IOException,
                               AutomationException
Returns 1 for cells where the first raster is greater than the second raster.

Remarks

geoDataset1 a positive integer input Raster, RasterDataset, RasterBand, or RasterDescriptor
geoDataset2 a positive integer input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
greaterThan in interface ILogicalOp
Parameters:
geoDataset1 - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
geoDataset2 - 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.

greaterThanEqual

public IGeoDataset greaterThanEqual(IGeoDataset geoDataset1,
                                    IGeoDataset geoDataset2)
                             throws IOException,
                                    AutomationException
Returns 1 for cells where the first raster is greater than or equal to the second raster.

Remarks

geoDataset1 a positive integer input Raster, RasterDataset, RasterBand, or RasterDescriptor
geoDataset2 a positive integer input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
greaterThanEqual in interface ILogicalOp
Parameters:
geoDataset1 - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
geoDataset2 - 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.

lessThan

public IGeoDataset lessThan(IGeoDataset geoDataset1,
                            IGeoDataset geoDataset2)
                     throws IOException,
                            AutomationException
Returns 1 for cells where the first raster is less than the second raster.

Remarks

geoDataset1 a positive integer input Raster, RasterDataset, RasterBand, or RasterDescriptor
geoDataset2 a positive integer input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
lessThan in interface ILogicalOp
Parameters:
geoDataset1 - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
geoDataset2 - 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.

lessThanEqual

public IGeoDataset lessThanEqual(IGeoDataset geoDataset1,
                                 IGeoDataset geoDataset2)
                          throws IOException,
                                 AutomationException
Returns 1 for cells where the first raster less than or equal to the second raster.

Remarks

geoDataset1 a positive integer input Raster, RasterDataset, RasterBand, or RasterDescriptor
geoDataset2 a positive integer input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
lessThanEqual in interface ILogicalOp
Parameters:
geoDataset1 - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
geoDataset2 - 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.

equalTo

public IGeoDataset equalTo(IGeoDataset geoDataset1,
                           IGeoDataset geoDataset2)
                    throws IOException,
                           AutomationException
Returns 1 for cells where the first raster equals than the second raster.

Remarks

geoDataset1 a positive integer input Raster, RasterDataset, RasterBand, or RasterDescriptor
geoDataset2 a positive integer input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
equalTo in interface ILogicalOp
Parameters:
geoDataset1 - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
geoDataset2 - 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.

notEqual

public IGeoDataset notEqual(IGeoDataset geoDataset1,
                            IGeoDataset geoDataset2)
                     throws IOException,
                            AutomationException
Returns 1 for cells where the first raster is not equal to the second raster.

Remarks

geoDataset1 a positive integer input Raster, RasterDataset, RasterBand, or RasterDescriptor
geoDataset2 a positive integer input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
notEqual in interface ILogicalOp
Parameters:
geoDataset1 - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
geoDataset2 - 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.

test

public IGeoDataset test(IRasterDescriptor geoDataset)
                 throws IOException,
                        AutomationException
Sets the output to 1 or 0 on a cell-by-cell basis based on evaluation of a boolean logical expression.

Remarks

geoDataSet an input RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
test in interface ILogicalOp
Parameters:
geoDataset - 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.

isNull

public IGeoDataset isNull(IGeoDataset geoDataset)
                   throws IOException,
                          AutomationException
On a cell by cell basis, returns 1 if the input value is NoData, and 0 if it is not.

Remarks

geoDataset an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isNull in interface ILogicalOp
Parameters:
geoDataset - 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.

and

public IGeoDataset and(IGeoDataset geoDataset1,
                       IGeoDataset geoDataset2)
                throws IOException,
                       AutomationException
Performs a bitwise 'and' operation on the binary value of two input GeoDatasets.

Remarks

variable

an output reference to a Raster object

geoDataset1 the first input integer or floating-point Raster, RasterDataset, RasterBand, or RasterDescriptor
geoDataset2 the second input integer or floating-point Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
and in interface IBitwiseOp
Parameters:
geoDataset1 - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
geoDataset2 - 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.

not

public IGeoDataset not(IGeoDataset geoDataset)
                throws IOException,
                       AutomationException
Performs a bitwise 'complement' operation on the binary value of an input GeoDataset.

Remarks

geoDataset an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
not in interface IBitwiseOp
Parameters:
geoDataset - 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.

or

public IGeoDataset or(IGeoDataset geoDataset1,
                      IGeoDataset geoDataset2)
               throws IOException,
                      AutomationException
Performs a bitwise 'or' operation on the binary value of two input GeoDatasets.

Remarks

geoDataset1 an input Raster, RasterDataset, RasterBand, or RasterDescriptor
geoDataset2 an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
or in interface IBitwiseOp
Parameters:
geoDataset1 - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
geoDataset2 - 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.

xOr

public IGeoDataset xOr(IGeoDataset geoDataset1,
                       IGeoDataset geoDataset2)
                throws IOException,
                       AutomationException
Performs a bitwise 'exclusive or' operation on the binary value of two input GeoDatasets.

Remarks

geoDataset1 the first input integer or floating-point Raster, RasterDataset, RasterBand, or RasterDescriptor
geoDataset2 the second input integer or floating-point Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
xOr in interface IBitwiseOp
Parameters:
geoDataset1 - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
geoDataset2 - 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.

rightShift

public IGeoDataset rightShift(IGeoDataset geoDataset1,
                              IGeoDataset geoDataset2)
                       throws IOException,
                              AutomationException
Performs a bitwise 'right shift' operation on the binary value of two input GeoDatasets.

Remarks

geoDataset1 the first input Raster, RasterDataset, RasterBand, or RasterDescriptor to perform the shift on
geoDataset2 the second input Raster, RasterDataset, RasterBand, or RasterDescriptor defining the number of positions to shift the bits

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
rightShift in interface IBitwiseOp
Parameters:
geoDataset1 - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
geoDataset2 - 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.

leftShift

public IGeoDataset leftShift(IGeoDataset geoDataset1,
                             IGeoDataset geoDataset2)
                      throws IOException,
                             AutomationException
Performs a bitwise 'left shift' operation on the binary value of two input GeoDatasets.

Remarks

geoDataset1

the first input Raster, RasterDataset, RasterBand, or RasterDescriptor to perform the shift on

geoDataset2

the second input Raster, RasterDataset, RasterBand, or RasterDescriptordefining the number of positions to shift the bits

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
leftShift in interface IBitwiseOp
Parameters:
geoDataset1 - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
geoDataset2 - 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.

diff

public IGeoDataset diff(IGeoDataset geoDataset1,
                        IGeoDataset geoDataset2)
                 throws IOException,
                        AutomationException
Determines which values from the first input are logically different from the values of the second.

Remarks

geoDataset1

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

geoDataset2

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Specified by:
diff in interface ILogicalOperatorOp
Parameters:
geoDataset1 - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
geoDataset2 - 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.

over

public IGeoDataset over(IGeoDataset geoDataset1,
                        IGeoDataset geoDataset2)
                 throws IOException,
                        AutomationException
Returns those values from the first input that are nonzero; otherwise, returns the value from the second.

Remarks

geoDataset1

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

geoDataset2

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Specified by:
over in interface ILogicalOperatorOp
Parameters:
geoDataset1 - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
geoDataset2 - 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.

inList

public IGeoDataset inList(IGeoDataset geoDataset1,
                          IGeoDataset geoDataset2)
                   throws IOException,
                          AutomationException
Determines which values from the first input are contained in list of geodata in the second input.

Remarks

geoDataset1

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

geoDataset2

an input Raster, RasterDataset, RasterBand, or RasterDescriptor

Product Availability

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

Specified by:
inList in interface ILogicalOperatorOp
Parameters:
geoDataset1 - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
geoDataset2 - 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.

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.