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

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

All Implemented Interfaces:

GPTool

public class Aspect
extends AbstractGPTool

Derives aspect from a raster surface. The aspect identifies the downslope direction of the maximum rate of change in value from each cell to its neighbors. The Aspect tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• Aspect is the direction of the maximum rate of change in the z-value from each cell in a raster surface.
• Aspect is expressed in positive degrees from 0 to 359.9, measured clockwise from north.
• Cells in the input raster that are flat—with zero slope—are assigned an aspect of -1.
• If the center cell in the immediate neighborhood (3 x 3 window) is NoData, the output is NoData.
• If any neighborhood cells are NoData, they are first assigned the value of the center cell, then the aspect is computed.

Field Summary

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

vals

Constructor Summary

Aspect()
Creates the Aspect tool with defaults.

Aspect(Object inRaster, Object outRaster)
Creates the Aspect tool with the required parameters.

Method Summary

Object	getInRaster() Returns the Input raster 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	setInRaster(Object inRaster) Sets the Input raster 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

Aspect

public Aspect()

Creates the Aspect tool with defaults.

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

Aspect

public Aspect(Object inRaster,
              Object outRaster)

Creates the Aspect 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:

inRaster - the input surface raster.

outRaster - the output aspect raster.

Method Detail

getInRaster

public Object getInRaster()

Returns the Input raster parameter of this tool . This parameter is the input surface raster. This is a required parameter.

Returns:

the Input raster

setInRaster

public void setInRaster(Object inRaster)

Sets the Input raster parameter of this tool . This parameter is the input surface raster. This is a required parameter.

Parameters:

inRaster - the input surface raster.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output aspect raster. 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 aspect raster. This is a required parameter.

Parameters:

outRaster - the output aspect raster.

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