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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.spatialanalysttools.SplineWithBarriers
All Implemented Interfaces:
GPTool

public class SplineWithBarriers
extends AbstractGPTool

Interpolates a raster 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 Spatial Analyst Tools tool box.

Usage tips:


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 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 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 - the input point features containing the z-values to be interpolated into a surface raster.
zValueField - null
outputRaster - the output interpolated surface raster.
Method Detail

getInputPointFeatures

public Object getInputPointFeatures()
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

setInputPointFeatures

public void setInputPointFeatures(Object inputPointFeatures)
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:
inputPointFeatures - the input point features containing the z-values to be interpolated into a surface raster.

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 the cell size at which the output raster will be created. 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 an optional parameter.

Returns:
the Output cell size

setOutputCellSize

public void setOutputCellSize(Object outputCellSize)
Sets the Output cell size parameter of this tool . This parameter is the cell size at which the output raster will be created. 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 an optional parameter.

Parameters:
outputCellSize - the cell size at which the output raster will be created. 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 the output interpolated surface raster. 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 the output interpolated surface raster. This is a required parameter.

Parameters:
outputRaster - the output interpolated surface raster.

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