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

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

All Implemented Interfaces:

GPTool

public class Log10
extends AbstractGPTool

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

Software restrictions: none

Illustration:

Usage tips:

• Output values are always floating point, regardless of the input values.
• The input value of a logarithmic function cannot be zero or a negative number. If it is, the output will be NoData.
• A number can be used as an input; however, the cell size and extent must first be set in the environment.
• The following environment settings affect this tool:

Field Summary

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

vals

Constructor Summary

Log10()
Creates the Log10 tool with defaults.

Log10(Object inRasterOrConstant, Object outRaster)
Creates the Log10 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

Log10

public Log10()

Creates the Log10 tool with defaults.

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

Log10

public Log10(Object inRasterOrConstant,
             Object outRaster)

Creates the Log10 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 - Composite Geodataset, input raster or constant value for which to find the base 10 logarithm.

outRaster - Raster Dataset, the raster to be created.

Method Detail

getInRasterOrConstant

public Object getInRasterOrConstant()

Returns the Input raster or constant value parameter of this tool . This parameter is Composite Geodataset, input raster or constant value for which to find the base 10 logarithm. 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 Composite Geodataset, input raster or constant value for which to find the base 10 logarithm. This is a required parameter.

Parameters:

inRasterOrConstant - Composite Geodataset, input raster or constant value for which to find the base 10 logarithm.

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