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

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

All Implemented Interfaces:

GPTool

public class EucDirection
extends AbstractGPTool

Calculates, for each cell, the direction, in degrees, to the nearest source. The Euclidean Direction tool is contained in the Spatial Analyst Tools tool box.
Learn more about how Euclidean functions work

Software restrictions: none

Illustration:

Usage tips:

• The input source data can be a feature class or raster.
• When the input source data is a raster, the set of source cells consists of all cells in the source raster that have valid values. Cells that have NoData values are not included in the source set. The value zero is considered a legitimate source. A source raster can be easily created using the Extract By tools.
• When the input source data is a feature class, the source locations are converted internally to a raster before performing the Euclidean analysis. The resolution of the raster can be controlled with the Output cell size parameter.
• The maximum distance is specified in the same map units as the input source data.
• The output direction raster is of integer type.
• The output values are based on compass directions (90 to the east, 180 to the south, 270 to the west, and 360 to the north), with 0 reserved for the source cells.
• Allocation is not an available output due to the requirement that there be no floating-point information in the source data. If Allocation output is desired, use Euclidean Allocation, which can generate all three outputs (Allocation, Distance, and Direction) at the same time.
• If a mask has been set in the environment and the cells to be masked will mask a source, the Euclidean calculations will occur on the remaining source cells. The source cells that are masked will not be considered in the computations. These cell locations will be assigned NoData on the output rasters.
• The NoData values created by the masked cells are ignored in the Euclidean function calculations on non-source cell locations. The Euclidean distance for cells behind NoData values is calculated as if the NoData value is not present. Any cell location that is assigned NoData because of the mask on the input surface will receive NoData on all the output rasters (Euclidean Direction and, optionally, Euclidean Distance).

Field Summary

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

vals

Constructor Summary

EucDirection()
Creates the Euclidean Direction tool with defaults.

EucDirection(Object inSourceData, Object outDirectionRaster)
Creates the Euclidean Direction tool with the required parameters.

Method Summary

Object	getCellSize() Returns the Output cell size parameter of this tool .
Object	getInSourceData() Returns the Input raster or feature source data parameter of this tool .
double	getMaximumDistance() Returns the Maximum distance parameter of this tool .
Object	getOutDirectionRaster() Returns the Output direction raster parameter of this tool .
Object	getOutDistanceRaster() Returns the Output distance 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	setCellSize(Object cellSize) Sets the Output cell size parameter of this tool .
void	setInSourceData(Object inSourceData) Sets the Input raster or feature source data parameter of this tool .
void	setMaximumDistance(double maximumDistance) Sets the Maximum distance parameter of this tool .
void	setOutDirectionRaster(Object outDirectionRaster) Sets the Output direction raster parameter of this tool .
void	setOutDistanceRaster(Object outDistanceRaster) Sets the Output distance 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

EucDirection

public EucDirection()

Creates the Euclidean Direction tool with defaults.

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

EucDirection

public EucDirection(Object inSourceData,
                    Object outDirectionRaster)

Creates the Euclidean Direction 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:

inSourceData - Composite Geodataset, a raster or feature dataset that identifies the cells or locations whose values are assigned the output cell locations to which they are closest.

outDirectionRaster - Raster Dataset, contains the calculated direction in degrees each cell center is from the closest source cell center. The range of values is 0 to 360, with 0 reserved for the source cells. Due east (right) is 90 and the values increase clockwise (180 is south, 270 is west, and 360 is north).

Method Detail

getInSourceData

public Object getInSourceData()

Returns the Input raster or feature source data parameter of this tool . This parameter is Composite Geodataset, a raster or feature dataset that identifies the cells or locations whose values are assigned the output cell locations to which they are closest. This is a required parameter.

Returns:

the Input raster or feature source data

setInSourceData

public void setInSourceData(Object inSourceData)

Sets the Input raster or feature source data parameter of this tool . This parameter is Composite Geodataset, a raster or feature dataset that identifies the cells or locations whose values are assigned the output cell locations to which they are closest. This is a required parameter.

Parameters:

inSourceData - Composite Geodataset, a raster or feature dataset that identifies the cells or locations whose values are assigned the output cell locations to which they are closest.

getOutDirectionRaster

public Object getOutDirectionRaster()

Returns the Output direction raster parameter of this tool . This parameter is Raster Dataset, contains the calculated direction in degrees each cell center is from the closest source cell center. The range of values is 0 to 360, with 0 reserved for the source cells. Due east (right) is 90 and the values increase clockwise (180 is south, 270 is west, and 360 is north). This is a required parameter.

Returns:

the Output direction raster

setOutDirectionRaster

public void setOutDirectionRaster(Object outDirectionRaster)

Sets the Output direction raster parameter of this tool . This parameter is Raster Dataset, contains the calculated direction in degrees each cell center is from the closest source cell center. The range of values is 0 to 360, with 0 reserved for the source cells. Due east (right) is 90 and the values increase clockwise (180 is south, 270 is west, and 360 is north). This is a required parameter.

Parameters:

outDirectionRaster - Raster Dataset, contains the calculated direction in degrees each cell center is from the closest source cell center. The range of values is 0 to 360, with 0 reserved for the source cells. Due east (right) is 90 and the values increase clockwise (180 is south, 270 is west, and 360 is north).

getMaximumDistance

public double getMaximumDistance()

Returns the Maximum distance parameter of this tool . This parameter is Double, if an accumulative Euclidean distance value exceeds the {maximum_distance}, the output value for the cell location will be NoData. The {maximum_distance} defines the extent for which the accumulative Euclidean distances are calculated. The default distance is to the edge of the output raster. This is an optional parameter.

Returns:

the Maximum distance

setMaximumDistance

public void setMaximumDistance(double maximumDistance)

Sets the Maximum distance parameter of this tool . This parameter is Double, if an accumulative Euclidean distance value exceeds the {maximum_distance}, the output value for the cell location will be NoData. The {maximum_distance} defines the extent for which the accumulative Euclidean distances are calculated. The default distance is to the edge of the output raster. This is an optional parameter.

Parameters:

maximumDistance - Double, if an accumulative Euclidean distance value exceeds the {maximum_distance}, the output value for the cell location will be NoData. The {maximum_distance} defines the extent for which the accumulative Euclidean distances are calculated. The default distance is to the edge of the output raster.

getCellSize

public Object getCellSize()

Returns the Output cell size parameter of this tool . This parameter is Analysis cell size, this will be the value in the environment if it is explicitly set. If it's not set in the environment, and if the in_source_data is a raster, the cell size will default to that of the in_source_data. If the in_source_data is a feature dataset, the cell size will default to the shorter of the width or height of the extent of input features in the input spatial reference, divided by 250. This is an optional parameter.

Returns:

the Output cell size

setCellSize

public void setCellSize(Object cellSize)

Sets the Output cell size parameter of this tool . This parameter is Analysis cell size, this will be the value in the environment if it is explicitly set. If it's not set in the environment, and if the in_source_data is a raster, the cell size will default to that of the in_source_data. If the in_source_data is a feature dataset, the cell size will default to the shorter of the width or height of the extent of input features in the input spatial reference, divided by 250. This is an optional parameter.

Parameters:

cellSize - Analysis cell size, this will be the value in the environment if it is explicitly set. If it's not set in the environment, and if the in_source_data is a raster, the cell size will default to that of the in_source_data. If the in_source_data is a feature dataset, the cell size will default to the shorter of the width or height of the extent of input features in the input spatial reference, divided by 250.

getOutDistanceRaster

public Object getOutDistanceRaster()

Returns the Output distance raster parameter of this tool . This parameter is Raster Dataset, the distance raster identifies, for each cell, the Euclidean distance to the closest source cell, set of source cells, or source location. This is an optional parameter.

Returns:

the Output distance raster

setOutDistanceRaster

public void setOutDistanceRaster(Object outDistanceRaster)

Sets the Output distance raster parameter of this tool . This parameter is Raster Dataset, the distance raster identifies, for each cell, the Euclidean distance to the closest source cell, set of source cells, or source location. This is an optional parameter.

Parameters:

outDistanceRaster - Raster Dataset, the distance raster identifies, for each cell, the Euclidean distance to the closest source cell, set of source cells, or source location.

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