com.esri.arcgis.geoprocessing.tools.geostatisticalanalysttools
Class RadialBasisFunctions

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.geostatisticalanalysttools.RadialBasisFunctions

All Implemented Interfaces:

GPTool

public class RadialBasisFunctions
extends AbstractGPTool

The Radial Basis Functions tool is contained in the Geostatistical Analyst Tools tool box.

Usage tips:

• The smooth search neighborhood is only available for the Inverse multiquadric function.
• For all methods except the Inverse multiquadric function, the higher the parameter value, the smoother the surface. The opposite is true for the Inverse multiquadric function.

Field Summary

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

vals

Constructor Summary

RadialBasisFunctions()
Creates the Radial Basis Functions tool with defaults.

RadialBasisFunctions(Object inFeatures, Object zField)
Creates the Radial Basis Functions tool with the required parameters.

Method Summary

Object	getCellSize() Returns the Output cell size parameter of this tool .
Object	getInFeatures() Returns the Input feature class parameter of this tool .
Object	getOutLayer() Returns the Output geostatistical layer parameter of this tool .
Object	getOutRaster() Returns the Output raster parameter of this tool .
String	getRadialBasisFunctions() Returns the Radial basis function parameter of this tool .
Object	getSearchNeighborhood() Returns the Search neighborhood parameter of this tool .
double	getSmallScaleParameter() Returns the Small scale parameter 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	getZField() Returns the Z value field parameter of this tool .
void	setCellSize(Object cellSize) Sets the Output cell size parameter of this tool .
void	setInFeatures(Object inFeatures) Sets the Input feature class parameter of this tool .
void	setOutLayer(Object outLayer) Sets the Output geostatistical layer parameter of this tool .
void	setOutRaster(Object outRaster) Sets the Output raster parameter of this tool .
void	setRadialBasisFunctions(String radialBasisFunctions) Sets the Radial basis function parameter of this tool .
void	setSearchNeighborhood(Object searchNeighborhood) Sets the Search neighborhood parameter of this tool .
void	setSmallScaleParameter(double smallScaleParameter) Sets the Small scale parameter 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

RadialBasisFunctions

public RadialBasisFunctions()

Creates the Radial Basis Functions tool with defaults.

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

RadialBasisFunctions

public RadialBasisFunctions(Object inFeatures,
                            Object zField)

Creates the Radial Basis Functions 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:

inFeatures - the input features containing the z-values to be interpolated.

zField - null

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input feature class parameter of this tool . This parameter is the input features containing the z-values to be interpolated. This is a required parameter.

Returns:

the Input feature class

setInFeatures

public void setInFeatures(Object inFeatures)

Sets the Input feature class parameter of this tool . This parameter is the input features containing the z-values to be interpolated. This is a required parameter.

Parameters:

inFeatures - the input features containing the z-values to be interpolated.

getZField

public Object getZField()

Returns the Z value field parameter of this tool . 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 is a required parameter.

Parameters:

zField - null

getOutLayer

public Object getOutLayer()

Returns the Output geostatistical layer parameter of this tool . This parameter is the geostatistical layer produced. This layer is required output only if no output raster is requested. This is an optional parameter.

Returns:

the Output geostatistical layer

setOutLayer

public void setOutLayer(Object outLayer)

Sets the Output geostatistical layer parameter of this tool . This parameter is the geostatistical layer produced. This layer is required output only if no output raster is requested. This is an optional parameter.

Parameters:

outLayer - the geostatistical layer produced. This layer is required output only if no output raster is requested.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output raster. This raster is required output only if no output geostatistical layer is requested. This is an optional parameter.

Returns:

the Output raster

setOutRaster

public void setOutRaster(Object outRaster)

Sets the Output raster parameter of this tool . This parameter is the output raster. This raster is required output only if no output geostatistical layer is requested. This is an optional parameter.

Parameters:

outRaster - the output raster. This raster is required output only if no output geostatistical layer is requested.

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 value can be explicitly set under Raster Analysis from the Environment Settings. If not set, 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. the cell size at which the output raster will be created. this value can be explicitly set under Raster Analysis from the Environment Settings. If not set, 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 value can be explicitly set under Raster Analysis from the Environment Settings. If not set, 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. the cell size at which the output raster will be created. this value can be explicitly set under Raster Analysis from the Environment Settings. If not set, 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 value can be explicitly set under Raster Analysis from the Environment Settings. If not set, 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. the cell size at which the output raster will be created. this value can be explicitly set under Raster Analysis from the Environment Settings. If not set, 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.

getSearchNeighborhood

public Object getSearchNeighborhood()

Returns the Search neighborhood parameter of this tool . This parameter is defines which surrounding points will be used to control the output. There are two options: STANDARD and SMOOTH. Standard is the default. this is a Search Neighborhood class ( SearchNeighborhoodStandard and SearchNeighborhoodSmooth). sTANDARD sMOOTH This is an optional parameter.

Returns:

the Search neighborhood

setSearchNeighborhood

public void setSearchNeighborhood(Object searchNeighborhood)

Sets the Search neighborhood parameter of this tool . This parameter is defines which surrounding points will be used to control the output. There are two options: STANDARD and SMOOTH. Standard is the default. this is a Search Neighborhood class ( SearchNeighborhoodStandard and SearchNeighborhoodSmooth). sTANDARD sMOOTH This is an optional parameter.

Parameters:

searchNeighborhood - defines which surrounding points will be used to control the output. There are two options: STANDARD and SMOOTH. Standard is the default. this is a Search Neighborhood class ( SearchNeighborhoodStandard and SearchNeighborhoodSmooth). sTANDARD sMOOTH

getRadialBasisFunctions

public String getRadialBasisFunctions()

Returns the Radial basis function parameter of this tool . This parameter is available Radial basis functions. This is an optional parameter.

Returns:

the Radial basis function

setRadialBasisFunctions

public void setRadialBasisFunctions(String radialBasisFunctions)

Sets the Radial basis function parameter of this tool . This parameter is available Radial basis functions. This is an optional parameter.

Parameters:

radialBasisFunctions - available Radial basis functions.

getSmallScaleParameter

public double getSmallScaleParameter()

Returns the Small scale parameter parameter of this tool . This parameter is used to calculate the weights assigned to the points located in the moving window. Each of the radial basis functions has a parameter that controls the degree of small-scale variation of the surface. The (“optimal”) parameter is determined by finding the value that minimizes the root mean square prediction error (RMSPE). This is an optional parameter.

Returns:

the Small scale parameter

setSmallScaleParameter

public void setSmallScaleParameter(double smallScaleParameter)

Sets the Small scale parameter parameter of this tool . This parameter is used to calculate the weights assigned to the points located in the moving window. Each of the radial basis functions has a parameter that controls the degree of small-scale variation of the surface. The (“optimal”) parameter is determined by finding the value that minimizes the root mean square prediction error (RMSPE). This is an optional parameter.

Parameters:

smallScaleParameter - used to calculate the weights assigned to the points located in the moving window. Each of the radial basis functions has a parameter that controls the degree of small-scale variation of the surface. The (“optimal”) parameter is determined by finding the value that minimizes the root mean square prediction error (RMSPE).

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