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

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

All Implemented Interfaces:

GPTool

public class ACosH

extends AbstractGPTool

Calculates the inverse hyperbolic cosine of cells in a raster. The ACosH 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 values to the ACosH function must be greater than or equal to 1. Any value below 1 will receive NoData on the output.
• The input and output values in ACosH are interpreted as unitless.
• A number can be used as an input; however, the cell size and extent must first be set in the environment.

Field Summary

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

vals

Constructor Summary

ACosH()
Creates the ACosH tool with defaults.

ACosH(java.lang.Object inRasterOrConstant, java.lang.Object outRaster)
Creates the ACosH 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

ACosH

public ACosH()

Creates the ACosH tool with defaults.

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

ACosH

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

Creates the ACosH 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 a constant value.

outRaster - Raster Dataset, the raster to be created.

Method Detail

getInRasterOrConstant

public java.lang.Object getInRasterOrConstant()

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

Parameters:

inRasterOrConstant - Composite Geodataset, input raster or a constant value.

getOutRaster

public java.lang.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(java.lang.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 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