com.esri.arcgis.geoprocessing.tools.spatialanalysttools
Class PathDistance
java.lang.Object
com.esri.arcgis.geoprocessing.AbstractGPTool
com.esri.arcgis.geoprocessing.tools.spatialanalysttools.PathDistance
- All Implemented Interfaces:
- GPTool
public class PathDistance
- extends AbstractGPTool
Calculates, for each cell, the least accumulative cost distance to the nearest source, while accounting for surface distance and horizontal and vertical cost factors.
The Path Distance tool is contained in the Spatial Analyst Tools tool box.
Usage tips:
- The Path Distance tools are comparable to the Cost Distance tools in that both determine the minimum accumulative travel cost from a source to each location on a raster surface. However, the Path Distance tools to the analysis by being able to accommodate for the actual surface distance as well as other horizontal and vertical factors.
- 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 0 is considered a legitimate source. A source raster can be easily created using the .
- Cells with NoData act as barriers in the Path Distance tools. The cost distance for cells behind NoData values is calculated by the accumulative cost necessary to move around the NoData barrier. Any cell location that is assigned NoData on any one of the input rasters will receive NoData on all output rasters.
- If the input source data and the cost raster are different extents, the default output extent is the intersection of the two. To get a cost distance surface for the entire extent, choose the Union of Inputs option on the output environment settings.
- If a has been set in the environment, all masked cells will be treated as NoData values.When a mask has been defined in the Raster Analysis window and the cells to be masked will mask a source, the 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 all outputs (distance, allocation, and back link) rasters.
- The output of the tool can be used as input for the Input horizontal raster.
- The Maximum distance is specified in the same cost units as those on the cost raster.
- For the output distance raster, the least-cost distance (or minimum accumulative cost distance) of a cell to a set of source locations is the lower bound of the least-cost distances from the cell to all source locations.
- The default values for the Horizontal factor modifiers are:
- The default values for the Vertical factor modifiers are:
|
Constructor Summary |
PathDistance()
Creates the Path Distance tool with defaults. |
PathDistance(Object inSourceData,
Object outDistanceRaster)
Creates the Path Distance tool with the required parameters. |
PathDistance
public PathDistance()
- Creates the Path Distance tool with defaults.
Initializes the array of tool parameters with the default values specified when the tool was created.
PathDistance
public PathDistance(Object inSourceData,
Object outDistanceRaster)
- Creates the Path Distance 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 least accumulated cost distance for every output cell location is calculated. for rasters, the input type can be integer or floating point.outDistanceRaster - the output path distance raster. the output path distance raster identifies, for each cell, the least accumulative cost distance, over a cost surface to the identified source locations, while accounting for surface distance as well as horizontal and vertical surface factors. a source can be a cell, a set of cells, or one or more feature locations. the output raster is of floating point type.
getInSourceData
public 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 least accumulated cost 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(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 least accumulated cost 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 least accumulated cost distance for every output cell location is calculated. for rasters, the input type can be integer or floating point.
getOutDistanceRaster
public Object getOutDistanceRaster()
- Returns the Output distance raster parameter of this tool .
This parameter is the output path distance raster. the output path distance raster identifies, for each cell, the least accumulative cost distance, over a cost surface to the identified source locations, while accounting for surface distance as well as horizontal and vertical surface factors. a source can be a cell, a set of cells, or one or more feature locations. the output raster is of floating point type.
This is a required parameter.
- Returns:
- the Output distance raster
setOutDistanceRaster
public void setOutDistanceRaster(Object outDistanceRaster)
- Sets the Output distance raster parameter of this tool .
This parameter is the output path distance raster. the output path distance raster identifies, for each cell, the least accumulative cost distance, over a cost surface to the identified source locations, while accounting for surface distance as well as horizontal and vertical surface factors. a source can be a cell, a set of cells, or one or more feature locations. the output raster is of floating point type.
This is a required parameter.
- Parameters:
outDistanceRaster - the output path distance raster. the output path distance raster identifies, for each cell, the least accumulative cost distance, over a cost surface to the identified source locations, while accounting for surface distance as well as horizontal and vertical surface factors. a source can be a cell, a set of cells, or one or more feature locations. the output raster is of floating point type.
getInCostRaster
public Object getInCostRaster()
- Returns the Input cost raster parameter of this tool .
This parameter is a raster defining the impedance or cost to move planimetrically through each cell. the value at each cell location represents the cost per unit distance for moving through the cell. Each cell location value is multiplied by the cell resolution while also compensating for diagonal movement to obtain the total cost of passing through the cell. the values of the cost raster can be integer or floating point, but they cannot be negative or zero (you cannot have a negative or zero cost).
This is an optional parameter.
- Returns:
- the Input cost raster
setInCostRaster
public void setInCostRaster(Object inCostRaster)
- Sets the Input cost raster parameter of this tool .
This parameter is a raster defining the impedance or cost to move planimetrically through each cell. the value at each cell location represents the cost per unit distance for moving through the cell. Each cell location value is multiplied by the cell resolution while also compensating for diagonal movement to obtain the total cost of passing through the cell. the values of the cost raster can be integer or floating point, but they cannot be negative or zero (you cannot have a negative or zero cost).
This is an optional parameter.
- Parameters:
inCostRaster - a raster defining the impedance or cost to move planimetrically through each cell. the value at each cell location represents the cost per unit distance for moving through the cell. Each cell location value is multiplied by the cell resolution while also compensating for diagonal movement to obtain the total cost of passing through the cell. the values of the cost raster can be integer or floating point, but they cannot be negative or zero (you cannot have a negative or zero cost).
getInSurfaceRaster
public Object getInSurfaceRaster()
- Returns the Input surface raster parameter of this tool .
This parameter is a raster defining the elevation values at each cell location. the values are used to calculate the actual surface distance covered when passing between cells.
This is an optional parameter.
- Returns:
- the Input surface raster
setInSurfaceRaster
public void setInSurfaceRaster(Object inSurfaceRaster)
- Sets the Input surface raster parameter of this tool .
This parameter is a raster defining the elevation values at each cell location. the values are used to calculate the actual surface distance covered when passing between cells.
This is an optional parameter.
- Parameters:
inSurfaceRaster - a raster defining the elevation values at each cell location. the values are used to calculate the actual surface distance covered when passing between cells.
getInHorizontalRaster
public Object getInHorizontalRaster()
- Returns the Input horizontal raster parameter of this tool .
This parameter is a raster defining the horizontal direction at each cell. the values on the raster must be integers ranging from 0 to 360 with 0 degrees being north, or toward the top of the screen, and increasing clockwise. Flat areas should be given a value of -1. The values at each location will be used in conjunction with the {horizontal_factor} to determine the horizontal cost incurred when moving from a cell to its neighbors.
This is an optional parameter.
- Returns:
- the Input horizontal raster
setInHorizontalRaster
public void setInHorizontalRaster(Object inHorizontalRaster)
- Sets the Input horizontal raster parameter of this tool .
This parameter is a raster defining the horizontal direction at each cell. the values on the raster must be integers ranging from 0 to 360 with 0 degrees being north, or toward the top of the screen, and increasing clockwise. Flat areas should be given a value of -1. The values at each location will be used in conjunction with the {horizontal_factor} to determine the horizontal cost incurred when moving from a cell to its neighbors.
This is an optional parameter.
- Parameters:
inHorizontalRaster - a raster defining the horizontal direction at each cell. the values on the raster must be integers ranging from 0 to 360 with 0 degrees being north, or toward the top of the screen, and increasing clockwise. Flat areas should be given a value of -1. The values at each location will be used in conjunction with the {horizontal_factor} to determine the horizontal cost incurred when moving from a cell to its neighbors.
getHorizontalFactor
public Object getHorizontalFactor()
- Returns the Horizontal factor parameter of this tool .
This parameter is the Horizontal Factor object defines the relationship between the horizontal cost factor and the horizontal relative moving angle. there are several factors with modifiers from which to select that identify a defined horizontal factor graph. Additionally, a table can be used to create a custom graph. The graphs are used to identify the horizontal factor used in calculating the total cost of moving into a neighboring cell. in the explanations below, two acronyms are used: 'HF' stands for horizontal factor, which defines the horizontal difficulty encountered when moving from one cell to the next; and 'HRMA' stands for horizontal relative moving angle, which identifies the angle between the horizontal direction from a cell and the moving direction. the object comes in the following forms: the definitions and parameters of these are: the Modifiers to the horizontal keywords are:
This is an optional parameter.
- Returns:
- the Horizontal factor
setHorizontalFactor
public void setHorizontalFactor(Object horizontalFactor)
- Sets the Horizontal factor parameter of this tool .
This parameter is the Horizontal Factor object defines the relationship between the horizontal cost factor and the horizontal relative moving angle. there are several factors with modifiers from which to select that identify a defined horizontal factor graph. Additionally, a table can be used to create a custom graph. The graphs are used to identify the horizontal factor used in calculating the total cost of moving into a neighboring cell. in the explanations below, two acronyms are used: 'HF' stands for horizontal factor, which defines the horizontal difficulty encountered when moving from one cell to the next; and 'HRMA' stands for horizontal relative moving angle, which identifies the angle between the horizontal direction from a cell and the moving direction. the object comes in the following forms: the definitions and parameters of these are: the Modifiers to the horizontal keywords are:
This is an optional parameter.
- Parameters:
horizontalFactor - the Horizontal Factor object defines the relationship between the horizontal cost factor and the horizontal relative moving angle. there are several factors with modifiers from which to select that identify a defined horizontal factor graph. Additionally, a table can be used to create a custom graph. The graphs are used to identify the horizontal factor used in calculating the total cost of moving into a neighboring cell. in the explanations below, two acronyms are used: 'HF' stands for horizontal factor, which defines the horizontal difficulty encountered when moving from one cell to the next; and 'HRMA' stands for horizontal relative moving angle, which identifies the angle between the horizontal direction from a cell and the moving direction. the object comes in the following forms: the definitions and parameters of these are: the Modifiers to the horizontal keywords are:- {zero_factor}—Establishes the horizontal factor used when the HRMA is 0. This factor positions the y intercept for any of the horizontal factor functions.
- {cut_angle}—Defines the HRMA angle beyond which the HF will be set to infinity.
- {slope}—Establishes the slope of the straight line used with the LINEAR and INVERSE_LINEAR horizontal-factor keywords. The slope is specified as a fraction of rise over run (for example, 45 percent slope is 1/45, which is input as 0.02222).
- {side_value}—Establishes the HF when the HRMA is greater than or equal to 45 degrees and less than 90 degrees when the FORWARD horizontal-factor keyword is specified.
- in_table—Identifies the name of the table defining the HF.
getInVerticalRaster
public Object getInVerticalRaster()
- Returns the Input vertical raster parameter of this tool .
This parameter is a raster defining the z-values for each cell location. the values are used for calculating the slope used to identify the vertical factor incurred when moving from one cell to another.
This is an optional parameter.
- Returns:
- the Input vertical raster
setInVerticalRaster
public void setInVerticalRaster(Object inVerticalRaster)
- Sets the Input vertical raster parameter of this tool .
This parameter is a raster defining the z-values for each cell location. the values are used for calculating the slope used to identify the vertical factor incurred when moving from one cell to another.
This is an optional parameter.
- Parameters:
inVerticalRaster - a raster defining the z-values for each cell location. the values are used for calculating the slope used to identify the vertical factor incurred when moving from one cell to another.
getVerticalFactor
public Object getVerticalFactor()
- Returns the Vertical factor parameter of this tool .
This parameter is the Vertical factor object defines the relationship between the vertical cost factor and the vertical relative moving angle (VRMA). there are several factors with modifiers from which to select that identify a defined vertical factor graph. Additionally, a table can be used to create a custom graph. The graphs are used to identify the vertical factor used in calculating the total cost for moving into a neighboring cell. in the explanations below, two acronyms are used: 'VF' stands for vertical factor, which defines the vertical difficulty encountered in moving from one cell to the next; and 'VRMA' stands for vertical relative moving angle, which identifies the slope angle between the FROM or processing cell and the TO cell. the object comes in the following forms: the definitions and parameters of these are: the Modifiers to the vertical parameters are:
This is an optional parameter.
- Returns:
- the Vertical factor
setVerticalFactor
public void setVerticalFactor(Object verticalFactor)
- Sets the Vertical factor parameter of this tool .
This parameter is the Vertical factor object defines the relationship between the vertical cost factor and the vertical relative moving angle (VRMA). there are several factors with modifiers from which to select that identify a defined vertical factor graph. Additionally, a table can be used to create a custom graph. The graphs are used to identify the vertical factor used in calculating the total cost for moving into a neighboring cell. in the explanations below, two acronyms are used: 'VF' stands for vertical factor, which defines the vertical difficulty encountered in moving from one cell to the next; and 'VRMA' stands for vertical relative moving angle, which identifies the slope angle between the FROM or processing cell and the TO cell. the object comes in the following forms: the definitions and parameters of these are: the Modifiers to the vertical parameters are:
This is an optional parameter.
- Parameters:
verticalFactor - the Vertical factor object defines the relationship between the vertical cost factor and the vertical relative moving angle (VRMA). there are several factors with modifiers from which to select that identify a defined vertical factor graph. Additionally, a table can be used to create a custom graph. The graphs are used to identify the vertical factor used in calculating the total cost for moving into a neighboring cell. in the explanations below, two acronyms are used: 'VF' stands for vertical factor, which defines the vertical difficulty encountered in moving from one cell to the next; and 'VRMA' stands for vertical relative moving angle, which identifies the slope angle between the FROM or processing cell and the TO cell. the object comes in the following forms: the definitions and parameters of these are: the Modifiers to the vertical parameters are:- VfBinary, VfLinear, VfInverseLinear, VfSymLinear, VfSymInverseLinear, VfCos, VfSec, VfSec, VfCosSec, VfSecCos, VfTable.
getMaximumDistance
public double getMaximumDistance()
- Returns the Maximum distance parameter of this tool .
This parameter is defines the threshold that the accumulative cost values cannot exceed. if an accumulative cost distance value exceeds this value, the output value for the cell location will be NoData. The maximum distance defines the extent for which the accumulative cost 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 defines the threshold that the accumulative cost values cannot exceed. if an accumulative cost distance value exceeds this value, the output value for the cell location will be NoData. The maximum distance defines the extent for which the accumulative cost distances are calculated. the default distance is to the edge of the output raster.
This is an optional parameter.
- Parameters:
maximumDistance - defines the threshold that the accumulative cost values cannot exceed. if an accumulative cost distance value exceeds this value, the output value for the cell location will be NoData. The maximum distance defines the extent for which the accumulative cost distances are calculated. the default distance is to the edge of the output raster.
getOutBacklinkRaster
public Object getOutBacklinkRaster()
- Returns the Output backlink raster parameter of this tool .
This parameter is the output cost back-link raster. the back-link raster contains values of 0 through 8, which define the direction or identify the next neighboring cell (the succeeding cell) along the least accumulative cost path from a cell to reach its least cost source, while accounting for surface distance as well as horizontal and vertical surface factors. if the path is to pass into the right neighbor, the cell will be assigned the value 1, 2 for the lower right diagonal cell, and continuing clockwise. The value 0 is reserved for source cells.
This is an optional parameter.
- Returns:
- the Output backlink raster
setOutBacklinkRaster
public void setOutBacklinkRaster(Object outBacklinkRaster)
- Sets the Output backlink raster parameter of this tool .
This parameter is the output cost back-link raster. the back-link raster contains values of 0 through 8, which define the direction or identify the next neighboring cell (the succeeding cell) along the least accumulative cost path from a cell to reach its least cost source, while accounting for surface distance as well as horizontal and vertical surface factors. if the path is to pass into the right neighbor, the cell will be assigned the value 1, 2 for the lower right diagonal cell, and continuing clockwise. The value 0 is reserved for source cells.
This is an optional parameter.
- Parameters:
outBacklinkRaster - the output cost back-link raster. the back-link raster contains values of 0 through 8, which define the direction or identify the next neighboring cell (the succeeding cell) along the least accumulative cost path from a cell to reach its least cost source, while accounting for surface distance as well as horizontal and vertical surface factors. if the path is to pass into the right neighbor, the cell will be assigned the value 1, 2 for the lower right diagonal cell, and continuing clockwise. The value 0 is reserved for source cells.
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