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

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

All Implemented Interfaces:

GPTool

public class Log2
extends AbstractGPTool

Calculates the base 2 logarithm of cells in a raster. The Log2 tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• The input values to a logarithmic function should not be zero or a negative number. If it is, the output will be NoData.
• Input values can be integer or float. See for some examples of the outputs for floating point input values from the Logarithmic tools.
• 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

Log2()
Creates the Log2 tool with defaults.

Log2(Object inRasterOrConstant, Object outRaster)
Creates the Log2 tool with the required parameters.

Method Summary

Object	getInRasterOrConstant() Returns the Input raster or constant value 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	setInRasterOrConstant(Object inRasterOrConstant) Sets the Input raster or constant value 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

Log2

public Log2()

Creates the Log2 tool with defaults.

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

Log2

public Log2(Object inRasterOrConstant,
            Object outRaster)

Creates the Log2 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 - input values for which to find the base 2 logarithm. 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 base 2 logarithm of the input values.

Method Detail

getInRasterOrConstant

public Object getInRasterOrConstant()

Returns the Input raster or constant value parameter of this tool . This parameter is input values for which to find the base 2 logarithm. 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(Object inRasterOrConstant)

Sets the Input raster or constant value parameter of this tool . This parameter is input values for which to find the base 2 logarithm. 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 - input values for which to find the base 2 logarithm. 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 Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output raster. the cell values are the base 2 logarithm of the input values. 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 the output raster. the cell values are the base 2 logarithm of the input values. This is a required parameter.

Parameters:

outRaster - the output raster. the cell values are the base 2 logarithm of the input values.

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