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

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

All Implemented Interfaces:

GPTool

public class ATan2

extends AbstractGPTool

Calculates the inverse tangent (based on x,y) of cells in a raster. The ATan2 tool is contained in the Spatial Analyst Tools tool box.

Software restrictions: none

Illustration:

Usage tips:

• ATan2 converts rectangular coordinates (x,y) to polar (r,?), where r is the distance from the origin and ? is the angle from the x-axis.
  
  The equation for determining ATan2 is: tan? = y / x (where ? is the angle).
• The values of the first specified input are used as the numerator in the calculation of the tangent angle. The values of the second specified input are used as the denominator in the calculation of the angle.
• A number can be used as an input; however, the cell size and extent must first be set in the environment.
• The input values to ATan2 are interpreted as unitless.
• Output values are always floating point, regardless of the input values.
• The output values are in radians. If degrees are desired, the resulting raster must be multiplied by the radians-to-degrees conversion factor of 180/
  
  , or approximately 57.296.
• The output values are in the range between -
  
  and
  
  . The ATan2 operation represents all quadrants in a Cartesian matrix (based on sign).

Field Summary

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

vals

Constructor Summary

ATan2()
Creates the ATan2 tool with defaults.

ATan2(java.lang.Object inRasterOrConstant1, java.lang.Object inRasterOrConstant2, java.lang.Object outRaster)
Creates the ATan2 tool with the required parameters.

Method Summary

java.lang.Object	getInRasterOrConstant1() Returns the Input raster or constant value 1 parameter of this tool .
java.lang.Object	getInRasterOrConstant2() Returns the Input raster or constant value 2 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	setInRasterOrConstant1(java.lang.Object inRasterOrConstant1) Sets the Input raster or constant value 1 parameter of this tool .
void	setInRasterOrConstant2(java.lang.Object inRasterOrConstant2) Sets the Input raster or constant value 2 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

ATan2

public ATan2()

Creates the ATan2 tool with defaults.

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

ATan2

public ATan2(java.lang.Object inRasterOrConstant1,
             java.lang.Object inRasterOrConstant2,
             java.lang.Object outRaster)

Creates the ATan2 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, specifies the numerator, or y value, for the inverse tangent.

inRasterOrConstant2 - Composite Geodataset, specifies the denominator, or x value, for the inverse tangent.

outRaster - Raster Dataset, the raster to be created.

Method Detail

getInRasterOrConstant1

public java.lang.Object getInRasterOrConstant1()

Returns the Input raster or constant value 1 parameter of this tool . This parameter is Composite Geodataset, specifies the numerator, or y value, for the inverse tangent. This is a required parameter.

Returns:

the Input raster or constant value 1

setInRasterOrConstant1

public void setInRasterOrConstant1(java.lang.Object inRasterOrConstant1)

Sets the Input raster or constant value 1 parameter of this tool . This parameter is Composite Geodataset, specifies the numerator, or y value, for the inverse tangent. This is a required parameter.

Parameters:

inRasterOrConstant1 - Composite Geodataset, specifies the numerator, or y value, for the inverse tangent.

getInRasterOrConstant2

public java.lang.Object getInRasterOrConstant2()

Returns the Input raster or constant value 2 parameter of this tool . This parameter is Composite Geodataset, specifies the denominator, or x value, for the inverse tangent. This is a required parameter.

Returns:

the Input raster or constant value 2

setInRasterOrConstant2

public void setInRasterOrConstant2(java.lang.Object inRasterOrConstant2)

Sets the Input raster or constant value 2 parameter of this tool . This parameter is Composite Geodataset, specifies the denominator, or x value, for the inverse tangent. This is a required parameter.

Parameters:

inRasterOrConstant2 - Composite Geodataset, specifies the denominator, or x value, for the inverse tangent.

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