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

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

All Implemented Interfaces:

GPTool

public class InterpolateShape
extends AbstractGPTool

This tool interpolates z-values for a feature class based on an underlying raster, triangulated irregular network (TIN), or terrain dataset surface. The Interpolate Shape tool is contained in the 3D Analyst Tools tool box.

Usage tips:

• When using the interpolation option, make sure to specify a reasonable sample distance. This usually falls between 0.5 and 1.0 times the average point spacing of the data used to build the TIN or terrain dataset.
• When using the vertex only option, input features with vertices that fall outside the data area of the surface will be ignored and not output. Clip features prior to running Interpolate Shape to ensure the features are completely on the surface.

Field Summary

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

vals

Constructor Summary

InterpolateShape()
Creates the Interpolate Shape tool with defaults.

InterpolateShape(Object inSurface, Object inFeatureClass, Object outFeatureClass)
Creates the Interpolate Shape tool with the required parameters.

Method Summary

Object	getInFeatureClass() Returns the Input Feature Class parameter of this tool .
Object	getInSurface() Returns the Input Surface parameter of this tool .
String	getMethod() Returns the Method parameter of this tool .
Object	getOutFeatureClass() Returns the Output Feature Class parameter of this tool .
double	getPyramidLevelResolution() Returns the Pyramid Level Resolution parameter of this tool .
double	getSampleDistance() Returns the Sampling Distance 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.
String	getVerticesOnly() Returns the Interpolate Vertices Only parameter of this tool .
double	getZFactor() Returns the Z Factor parameter of this tool .
void	setInFeatureClass(Object inFeatureClass) Sets the Input Feature Class parameter of this tool .
void	setInSurface(Object inSurface) Sets the Input Surface parameter of this tool .
void	setMethod(String method) Sets the Method parameter of this tool .
void	setOutFeatureClass(Object outFeatureClass) Sets the Output Feature Class parameter of this tool .
void	setPyramidLevelResolution(double pyramidLevelResolution) Sets the Pyramid Level Resolution parameter of this tool .
void	setSampleDistance(double sampleDistance) Sets the Sampling Distance parameter of this tool .
void	setVerticesOnly(String verticesOnly) Sets the Interpolate Vertices Only parameter of this tool .
void	setZFactor(double zFactor) Sets the Z Factor 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

InterpolateShape

public InterpolateShape()

Creates the Interpolate Shape tool with defaults.

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

InterpolateShape

public InterpolateShape(Object inSurface,
                        Object inFeatureClass,
                        Object outFeatureClass)

Creates the Interpolate Shape 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:

inSurface - the input raster, TIN, or terrain surface to be used as a source of z-values.

inFeatureClass - the input 2D feature class.

outFeatureClass - the output feature class.

Method Detail

getInSurface

public Object getInSurface()

Returns the Input Surface parameter of this tool . This parameter is the input raster, TIN, or terrain surface to be used as a source of z-values. This is a required parameter.

Returns:

the Input Surface

setInSurface

public void setInSurface(Object inSurface)

Sets the Input Surface parameter of this tool . This parameter is the input raster, TIN, or terrain surface to be used as a source of z-values. This is a required parameter.

Parameters:

inSurface - the input raster, TIN, or terrain surface to be used as a source of z-values.

getInFeatureClass

public Object getInFeatureClass()

Returns the Input Feature Class parameter of this tool . This parameter is the input 2D feature class. This is a required parameter.

Returns:

the Input Feature Class

setInFeatureClass

public void setInFeatureClass(Object inFeatureClass)

Sets the Input Feature Class parameter of this tool . This parameter is the input 2D feature class. This is a required parameter.

Parameters:

inFeatureClass - the input 2D feature class.

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is the output feature class. This is a required parameter.

Returns:

the Output Feature Class

setOutFeatureClass

public void setOutFeatureClass(Object outFeatureClass)

Sets the Output Feature Class parameter of this tool . This parameter is the output feature class. This is a required parameter.

Parameters:

outFeatureClass - the output feature class.

getSampleDistance

public double getSampleDistance()

Returns the Sampling Distance parameter of this tool . This parameter is the spacing at which z-values will be interpolated. By default, this is a raster's cell size or a TIN's natural densification. This is an optional parameter.

Returns:

the Sampling Distance

setSampleDistance

public void setSampleDistance(double sampleDistance)

Sets the Sampling Distance parameter of this tool . This parameter is the spacing at which z-values will be interpolated. By default, this is a raster's cell size or a TIN's natural densification. This is an optional parameter.

Parameters:

sampleDistance - the spacing at which z-values will be interpolated. By default, this is a raster's cell size or a TIN's natural densification.

getZFactor

public double getZFactor()

Returns the Z Factor parameter of this tool . This parameter is the factor by which the heights of the input surface will be multiplied to calculate new heights in the output feature class. It is used for converting z-units to match x,y units. This is an optional parameter.

Returns:

the Z Factor

setZFactor

public void setZFactor(double zFactor)

Sets the Z Factor parameter of this tool . This parameter is the factor by which the heights of the input surface will be multiplied to calculate new heights in the output feature class. It is used for converting z-units to match x,y units. This is an optional parameter.

Parameters:

zFactor - the factor by which the heights of the input surface will be multiplied to calculate new heights in the output feature class. It is used for converting z-units to match x,y units.

getMethod

public String getMethod()

Returns the Method parameter of this tool . This parameter is interpolation method used to define the Z values for the input features. This is an optional parameter.

Returns:

the Method

setMethod

public void setMethod(String method)

Sets the Method parameter of this tool . This parameter is interpolation method used to define the Z values for the input features. This is an optional parameter.

Parameters:

method - interpolation method used to define the Z values for the input features.

getVerticesOnly

public String getVerticesOnly()

Returns the Interpolate Vertices Only parameter of this tool . This parameter is the sample distance will be ignored and the interpolation will use the input vertex locations only. This is an optional parameter.

Returns:

the Interpolate Vertices Only

setVerticesOnly

public void setVerticesOnly(String verticesOnly)

Sets the Interpolate Vertices Only parameter of this tool . This parameter is the sample distance will be ignored and the interpolation will use the input vertex locations only. This is an optional parameter.

Parameters:

verticesOnly - the sample distance will be ignored and the interpolation will use the input vertex locations only.

getPyramidLevelResolution

public double getPyramidLevelResolution()

Returns the Pyramid Level Resolution parameter of this tool . This parameter is the resolution of the terrain dataset pyramid level to use for geoprocessing. The default is 0, full resolution. This is an optional parameter.

Returns:

the Pyramid Level Resolution

setPyramidLevelResolution

public void setPyramidLevelResolution(double pyramidLevelResolution)

Sets the Pyramid Level Resolution parameter of this tool . This parameter is the resolution of the terrain dataset pyramid level to use for geoprocessing. The default is 0, full resolution. This is an optional parameter.

Parameters:

pyramidLevelResolution - the resolution of the terrain dataset pyramid level to use for geoprocessing. The default is 0, full resolution.

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