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

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

All Implemented Interfaces:

GPTool

public class SquareRoot
extends AbstractGPTool

Calculates the square root of the cell values in a raster. The Square Root tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• Input values that are less than 0 will be NoData in the output raster.
• The output raster from this tool is always floating point type, regardless of the input value type.

Field Summary

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

vals

Constructor Summary

SquareRoot()
Creates the Square Root tool with defaults.

SquareRoot(java.lang.Object inRasterOrConstant, java.lang.Object outRaster)
Creates the Square Root tool with the required parameters.

Method Summary

java.lang.Object	getInRasterOrConstant() Returns the Input raster or constant value parameter of this tool .
java.lang.Object	getOutRaster() Returns the Output raster parameter of this tool .
java.lang.String	getToolboxAlias() Returns the alias of the tool box containing this tool.
java.lang.String	getToolboxName() Returns the name of the tool box containing this tool.
java.lang.String	getToolName() Returns the name of this tool.
void	setInRasterOrConstant(java.lang.Object inRasterOrConstant) Sets the Input raster or constant value parameter of this tool .
void	setOutRaster(java.lang.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

SquareRoot

public SquareRoot()

Creates the Square Root tool with defaults.

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

SquareRoot

public SquareRoot(java.lang.Object inRasterOrConstant,
                  java.lang.Object outRaster)

Creates the Square Root 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:

inRasterOrConstant - the input values to find the square root of. in order to use a number as an input for this parameter, the cell size and extent must first be set in the environment.

outRaster - the output raster. the cell values are the square root of the input cell values.

Method Detail

getInRasterOrConstant

public java.lang.Object getInRasterOrConstant()

Returns the Input raster or constant value parameter of this tool . This parameter is the input values to find the square root of. in order to use a number as an input for this parameter, the cell size and extent must first be set in the environment. This is a required parameter.

Returns:

the Input raster or constant value

setInRasterOrConstant

public void setInRasterOrConstant(java.lang.Object inRasterOrConstant)

Sets the Input raster or constant value parameter of this tool . This parameter is the input values to find the square root of. in order to use a number as an input for this parameter, the cell size and extent must first be set in the environment. This is a required parameter.

Parameters:

inRasterOrConstant - the input values to find the square root of. in order to use a number as an input for this parameter, the cell size and extent must first be set in the environment.

getOutRaster

public java.lang.Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output raster. the cell values are the square root of the input cell values. This is a required parameter.

Returns:

the Output raster

setOutRaster

public void setOutRaster(java.lang.Object outRaster)

Sets the Output raster parameter of this tool . This parameter is the output raster. the cell values are the square root of the input cell values. This is a required parameter.

Parameters:

outRaster - the output raster. the cell values are the square root of the input cell values.

getToolName

public java.lang.String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public java.lang.String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias