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.

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

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 - 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. if the input source raster is floating point, the {in_value_raster} must be set, and it must be of integer type. The value raster will take precedence over any setting of the {source_field}.

outAllocationRaster - the output Euclidean allocation raster. the cell values (zones) identify the nearest source location. the output raster is of integer type.

Method Detail

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 Euclidean distance for every output cell location is calculated. for rasters, the input type can be integer or floating point. if the input source raster is floating point, the {in_value_raster} must be set, and it must be of integer type. The value raster will take precedence over any setting of the {source_field}. 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 Euclidean distance for every output cell location is calculated. for rasters, the input type can be integer or floating point. if the input source raster is floating point, the {in_value_raster} must be set, and it must be of integer type. The value raster will take precedence over any setting of the {source_field}. 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. if the input source raster is floating point, the {in_value_raster} must be set, and it must be of integer type. The value raster will take precedence over any setting of the {source_field}.

getOutAllocationRaster

public Object getOutAllocationRaster()

Returns the Output allocation raster parameter of this tool . This parameter is the output Euclidean allocation raster. the cell values (zones) identify the nearest source location. the output raster is of integer type. 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 the output Euclidean allocation raster. the cell values (zones) identify the nearest source location. the output raster is of integer type. This is a required parameter.

Parameters:

outAllocationRaster - the output Euclidean allocation raster. the cell values (zones) identify the nearest source location. 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.

getInValueRaster

public Object getInValueRaster()

Returns the Input value raster parameter of this tool . This parameter is the input integer raster that identifies the zone values that should be used for each input source location. for each source location (cell or feature), the value defined by the {in_value_raster} will be assigned to all cells allocated to the source location for the computation. The value raster will take precedence over any setting for the {source_field}. 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 the input integer raster that identifies the zone values that should be used for each input source location. for each source location (cell or feature), the value defined by the {in_value_raster} will be assigned to all cells allocated to the source location for the computation. The value raster will take precedence over any setting for the {source_field}. This is an optional parameter.

Parameters:

inValueRaster - the input integer raster that identifies the zone values that should be used for each input source location. for each source location (cell or feature), the value defined by the {in_value_raster} will be assigned to all cells allocated to the source location for the computation. The value raster will take precedence over any setting for the {source_field}.

getCellSize

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

getSourceField

public Object getSourceField()

Returns the Source field parameter of this tool . This parameter is the field used to assign values to the source locations. It must be integer type. if the {in_value_raster} has been set, the values in that input will have 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 the field used to assign values to the source locations. It must be integer type. if the {in_value_raster} has been set, the values in that input will have precedence over any setting for the {source_field}. This is an optional parameter.

Parameters:

sourceField - the field used to assign values to the source locations. It must be integer type. if the {in_value_raster} has been set, the values in that input will have precedence over any setting for the {source_field}.

getOutDistanceRaster

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

getOutDirectionRaster

public 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 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 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 an optional 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.

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