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

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

All Implemented Interfaces:

GPTool

public class LocalPolynomialInterpolation
extends AbstractGPTool

Fits the specified order (zero, first, second, third, and so on) polynomial, each within specified overlapping neighborhoods, to produce an output surface. The Local Polynomial Interpolation tool is contained in the Geostatistical Analyst Tools tool box.

Usage tips:

• Usewhen your dataset exhibits short-range variation.
• is useful for creating smooth surfaces and identifying long-range trends in the dataset. However, in earth sciences the variable of interest usually has short-range variation in addition to long-range trend. When the dataset exhibits short-range variation, Local Polynomial Interpolation maps can capture the short-range variation.

Field Summary

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

vals

Constructor Summary

LocalPolynomialInterpolation()
Creates the Local Polynomial Interpolation tool with defaults.

LocalPolynomialInterpolation(Object inFeatures, Object zField)
Creates the Local Polynomial Interpolation tool with the required parameters.

Method Summary

double	getBandwidth() Returns the Bandwidth parameter of this tool .
Object	getCellSize() Returns the Output cell size parameter of this tool .
double	getConditionNumber() Returns the Spatial condition number threshold parameter of this tool .
Object	getInFeatures() Returns the Input feature class parameter of this tool .
String	getKernelFunction() Returns the Kernel function parameter of this tool .
Object	getOutLayer() Returns the Output geostatistical layer parameter of this tool .
String	getOutputType() Returns the Output surface type parameter of this tool .
Object	getOutRaster() Returns the Output raster parameter of this tool .
int	getPower() Returns the Order of polynomial parameter of this tool .
Object	getSearchNeighborhood() Returns the Search neighborhood 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	getUseConditionNumber() Returns the Use spatial condition number threshold parameter of this tool .
Object	getWeightField() Returns the Weight field parameter of this tool .
Object	getZField() Returns the Z value field parameter of this tool .
void	setBandwidth(double bandwidth) Sets the Bandwidth parameter of this tool .
void	setCellSize(Object cellSize) Sets the Output cell size parameter of this tool .
void	setConditionNumber(double conditionNumber) Sets the Spatial condition number threshold parameter of this tool .
void	setInFeatures(Object inFeatures) Sets the Input feature class parameter of this tool .
void	setKernelFunction(String kernelFunction) Sets the Kernel function parameter of this tool .
void	setOutLayer(Object outLayer) Sets the Output geostatistical layer parameter of this tool .
void	setOutputType(String outputType) Sets the Output surface type parameter of this tool .
void	setOutRaster(Object outRaster) Sets the Output raster parameter of this tool .
void	setPower(int power) Sets the Order of polynomial parameter of this tool .
void	setSearchNeighborhood(Object searchNeighborhood) Sets the Search neighborhood parameter of this tool .
void	setUseConditionNumber(String useConditionNumber) Sets the Use spatial condition number threshold parameter of this tool .
void	setWeightField(Object weightField) Sets the Weight field 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

LocalPolynomialInterpolation

public LocalPolynomialInterpolation()

Creates the Local Polynomial Interpolation tool with defaults.

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

LocalPolynomialInterpolation

public LocalPolynomialInterpolation(Object inFeatures,
                                    Object zField)

Creates the Local Polynomial Interpolation 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 point features containing the z-values to be interpolated.

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

Method Detail

getInFeatures

public Object getInFeatures()

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

Parameters:

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

getZField

public Object getZField()

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

Parameters:

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

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. 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. 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.

getPower

public int getPower()

Returns the Order of polynomial parameter of this tool . This parameter is the order of the polynomial (constant, 1st, 2nd, or 3rd). This is an optional parameter.

Returns:

the Order of polynomial

setPower

public void setPower(int power)

Sets the Order of polynomial parameter of this tool . This parameter is the order of the polynomial (constant, 1st, 2nd, or 3rd). This is an optional parameter.

Parameters:

power - the order of the polynomial (constant, 1st, 2nd, or 3rd).

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

getKernelFunction

public String getKernelFunction()

Returns the Kernel function parameter of this tool . This parameter is the kernel function used in the simulation. This is an optional parameter.

Returns:

the Kernel function

setKernelFunction

public void setKernelFunction(String kernelFunction)

Sets the Kernel function parameter of this tool . This parameter is the kernel function used in the simulation. This is an optional parameter.

Parameters:

kernelFunction - the kernel function used in the simulation.

getBandwidth

public double getBandwidth()

Returns the Bandwidth parameter of this tool . This parameter is used to specify the maximum distance at which data points are used for prediction. With increasing bandwidth, prediction bias increases and prediction variance decreases. This is an optional parameter.

Returns:

the Bandwidth

setBandwidth

public void setBandwidth(double bandwidth)

Sets the Bandwidth parameter of this tool . This parameter is used to specify the maximum distance at which data points are used for prediction. With increasing bandwidth, prediction bias increases and prediction variance decreases. This is an optional parameter.

Parameters:

bandwidth - used to specify the maximum distance at which data points are used for prediction. With increasing bandwidth, prediction bias increases and prediction variance decreases.

getUseConditionNumber

public String getUseConditionNumber()

Returns the Use spatial condition number threshold parameter of this tool . This parameter is option to control the creation of prediction and prediction standard errors where the predictions are unstable. This option is only available for polynomials of order 1, 2 and 3. This is an optional parameter.

Returns:

the Use spatial condition number threshold

setUseConditionNumber

public void setUseConditionNumber(String useConditionNumber)

Sets the Use spatial condition number threshold parameter of this tool . This parameter is option to control the creation of prediction and prediction standard errors where the predictions are unstable. This option is only available for polynomials of order 1, 2 and 3. This is an optional parameter.

Parameters:

useConditionNumber - option to control the creation of prediction and prediction standard errors where the predictions are unstable. This option is only available for polynomials of order 1, 2 and 3.

getConditionNumber

public double getConditionNumber()

Returns the Spatial condition number threshold parameter of this tool . This parameter is every invertible square matrix has a condition number that indicates how inaccurate the solution to the linear equations can be with a small change in the matrix coefficients (it can be due to imprecise data) . If the condition number is large, a small change in the matrix coefficients results in a large change in the solution vector. This is an optional parameter.

Returns:

the Spatial condition number threshold

setConditionNumber

public void setConditionNumber(double conditionNumber)

Sets the Spatial condition number threshold parameter of this tool . This parameter is every invertible square matrix has a condition number that indicates how inaccurate the solution to the linear equations can be with a small change in the matrix coefficients (it can be due to imprecise data) . If the condition number is large, a small change in the matrix coefficients results in a large change in the solution vector. This is an optional parameter.

Parameters:

conditionNumber - every invertible square matrix has a condition number that indicates how inaccurate the solution to the linear equations can be with a small change in the matrix coefficients (it can be due to imprecise data) . If the condition number is large, a small change in the matrix coefficients results in a large change in the solution vector.

getWeightField

public Object getWeightField()

Returns the Weight field parameter of this tool . This parameter is used to emphasize an observation. The larger the weight, the more impact it has on the prediction. For coincident observations, assign the largest weight to the most reliable measurement. This is an optional parameter.

Returns:

the Weight field

setWeightField

public void setWeightField(Object weightField)

Sets the Weight field parameter of this tool . This parameter is used to emphasize an observation. The larger the weight, the more impact it has on the prediction. For coincident observations, assign the largest weight to the most reliable measurement. This is an optional parameter.

Parameters:

weightField - used to emphasize an observation. The larger the weight, the more impact it has on the prediction. For coincident observations, assign the largest weight to the most reliable measurement.

getOutputType

public String getOutputType()

Returns the Output surface type parameter of this tool . This parameter is surface type to store the interpolation results. This is an optional parameter.

Returns:

the Output surface type

setOutputType

public void setOutputType(String outputType)

Sets the Output surface type parameter of this tool . This parameter is surface type to store the interpolation results. This is an optional parameter.

Parameters:

outputType - surface type to store the interpolation results.

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