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

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

All Implemented Interfaces:

GPTool

public class PathAllocation
extends AbstractGPTool

Calculates the nearest source for each cell based on the least accumulative cost over a cost surface, while accounting for surface distance and horizontal and vertical cost factors. The Path Distance Allocation tool is contained in the Spatial Analyst Tools tool box.
Learn more about how Path Distance works

Software restrictions: none

Usage tips:

• Learn more about Path Distance - adding more cost complexity;
• 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.
• Cells with NoData act as barriers in the Path Distance functions. 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 input 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 Union of Inputs on the Raster Settings of the Environment Settings.
• If a mask has been set in the environment, any masked cells will be treated as NoData values.
• When a mask has been defined in the Analysis window and the cells to be masked will mask a source, the Path Distance surface 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 output rasters.
• The output of the Aspect tool can be used as input for the Horizontal factor.
• The maximum distance is specified in the same cost units as those on the input surface raster.
• The output type for the Output allocation raster and Output backlink raster is always integer.
• The output type for the Output distance raster always contains all floating-point values.
• The least-cost path distance or minimum accumulative cost distance of a cell from a set of source locations is the lower bound of the least-cost path distance to the cell from all source locations.
• The default values for the Horizontal factor modifiers are: Keywords Zero factor Cut angle Slope Side value-------------- ----------- ----------- ----- ---------Binary 1.0 45 ~ ~Forward 0.5 45 (fixed) ~ 1.0Linear 0.5 181 1/90 ~Inverse linear 2.0 180 -1/90 ~
• The default values for the Vertical factor modifiers are: Keyword Zero factor Low cut Height cut Slope Power Cos Sec angle angle power power ------------------------ ----------- ------- ---------- ----- ----- ----- -----Binary 1.0 -30 30 ~ ~ ~ ~Linear 1.0 -90 90 1/90 ~ ~ ~Symmetric linear 1.0 -90 90 1/90 ~ ~ ~Inverse linear 1.0 -45 45 -1/45 ~ ~ ~Symmetric inverse linear 1.0 -45 45 -1/45 ~ ~ ~Cos ~ -90 90 ~ 1.0 ~ ~Sec ~ -90 90 ~ 1.0 ~ ~Cos_sec ~ -90 90 ~ ~ 1.0 1.0Sec_cos ~ -90 90 ~ ~ 1.0 1.0

Field Summary

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

vals

Constructor Summary

PathAllocation()
Creates the Path Distance Allocation tool with defaults.

PathAllocation(Object inSourceData, Object outAllocationRaster)
Creates the Path Distance Allocation tool with the required parameters.

Method Summary

Object	getHorizontalFactor() Returns the Horizontal factor parameter of this tool .
Object	getInCostRaster() Returns the Input cost raster parameter of this tool .
Object	getInHorizontalRaster() Returns the Input horizontal raster parameter of this tool .
Object	getInSourceData() Returns the Input raster or feature source data parameter of this tool .
Object	getInSurfaceRaster() Returns the Input surface raster parameter of this tool .
Object	getInValueRaster() Returns the Input value raster parameter of this tool .
Object	getInVerticalRaster() Returns the Input vertical raster parameter of this tool .
double	getMaximumDistance() Returns the Maximum distance parameter of this tool .
Object	getOutAllocationRaster() Returns the Output allocation raster parameter of this tool .
Object	getOutBacklinkRaster() Returns the Output backlink raster parameter of this tool .
Object	getOutDistanceRaster() Returns the Output distance raster parameter of this tool .
Object	getSourceField() Returns the Source field 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.
Object	getVerticalFactor() Returns the Vertical factor parameter of this tool .
void	setHorizontalFactor(Object horizontalFactor) Sets the Horizontal factor parameter of this tool .
void	setInCostRaster(Object inCostRaster) Sets the Input cost raster parameter of this tool .
void	setInHorizontalRaster(Object inHorizontalRaster) Sets the Input horizontal raster parameter of this tool .
void	setInSourceData(Object inSourceData) Sets the Input raster or feature source data parameter of this tool .
void	setInSurfaceRaster(Object inSurfaceRaster) Sets the Input surface raster parameter of this tool .
void	setInValueRaster(Object inValueRaster) Sets the Input value raster parameter of this tool .
void	setInVerticalRaster(Object inVerticalRaster) Sets the Input vertical raster parameter of this tool .
void	setMaximumDistance(double maximumDistance) Sets the Maximum distance parameter of this tool .
void	setOutAllocationRaster(Object outAllocationRaster) Sets the Output allocation raster parameter of this tool .
void	setOutBacklinkRaster(Object outBacklinkRaster) Sets the Output backlink raster parameter of this tool .
void	setOutDistanceRaster(Object outDistanceRaster) Sets the Output distance raster parameter of this tool .
void	setSourceField(Object sourceField) Sets the Source field parameter of this tool .
void	setVerticalFactor(Object verticalFactor) Sets the Vertical factor 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

PathAllocation

public PathAllocation()

Creates the Path Distance Allocation tool with defaults.

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

PathAllocation

public PathAllocation(Object inSourceData,
                      Object outAllocationRaster)

Creates the Path Distance Allocation 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, for rasters, the input value can be integer, string, or floating-point type if in_value_raster is used.

outAllocationRaster - Raster Dataset, a raster that identifies the zone of each source location (cell or feature) that could be reached with the least accumulative cost, while accounting for surface distance and horizontal and vertical cost factors.

Method Detail

getInSourceData

public Object getInSourceData()

Returns the Input raster or feature source data parameter of this tool . This parameter is Composite Geodataset, for rasters, the input value can be integer, string, or floating-point type if in_value_raster is used. 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, for rasters, the input value can be integer, string, or floating-point type if in_value_raster is used. This is a required parameter.

Parameters:

inSourceData - Composite Geodataset, for rasters, the input value can be integer, string, or floating-point type if in_value_raster is used.

getOutAllocationRaster

public Object getOutAllocationRaster()

Returns the Output allocation raster parameter of this tool . This parameter is Raster Dataset, a raster that identifies the zone of each source location (cell or feature) that could be reached with the least accumulative cost, while accounting for surface distance and horizontal and vertical cost factors. This is a required parameter.

Returns:

the Output allocation raster

setOutAllocationRaster

public void setOutAllocationRaster(Object outAllocationRaster)

Sets the Output allocation raster parameter of this tool . This parameter is Raster Dataset, a raster that identifies the zone of each source location (cell or feature) that could be reached with the least accumulative cost, while accounting for surface distance and horizontal and vertical cost factors. This is a required parameter.

Parameters:

outAllocationRaster - Raster Dataset, a raster that identifies the zone of each source location (cell or feature) that could be reached with the least accumulative cost, while accounting for surface distance and horizontal and vertical cost factors.

getInCostRaster

public Object getInCostRaster()

Returns the Input cost raster parameter of this tool . This parameter is Composite Geodataset, the value at each cell location represents the cost per unit of surface distance for moving through the cell. Each cell location value is multiplied by the cell resolution, while compensating for diagonal movement, to obtain the total cost of passing through the cell. The values on the {in_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 Composite Geodataset, the value at each cell location represents the cost per unit of surface distance for moving through the cell. Each cell location value is multiplied by the cell resolution, while compensating for diagonal movement, to obtain the total cost of passing through the cell. The values on the {in_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 - Composite Geodataset, the value at each cell location represents the cost per unit of surface distance for moving through the cell. Each cell location value is multiplied by the cell resolution, while compensating for diagonal movement, to obtain the total cost of passing through the cell. The values on the {in_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 Composite Geodataset, 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 Composite Geodataset, the values are used to calculate the actual surface distance covered when passing between cells. This is an optional parameter.

Parameters:

inSurfaceRaster - Composite Geodataset, 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 Composite Geodataset, 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 Composite Geodataset, 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 - Composite Geodataset, 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 Horizontal factor, binary Zero factor Cut angle Forward Zero factor Side angle Linear Zero factor Cut angle Slope Inverse_Linear Zero factor Cut angle Slope Table Table name 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 Horizontal factor, binary Zero factor Cut angle Forward Zero factor Side angle Linear Zero factor Cut angle Slope Inverse_Linear Zero factor Cut angle Slope Table Table name This is an optional parameter.

Parameters:

horizontalFactor - Horizontal factor, binary Zero factor Cut angle Forward Zero factor Side angle Linear Zero factor Cut angle Slope Inverse_Linear Zero factor Cut angle Slope Table Table name

getInVerticalRaster

public Object getInVerticalRaster()

Returns the Input vertical raster parameter of this tool . This parameter is Composite Geodataset, 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 Composite Geodataset, 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 - Composite Geodataset, 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 Vertical factor, binary Zero factor Low cut angle High cut angle Linear Zero factor Low cut angle High cut angle Slope Inverse linear Zero factor Low cut angle High cut angle Slope Symmetric linear Zero factor Low cut angle High cut angle Slope Symmetric inverse linear Zero factor Low cut angle High cut angle Slope Cos Low cut angle High cut angle Power Sec Low cut angle High cut angle Power Cos-sec Low cut angle High cut angle Cos power Sec power Sec-cos Low cut angle High cut angle Cos power Sec power Table Table name 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 Vertical factor, binary Zero factor Low cut angle High cut angle Linear Zero factor Low cut angle High cut angle Slope Inverse linear Zero factor Low cut angle High cut angle Slope Symmetric linear Zero factor Low cut angle High cut angle Slope Symmetric inverse linear Zero factor Low cut angle High cut angle Slope Cos Low cut angle High cut angle Power Sec Low cut angle High cut angle Power Cos-sec Low cut angle High cut angle Cos power Sec power Sec-cos Low cut angle High cut angle Cos power Sec power Table Table name This is an optional parameter.

Parameters:

verticalFactor - Vertical factor, binary Zero factor Low cut angle High cut angle Linear Zero factor Low cut angle High cut angle Slope Inverse linear Zero factor Low cut angle High cut angle Slope Symmetric linear Zero factor Low cut angle High cut angle Slope Symmetric inverse linear Zero factor Low cut angle High cut angle Slope Cos Low cut angle High cut angle Power Sec Low cut angle High cut angle Power Cos-sec Low cut angle High cut angle Cos power Sec power Sec-cos Low cut angle High cut angle Cos power Sec power Table Table name

getMaximumDistance

public double getMaximumDistance()

Returns the Maximum distance parameter of this tool . This parameter is Double, if an accumulative cost distance value exceeds the {max_distance}, the output value for the cell will be NoData. The {maximum_distance} defines the extent to which the accumulative cost distances are computed. 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 cost distance value exceeds the {max_distance}, the output value for the cell will be NoData. The {maximum_distance} defines the extent to which the accumulative cost distances are computed. This is an optional parameter.

Parameters:

maximumDistance - Double, if an accumulative cost distance value exceeds the {max_distance}, the output value for the cell will be NoData. The {maximum_distance} defines the extent to which the accumulative cost distances are computed.

getInValueRaster

public Object getInValueRaster()

Returns the Input value raster parameter of this tool . This parameter is Composite Geodataset, this parameter can be used if other values or zones are used instead of those existing in the input source. This parameter can also be used if the source raster was created by the Test function, a Boolean operator that will only output the binary values zero and one. This is an optional parameter.

Returns:

the Input value raster

setInValueRaster

public void setInValueRaster(Object inValueRaster)

Sets the Input value raster parameter of this tool . This parameter is Composite Geodataset, this parameter can be used if other values or zones are used instead of those existing in the input source. This parameter can also be used if the source raster was created by the Test function, a Boolean operator that will only output the binary values zero and one. This is an optional parameter.

Parameters:

inValueRaster - Composite Geodataset, this parameter can be used if other values or zones are used instead of those existing in the input source. This parameter can also be used if the source raster was created by the Test function, a Boolean operator that will only output the binary values zero and one.

getSourceField

public Object getSourceField()

Returns the Source field parameter of this tool . This parameter is Field, the value raster will take precedence over any setting for the {source_field}. This is an optional parameter.

Returns:

the Source field

setSourceField

public void setSourceField(Object sourceField)

Sets the Source field parameter of this tool . This parameter is Field, the value raster will take precedence over any setting for the {source_field}. This is an optional parameter.

Parameters:

sourceField - Field, the value raster will take precedence over any setting for the {source_field}.

getOutDistanceRaster

public Object getOutDistanceRaster()

Returns the Output distance raster parameter of this tool . This parameter is Raster Dataset, the path distance raster identifies, for each cell, the least accumulative cost path distance to the identified source locations. A source can be a cell, a set of cells, or one or more feature locations. 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 path distance raster identifies, for each cell, the least accumulative cost path distance to the identified source locations. A source can be a cell, a set of cells, or one or more feature locations. This is an optional parameter.

Parameters:

outDistanceRaster - Raster Dataset, the path distance raster identifies, for each cell, the least accumulative cost path distance to the identified source locations. A source can be a cell, a set of cells, or one or more feature locations.

getOutBacklinkRaster

public Object getOutBacklinkRaster()

Returns the Output backlink raster parameter of this tool . This parameter is Raster Dataset, 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 Raster Dataset, 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 - Raster Dataset, 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