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

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

All Implemented Interfaces:

GPTool

public class CostAllocation
extends AbstractGPTool

Calculates for each cell its nearest source based on the least accumulative cost over a cost surface. The Cost Allocation tool is contained in the Spatial Analyst Tools tool box.
Learn more about how Cost 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.
• Cell locations with NoData in the input cost raster act as barriers in the cost surface functions. Any cell location assigned NoData on the input cost surface will receive NoData on all outputs (cost allocation raster and, optionally, cost distance and cost back link 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 the Union of Inputs option on the Raster Settings of the Environment Settings dialog box.
• 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 cost 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 outputs (cost allocation raster and, optionally, the cost distance and cost back link rasters).
• The input value raster is useful if the input source data is a raster and was derived from a function or operator that results in either one or zero. These functions lose the original zone values on the input raster that are associated with these locations. The input value raster can either restore these values or allow for analysis on additional combinations of zone values within the source locations.
• If an input value raster is used, it may change the configuration and results of the cost allocation output; it will not affect the optional cost distance or the back link results.
• The maximum distance is specified in the same cost units as those on the input cost raster.
• For the optional output distance raster, the least-cost distance (or minimum accumulative cost distance) of a cell to a set of source cells is the lower bound of the least-cost distance from the cell to all source cells.
• The output type for the output allocation raster is integer.
• The output type for the optional output distance raster is floating point.
• The output type for the optional output backlink raster is integer.

Field Summary

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

vals

Constructor Summary

CostAllocation()
Creates the Cost Allocation tool with defaults.

CostAllocation(Object inSourceData, Object inCostRaster, Object outAllocationRaster)
Creates the Cost Allocation tool with the required parameters.

Method Summary

Object	getInCostRaster() Returns the Input cost raster parameter of this tool .
Object	getInSourceData() Returns the Input raster or feature source data parameter of this tool .
Object	getInValueRaster() Returns the Input value 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.
void	setInCostRaster(Object inCostRaster) Sets the Input cost raster parameter of this tool .
void	setInSourceData(Object inSourceData) Sets the Input raster or feature source data parameter of this tool .
void	setInValueRaster(Object inValueRaster) Sets the Input value 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 .

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

CostAllocation

public CostAllocation()

Creates the Cost Allocation tool with defaults.

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

CostAllocation

public CostAllocation(Object inSourceData,
                      Object inCostRaster,
                      Object outAllocationRaster)

Creates the Cost 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, if raster, it must be integer type. For features, only integer fields can be used.

inCostRaster - Composite Geodataset, 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 in_cost_raster values can be integer or floating point, but they cannot be negative or zero (you cannot have a negative or zero cost).

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.

Method Detail

getInSourceData

public Object getInSourceData()

Returns the Input raster or feature source data parameter of this tool . This parameter is Composite Geodataset, if raster, it must be integer type. For features, only integer fields can be 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, if raster, it must be integer type. For features, only integer fields can be used. This is a required parameter.

Parameters:

inSourceData - Composite Geodataset, if raster, it must be integer type. For features, only integer fields can be used.

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 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 in_cost_raster values can be integer or floating point, but they cannot be negative or zero (you cannot have a negative or zero cost). This is a required 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 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 in_cost_raster values can be integer or floating point, but they cannot be negative or zero (you cannot have a negative or zero cost). This is a required parameter.

Parameters:

inCostRaster - Composite Geodataset, 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 in_cost_raster values can be integer or floating point, but they cannot be negative or zero (you cannot have a negative or zero cost).

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. 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. 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.

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 location will be NoData. The {max_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 Double, if an accumulative cost distance value exceeds the {max_distance}, the output value for the cell location will be NoData. The {max_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 - Double, if an accumulative cost distance value exceeds the {max_distance}, the output value for the cell location will be NoData. The {max_distance} defines the extent for which the accumulative cost distances are calculated. The default distance is to the edge of the output raster.

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 to be used instead of the existing ones 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 0 and 1. 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 to be used instead of the existing ones 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 0 and 1. This is an optional parameter.

Parameters:

inValueRaster - Composite Geodataset, this parameter can be used if other values or zones are to be used instead of the existing ones 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 0 and 1.

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 cost distance raster identifies, for each cell, the least accumulative cost distance over a cost surface to the identified source locations. A source can be a cell, a set of cells, or 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 cost distance raster identifies, for each cell, the least accumulative cost distance over a cost surface to the identified source locations. A source can be a cell, a set of cells, or feature locations. This is an optional parameter.

Parameters:

outDistanceRaster - Raster Dataset, the cost distance raster identifies, for each cell, the least accumulative cost distance over a cost surface to the identified source locations. A source can be a cell, a set of cells, or 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