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.
Usage tips:
- The input source data can be a feature class or raster.
- 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.
- 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 0 is considered a legitimate source. A source raster can be easily created using the .
- 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.
- Allocation is not an available output because there can 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 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 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.
|
Constructor Summary |
EucDirection()
Creates the Euclidean Direction tool with defaults. |
EucDirection(java.lang.Object inSourceData,
java.lang.Object outDirectionRaster)
Creates the Euclidean Direction tool with the required parameters. |
|
Method Summary |
java.lang.Object |
getCellSize()
Returns the Output cell size parameter of this tool . |
java.lang.Object |
getInSourceData()
Returns the Input raster or feature source data parameter of this tool . |
double |
getMaximumDistance()
Returns the Maximum distance parameter of this tool . |
java.lang.Object |
getOutDirectionRaster()
Returns the Output direction raster parameter of this tool . |
java.lang.Object |
getOutDistanceRaster()
Returns the Output distance 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 |
setCellSize(java.lang.Object cellSize)
Sets the Output cell size parameter of this tool . |
void |
setInSourceData(java.lang.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(java.lang.Object outDirectionRaster)
Sets the Output direction raster parameter of this tool . |
void |
setOutDistanceRaster(java.lang.Object outDistanceRaster)
Sets the Output distance raster parameter of this tool . |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
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(java.lang.Object inSourceData,
java.lang.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 - the input source locations. this is a raster or feature dataset that identifies the cells or locations to which the Euclidean distance for every output cell location is calculated. for rasters, the input type can be integer or floating point.outDirectionRaster - the output Euclidean direction raster. the direction raster contains the calculated direction, in degrees, each cell center is from the closest source cell center. the range of values is from 0 degrees to 360 degrees, 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). the output raster is of integer type.
getInSourceData
public java.lang.Object getInSourceData()
- Returns the Input raster or feature source data parameter of this tool .
This parameter is the input source locations. this is a raster or feature dataset that identifies the cells or locations to which the Euclidean distance for every output cell location is calculated. for rasters, the input type can be integer or floating point.
This is a required parameter.
- Returns:
- the Input raster or feature source data
setInSourceData
public void setInSourceData(java.lang.Object inSourceData)
- Sets the Input raster or feature source data parameter of this tool .
This parameter is the input source locations. this is a raster or feature dataset that identifies the cells or locations to which the Euclidean distance for every output cell location is calculated. for rasters, the input type can be integer or floating point.
This is a required parameter.
- Parameters:
inSourceData - the input source locations. this is a raster or feature dataset that identifies the cells or locations to which the Euclidean distance for every output cell location is calculated. for rasters, the input type can be integer or floating point.
getOutDirectionRaster
public java.lang.Object getOutDirectionRaster()
- Returns the Output direction raster parameter of this tool .
This parameter is the output Euclidean direction raster. the direction raster contains the calculated direction, in degrees, each cell center is from the closest source cell center. the range of values is from 0 degrees to 360 degrees, 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). the output raster is of integer type.
This is a required parameter.
- Returns:
- the Output direction raster
setOutDirectionRaster
public void setOutDirectionRaster(java.lang.Object outDirectionRaster)
- Sets the Output direction raster parameter of this tool .
This parameter is the output Euclidean direction raster. the direction raster contains the calculated direction, in degrees, each cell center is from the closest source cell center. the range of values is from 0 degrees to 360 degrees, 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). the output raster is of integer type.
This is a required parameter.
- Parameters:
outDirectionRaster - the output Euclidean direction raster. the direction raster contains the calculated direction, in degrees, each cell center is from the closest source cell center. the range of values is from 0 degrees to 360 degrees, 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). the output raster is of integer type.
getMaximumDistance
public double getMaximumDistance()
- Returns the Maximum distance parameter of this tool .
This parameter is defines the threshold that the accumulative distance values cannot exceed. if an accumulative Euclidean distance value exceeds this value, the output value for the cell location will be NoData. 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 defines the threshold that the accumulative distance values cannot exceed. if an accumulative Euclidean distance value exceeds this value, the output value for the cell location will be NoData. the default distance is to the edge of the output raster.
This is an optional parameter.
- Parameters:
maximumDistance - defines the threshold that the accumulative distance values cannot exceed. if an accumulative Euclidean distance value exceeds this value, the output value for the cell location will be NoData. the default distance is to the edge of the output raster.
getCellSize
public java.lang.Object getCellSize()
- Returns the Output cell size parameter of this tool .
This parameter is the cell size at which the output raster will be created. this will be the value in the environment if it is explicitly set. If it is not set in the environment, the default cell size will depend on if the input source data is a raster or a feature, as follows:
This is an optional parameter.
- Returns:
- the Output cell size
setCellSize
public void setCellSize(java.lang.Object cellSize)
- Sets the Output cell size parameter of this tool .
This parameter is the cell size at which the output raster will be created. this will be the value in the environment if it is explicitly set. If it is not set in the environment, the default cell size will depend on if the input source data is a raster or a feature, as follows:
This is an optional parameter.
- Parameters:
cellSize - the cell size at which the output raster will be created. this will be the value in the environment if it is explicitly set. If it is not set in the environment, the default cell size will depend on if the input source data is a raster or a feature, as follows:- If the source is raster, the output will have that same cell size.
- If the source is feature, the output will have a cell size determined by the shorter of the width or height of the extent of input feature, in the input spatial reference, divided by 250.
getOutDistanceRaster
public java.lang.Object getOutDistanceRaster()
- Returns the Output distance raster parameter of this tool .
This parameter is the output Euclidean distance raster. the distance raster identifies, for each cell, the Euclidean distance to the closest source cell, set of source cells, or source location. the output raster is of floating point type.
This is an optional parameter.
- Returns:
- the Output distance raster
setOutDistanceRaster
public void setOutDistanceRaster(java.lang.Object outDistanceRaster)
- Sets the Output distance raster parameter of this tool .
This parameter is the output Euclidean distance raster. the distance raster identifies, for each cell, the Euclidean distance to the closest source cell, set of source cells, or source location. the output raster is of floating point type.
This is an optional parameter.
- Parameters:
outDistanceRaster - the output Euclidean distance raster. the distance raster identifies, for each cell, the Euclidean distance to the closest source cell, set of source cells, or source location. the output raster is of floating point type.
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