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

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

All Implemented Interfaces:

GPTool

public class EucAllocation
extends AbstractGPTool

Calculates, for each cell, the nearest source based on Euclidean distance. The Euclidean Allocation 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 input value raster is useful if the input raster or feature source data is a raster derived from a function that results in either one or zero. These functions lose their original zone values associated with the source cell locations. The input value raster can either restore these values or allow analysis on additional combinations of zone values within the source cells.
• If an input value raster is used, it may change the configuration and results of the Euclidean allocation output. It will not affect the optional Euclidean distance or direction results.
• The output allocation raster is of integer type.
• The output direction raster is of integer type.
• The output distance raster is of floating point type.
• 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 assigned NoData because of the mask on the input surface will receive NoData on all the output rasters: Euclidean allocation, Euclidean distance, and Euclidean direction.

Field Summary

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

vals

Constructor Summary

EucAllocation()
Creates the Euclidean Allocation tool with defaults.

EucAllocation(Object inSourceData, Object outAllocationRaster)
Creates the Euclidean Allocation 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 .
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	getOutDirectionRaster() Returns the Output direction 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	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	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	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 .
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

EucAllocation

public EucAllocation()

Creates the Euclidean Allocation tool with defaults.

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

EucAllocation

public EucAllocation(Object inSourceData,
                     Object outAllocationRaster)

Creates the Euclidean 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 can be integer or floating point. If the input is floating point, a value raster must be set. The value raster must be integer. The value raster will take precedence over the source field if it is set.

outAllocationRaster - Raster Dataset, a raster that identifies the zone that could be reached with the least accumulative cost from each source location.

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 can be integer or floating point. If the input is floating point, a value raster must be set. The value raster must be integer. The value raster will take precedence over the source field if it is set. 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 can be integer or floating point. If the input is floating point, a value raster must be set. The value raster must be integer. The value raster will take precedence over the source field if it is set. This is a required parameter.

Parameters:

inSourceData - Composite Geodataset, for rasters, the input can be integer or floating point. If the input is floating point, a value raster must be set. The value raster must be integer. The value raster will take precedence over the source field if it is set.

getOutAllocationRaster

public Object getOutAllocationRaster()

Returns the Output allocation raster parameter of this tool . This parameter is Raster Dataset, a raster that identifies the zone that could be reached with the least accumulative cost from each source location. 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 that could be reached with the least accumulative cost from each source location. This is a required parameter.

Parameters:

outAllocationRaster - Raster Dataset, a raster that identifies the zone that could be reached with the least accumulative cost from each source location.

getMaximumDistance

public double getMaximumDistance()

Returns the Maximum distance parameter of this tool . This parameter is Double, the {maximum_distance} defines the extent for which the accumulative Euclidean distances are calculated. If an accumulative Euclidean distance value exceeds the {maximum_distance}, 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 Double, the {maximum_distance} defines the extent for which the accumulative Euclidean distances are calculated. If an accumulative Euclidean distance value exceeds the {maximum_distance}, 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 - Double, the {maximum_distance} defines the extent for which the accumulative Euclidean distances are calculated. If an accumulative Euclidean distance value exceeds the {maximum_distance}, the output value for the cell location will be NoData. 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 used instead of those existing in the input source. This parameter must be used if the source field is floating point. 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 must be used if the source field is floating point. 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 must be used if the source field is floating point. 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.

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.

getSourceField

public Object getSourceField()

Returns the Source field parameter of this tool . This parameter is Field, if the {source_field} is floating point, an {in_value_raster} must be used. By setting the {in_value_raster}, the field set for the {source_field} parameter will be overridden by the value field of the {in_value_raster}. 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, if the {source_field} is floating point, an {in_value_raster} must be used. By setting the {in_value_raster}, the field set for the {source_field} parameter will be overridden by the value field of the {in_value_raster}. This is an optional parameter.

Parameters:

sourceField - Field, if the {source_field} is floating point, an {in_value_raster} must be used. By setting the {in_value_raster}, the field set for the {source_field} parameter will be overridden by the value field of the {in_value_raster}.

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.

getOutDirectionRaster

public Object getOutDirectionRaster()

Returns the Output direction raster parameter of this tool . This parameter is Raster Dataset, the direction raster contains the calculated direction, in degrees, each cell center is from the closest source cell center. The range of values is 0 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). This is an optional 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, the direction raster contains the calculated direction, in degrees, each cell center is from the closest source cell center. The range of values is 0 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). This is an optional parameter.

Parameters:

outDirectionRaster - Raster Dataset, the direction raster contains the calculated direction, in degrees, each cell center is from the closest source cell center. The range of values is 0 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).

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