com.esri.arcgis.geoprocessing.tools.analyst3dtools
Class SplineWithBarriers

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.analyst3dtools.SplineWithBarriers

All Implemented Interfaces:

GPTool

public class SplineWithBarriers
extends AbstractGPTool

Interpolates a surface, using barriers, from points using a minimum curvature spline technique. The barriers are entered as either polygon or polyline features. The Spline with Barriers tool is contained in the 3D Analyst Tools tool box.
Learn more about how Spline With Barriers works

Software restrictions: none

Usage tips:

• This tool requires the Java Runtime Environment Version 5.0, or higher, to be installed. The Java Runtime Environment can be downloaded free from http://www.java.com/en/download
• The resulting smooth surface from the spline with barrier tool is constrained by the input barrier features.
• Some input datasets may have several points with the same X,Y coordinates. If the values of the points at the common location are the same, they are considered duplicates and have no affect on the output. If the values are different, they are considered 'coincident' points. The values will be averaged at locations that have coincident data. This may cause some locations in the output raster to have different values than what you might expect. The solution is to prepare your data by removing these coincident points.
• If a cell size of zero is entered the shorter of the width or the height of the extent of the input point features in the input spatial reference, divided by 250, will be used as the cell size.
• The following environment settings affect this tool: Output has Z values; Output Coordinate system; Output Extent; (and Snap Raster).

Field Summary

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

vals

Constructor Summary

SplineWithBarriers()
Creates the Spline with Barriers tool with defaults.

SplineWithBarriers(Object inputPointFeatures, Object zValueField, Object outputCellSize, Object outputRaster)
Creates the Spline with Barriers tool with the required parameters.

Method Summary

Object	getInputBarrierFeatures() Returns the Input barrier features parameter of this tool .
Object	getInputPointFeatures() Returns the Input point features parameter of this tool .
Object	getOutputCellSize() Returns the Output cell size parameter of this tool .
Object	getOutputRaster() Returns the Output raster parameter of this tool .
double	getSmoothingFactor() Returns the Smoothing Factor 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	getZValueField() Returns the Z value field parameter of this tool .
void	setInputBarrierFeatures(Object inputBarrierFeatures) Sets the Input barrier features parameter of this tool .
void	setInputPointFeatures(Object inputPointFeatures) Sets the Input point features parameter of this tool .
void	setOutputCellSize(Object outputCellSize) Sets the Output cell size parameter of this tool .
void	setOutputRaster(Object outputRaster) Sets the Output raster parameter of this tool .
void	setSmoothingFactor(double smoothingFactor) Sets the Smoothing Factor parameter of this tool .
void	setZValueField(Object zValueField) Sets the Z value 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

SplineWithBarriers

public SplineWithBarriers()

Creates the Spline with Barriers tool with defaults.

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

SplineWithBarriers

public SplineWithBarriers(Object inputPointFeatures,
                          Object zValueField,
                          Object outputCellSize,
                          Object outputRaster)

Creates the Spline with Barriers 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:

inputPointFeatures - null

zValueField - null

outputCellSize - Analysis cell size, if a value of zero is entered the shorter of the width or the height of the extent of the input point features in the input spatial reference, divided by 250, will be used as the cell size.

outputRaster - Raster, the output raster surface to be created.

Method Detail

getInputPointFeatures

public Object getInputPointFeatures()

Returns the Input point features parameter of this tool . This is a required parameter.

Returns:

the Input point features

setInputPointFeatures

public void setInputPointFeatures(Object inputPointFeatures)

Sets the Input point features parameter of this tool . This is a required parameter.

Parameters:

inputPointFeatures - null

getZValueField

public Object getZValueField()

Returns the Z value field parameter of this tool . This is a required parameter.

Returns:

the Z value field

setZValueField

public void setZValueField(Object zValueField)

Sets the Z value field parameter of this tool . This is a required parameter.

Parameters:

zValueField - null

getInputBarrierFeatures

public Object getInputBarrierFeatures()

Returns the Input barrier features parameter of this tool . This is an optional parameter.

Returns:

the Input barrier features

setInputBarrierFeatures

public void setInputBarrierFeatures(Object inputBarrierFeatures)

Sets the Input barrier features parameter of this tool . This is an optional parameter.

Parameters:

inputBarrierFeatures - null

getOutputCellSize

public Object getOutputCellSize()

Returns the Output cell size parameter of this tool . This parameter is Analysis cell size, if a value of zero is entered the shorter of the width or the height of the extent of the input point features in the input spatial reference, divided by 250, will be used as the cell size. This is a required parameter.

Returns:

the Output cell size

setOutputCellSize

public void setOutputCellSize(Object outputCellSize)

Sets the Output cell size parameter of this tool . This parameter is Analysis cell size, if a value of zero is entered the shorter of the width or the height of the extent of the input point features in the input spatial reference, divided by 250, will be used as the cell size. This is a required parameter.

Parameters:

outputCellSize - Analysis cell size, if a value of zero is entered the shorter of the width or the height of the extent of the input point features in the input spatial reference, divided by 250, will be used as the cell size.

getOutputRaster

public Object getOutputRaster()

Returns the Output raster parameter of this tool . This parameter is Raster, the output raster surface to be created. This is a required parameter.

Returns:

the Output raster

setOutputRaster

public void setOutputRaster(Object outputRaster)

Sets the Output raster parameter of this tool . This parameter is Raster, the output raster surface to be created. This is a required parameter.

Parameters:

outputRaster - Raster, the output raster surface to be created.

getSmoothingFactor

public double getSmoothingFactor()

Returns the Smoothing Factor parameter of this tool . This is an optional parameter.

Returns:

the Smoothing Factor

setSmoothingFactor

public void setSmoothingFactor(double smoothingFactor)

Sets the Smoothing Factor parameter of this tool . This is an optional parameter.

Parameters:

smoothingFactor - null

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