com.esri.arcgis.geoprocessing.tools.spatialanalysttools
Class LessThanEqual

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.spatialanalysttools.LessThanEqual

All Implemented Interfaces:

GPTool

public class LessThanEqual
extends AbstractGPTool

Returns 1 for cells where the first raster is less than or equal to the second raster and 0 where it is not. The Less Than Equal tool is contained in the Spatial Analyst Tools tool box.

Software restrictions: none

Illustration:

Usage tips:

• The order of input is relevant in the less-than-or-equal-to expression.
• Output values are always integer.
• A number can be used as an input; however, the cell size and extent must first be set in the environment.
• The relational less-than-or-equal-to operation evaluates the first input value in relation to the second input value on a cell-by-cell basis within the Analysis window. In the relational evaluation, if the condition is true (the first input value is less than or equal to the second input value), the output is 1; if it is false, the output is 0. Input1 < Input2, Output = 1 Input1 = Input2, Output = 1 Input1 > Input2, Output = 0When one or both input values are NoData, the output is NoData.
• The following environment settings affect this tool:

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

LessThanEqual()
Creates the Less Than Equal tool with defaults.

LessThanEqual(Object inRasterOrConstant1, Object inRasterOrConstant2, Object outRaster)
Creates the Less Than Equal tool with the required parameters.

Method Summary

Object	getInRasterOrConstant1() Returns the Input raster or constant value 1 parameter of this tool .
Object	getInRasterOrConstant2() Returns the Input raster or constant value 2 parameter of this tool .
Object	getOutRaster() Returns the Output raster parameter of this tool .
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
void	setInRasterOrConstant1(Object inRasterOrConstant1) Sets the Input raster or constant value 1 parameter of this tool .
void	setInRasterOrConstant2(Object inRasterOrConstant2) Sets the Input raster or constant value 2 parameter of this tool .
void	setOutRaster(Object outRaster) Sets the Output raster parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LessThanEqual

public LessThanEqual()

Creates the Less Than Equal tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

LessThanEqual

public LessThanEqual(Object inRasterOrConstant1,
                     Object inRasterOrConstant2,
                     Object outRaster)

Creates the Less Than Equal tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:

inRasterOrConstant1 - Composite Geodataset, the input can be a raster or a constant value.

inRasterOrConstant2 - Composite Geodataset, the input can be a raster or a constant value.

outRaster - Raster Dataset, the raster to be created.

Method Detail

getInRasterOrConstant1

public Object getInRasterOrConstant1()

Returns the Input raster or constant value 1 parameter of this tool . This parameter is Composite Geodataset, the input can be a raster or a constant value. This is a required parameter.

Returns:

the Input raster or constant value 1

setInRasterOrConstant1

public void setInRasterOrConstant1(Object inRasterOrConstant1)

Sets the Input raster or constant value 1 parameter of this tool . This parameter is Composite Geodataset, the input can be a raster or a constant value. This is a required parameter.

Parameters:

inRasterOrConstant1 - Composite Geodataset, the input can be a raster or a constant value.

getInRasterOrConstant2

public Object getInRasterOrConstant2()

Returns the Input raster or constant value 2 parameter of this tool . This parameter is Composite Geodataset, the input can be a raster or a constant value. This is a required parameter.

Returns:

the Input raster or constant value 2

setInRasterOrConstant2

public void setInRasterOrConstant2(Object inRasterOrConstant2)

Sets the Input raster or constant value 2 parameter of this tool . This parameter is Composite Geodataset, the input can be a raster or a constant value. This is a required parameter.

Parameters:

inRasterOrConstant2 - Composite Geodataset, the input can be a raster or a constant value.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is Raster Dataset, the raster to be created. This is a required parameter.

Returns:

the Output raster

setOutRaster

public void setOutRaster(Object outRaster)

Sets the Output raster parameter of this tool . This parameter is Raster Dataset, the raster to be created. This is a required parameter.

Parameters:

outRaster - Raster Dataset, the raster to be created.

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias