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 raster surface from points using a two-dimensional minimum curvature spline technique. The Spline tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• The REGULARIZED option of Spline type usually produces smoother surfaces than those created with the TENSION option.
• 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 have no affect on the output. If the values are different, they are considered 'coincident' points.The various interpolation tools may handle this data condition differently. For example, in some cases the first coincident point encountered is used for the calculation; in other cases the last point encountered is used. 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. The tool in the Spatial Statistics toolbox is useful for identifying any coincident points in your data.

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 - the input point features containing the z-values to be interpolated into a surface raster.

zField - the field that holds a height or magnitude value for each point. this can be a numeric field or the Shape field if the input point features contains z-values.

outRaster - the output interpolated surface raster.

Method Detail

getInPointFeatures

public Object getInPointFeatures()

Returns the Input point features parameter of this tool . This parameter is 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 the input point features containing the z-values to be interpolated into a surface raster. This is a required parameter.

Parameters:

inPointFeatures - 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 the field that holds a height or magnitude value for each point. this can be a numeric field or the Shape field if the input point features contains 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 the field that holds a height or magnitude value for each point. this can be a numeric field or the Shape field if the input point features contains z-values. This is a required parameter.

Parameters:

zField - the field that holds a height or magnitude value for each point. this can be a numeric field or the Shape field if the input point features contains z-values.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output interpolated surface raster. 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 the output interpolated surface raster. This is a required parameter.

Parameters:

outRaster - the output interpolated surface raster.

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. Otherwise, it is the shorter of the width or the height of the extent of the input 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 the cell size at which the output raster will be created. 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 the input point features, in the input spatial reference, divided by 250. 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. Otherwise, it is the shorter of the width or the height of the extent of the input 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 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 the type of spline to be used. This is an optional parameter.

Parameters:

splineType - the type of spline to be used.

getWeight

public double getWeight()

Returns the Weight parameter of this tool . This parameter is parameter influencing the character of the surface interpolation. when the REGULARIZED option is used, it defines the weight of the third derivatives of the surface in the curvature minimization expression. If the TENSION option is used, it defines the weight of tension. 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 parameter influencing the character of the surface interpolation. when the REGULARIZED option is used, it defines the weight of the third derivatives of the surface in the curvature minimization expression. If the TENSION option is used, it defines the weight of tension. the default weight is 0.1. This is an optional parameter.

Parameters:

weight - parameter influencing the character of the surface interpolation. when the REGULARIZED option is used, it defines the weight of the third derivatives of the surface in the curvature minimization expression. If the TENSION option is used, it defines the weight of tension. the default weight is 0.1.

getNumberPoints

public int getNumberPoints()

Returns the Number of points parameter of this tool . This parameter is the number of points per region used for local approximation. 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 the number of points per region used for local approximation. the default is 12. This is an optional parameter.

Parameters:

numberPoints - the number of points per region used for local approximation. 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