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

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

All Implemented Interfaces:

GPTool

public class Spline
extends AbstractGPTool

Interpolates a surface from points using a minimum curvature spline technique. The Spline tool is contained in the 3D Analyst Tools tool box.
Learn more about how Spline works

Software restrictions: none

Usage tips:

• The resulting smooth surface from the Spline tool passes exactly through the input points.
• The REGULARIZED option of Spline Type usually produces smoother surfaces than those created with the TENSION option.
• With the REGULARIZED option, higher values used for the weight parameter produce smoother surfaces. The values entered for this parameter must be equal to or greater than zero. Typical values used are 0, 0.001, 0.01, 0.1, and 0.5. The Weight is the square of the parameter referred to in the literature as tau (t).
• With the TENSION option, higher values entered for the weight parameter result in somewhat coarser surfaces, but surfaces that closely conform to the control points. The values entered must be equal to or greater than zero. Typical values are 0, 1, 5, and 10. The Weight is the square of the parameter referred to in the literature as phi ().
• The greater the value of Number of Points, the smoother the surface of the output raster.
• 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 may cause the Spline tool to fail. The solution is to prepare your data by removing these points.
• The following environment settings affect this tool:

Field Summary

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

vals

Constructor Summary

Spline()
Creates the Spline tool with defaults.

Spline(Object inPointFeatures, Object zField, Object outRaster)
Creates the Spline tool with the required parameters.

Method Summary

Object	getCellSize() Returns the Output cell size parameter of this tool .
Object	getInPointFeatures() Returns the Input point features parameter of this tool .
int	getNumberPoints() Returns the Number of points parameter of this tool .
Object	getOutRaster() Returns the Output raster parameter of this tool .
String	getSplineType() Returns the Spline type 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.
double	getWeight() Returns the Weight parameter of this tool .
Object	getZField() Returns the Z value field parameter of this tool .
void	setCellSize(Object cellSize) Sets the Output cell size parameter of this tool .
void	setInPointFeatures(Object inPointFeatures) Sets the Input point features parameter of this tool .
void	setNumberPoints(int numberPoints) Sets the Number of points parameter of this tool .
void	setOutRaster(Object outRaster) Sets the Output raster parameter of this tool .
void	setSplineType(String splineType) Sets the Spline type parameter of this tool .
void	setWeight(double weight) Sets the Weight parameter of this tool .
void	setZField(Object zField) 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

Spline

public Spline()

Creates the Spline tool with defaults.

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

Spline

public Spline(Object inPointFeatures,
              Object zField,
              Object outRaster)

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

inPointFeatures - Composite Geodataset, the input point features containing the z-values to be interpolated into a surface raster.

zField - Field, this can be a numeric field or the shape field if the in_point_features contain z-values.

outRaster - Raster Dataset, the output raster surface to be created.

Method Detail

getInPointFeatures

public Object getInPointFeatures()

Returns the Input point features parameter of this tool . This parameter is Composite Geodataset, the input point features containing the z-values to be interpolated into a surface raster. This is a required parameter.

Returns:

the Input point features

setInPointFeatures

public void setInPointFeatures(Object inPointFeatures)

Sets the Input point features parameter of this tool . This parameter is Composite Geodataset, the input point features containing the z-values to be interpolated into a surface raster. This is a required parameter.

Parameters:

inPointFeatures - Composite Geodataset, the input point features containing the z-values to be interpolated into a surface raster.

getZField

public Object getZField()

Returns the Z value field parameter of this tool . This parameter is Field, this can be a numeric field or the shape field if the in_point_features contain z-values. This is a required parameter.

Returns:

the Z value field

setZField

public void setZField(Object zField)

Sets the Z value field parameter of this tool . This parameter is Field, this can be a numeric field or the shape field if the in_point_features contain z-values. This is a required parameter.

Parameters:

zField - Field, this can be a numeric field or the shape field if the in_point_features contain z-values.

getOutRaster

public Object getOutRaster()

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

Returns:

the Output raster

setOutRaster

public void setOutRaster(Object outRaster)

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

Parameters:

outRaster - Raster Dataset, the output raster surface to be created.

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. Otherwise, it is the shorter of the width or the height of the extent of in_point_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. Otherwise, it is the shorter of the width or the height of the extent of in_point_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. Otherwise, it is the shorter of the width or the height of the extent of in_point_features in the input spatial reference, divided by 250.

getSplineType

public String getSplineType()

Returns the Spline type parameter of this tool . This parameter is String, the type of spline to be used. This is an optional parameter.

Returns:

the Spline type

setSplineType

public void setSplineType(String splineType)

Sets the Spline type parameter of this tool . This parameter is String, the type of spline to be used. This is an optional parameter.

Parameters:

splineType - String, the type of spline to be used.

getWeight

public double getWeight()

Returns the Weight parameter of this tool . This parameter is Double, the default weight is 0.1. This is an optional parameter.

Returns:

the Weight

setWeight

public void setWeight(double weight)

Sets the Weight parameter of this tool . This parameter is Double, the default weight is 0.1. This is an optional parameter.

Parameters:

weight - Double, the default weight is 0.1.

getNumberPoints

public int getNumberPoints()

Returns the Number of points parameter of this tool . This parameter is Long, the default is 12. This is an optional parameter.

Returns:

the Number of points

setNumberPoints

public void setNumberPoints(int numberPoints)

Sets the Number of points parameter of this tool . This parameter is Long, the default is 12. This is an optional parameter.

Parameters:

numberPoints - Long, the default is 12.

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