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

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

public class GAMovingWindowKriging
extends AbstractGPTool

Recalculates the Range, Nugget, and Partial Sill semivariogram parameters based on a smaller neighborhood, moving through all location points. The Moving Window Kriging tool is contained in the Geostatistical Analyst Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
GAMovingWindowKriging()
          Creates the Moving Window Kriging tool with defaults.
GAMovingWindowKriging(Object inGaModelSource, Object inDatasets, Object inLocations, int neighborsMax, Object outFeatureclass)
          Creates the Moving Window Kriging tool with the required parameters.
 
Method Summary
 Object getCellSize()
          Returns the Output cell size parameter of this tool .
 Object getInDatasets()
          Returns the Input dataset(s) parameter of this tool .
 Object getInGaModelSource()
          Returns the Geostatistical model source parameter of this tool .
 Object getInLocations()
          Returns the Point observation locations parameter of this tool .
 int getNeighborsMax()
          Returns the Neighbors to include parameter of this tool .
 Object getOutFeatureclass()
          Returns the Output feature class parameter of this tool .
 Object getOutSurfaceGrid()
          Returns the Output surface raster 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.
 void setCellSize(Object cellSize)
          Sets the Output cell size parameter of this tool .
 void setInDatasets(Object inDatasets)
          Sets the Input dataset(s) parameter of this tool .
 void setInGaModelSource(Object inGaModelSource)
          Sets the Geostatistical model source parameter of this tool .
 void setInLocations(Object inLocations)
          Sets the Point observation locations parameter of this tool .
 void setNeighborsMax(int neighborsMax)
          Sets the Neighbors to include parameter of this tool .
 void setOutFeatureclass(Object outFeatureclass)
          Sets the Output feature class parameter of this tool .
 void setOutSurfaceGrid(Object outSurfaceGrid)
          Sets the Output surface raster 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

GAMovingWindowKriging

public GAMovingWindowKriging()
Creates the Moving Window Kriging tool with defaults.

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


GAMovingWindowKriging

public GAMovingWindowKriging(Object inGaModelSource,
                             Object inDatasets,
                             Object inLocations,
                             int neighborsMax,
                             Object outFeatureclass)
Creates the Moving Window Kriging 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:
inGaModelSource - the geostatistical model source to be analyzed.
inDatasets - input dataset(s) displays two pieces:
inLocations - point locations where predictions or validations will be performed.
neighborsMax - number of neighbors to use in the moving window.
outFeatureclass - feature class storing the results.
Method Detail

getInGaModelSource

public Object getInGaModelSource()
Returns the Geostatistical model source parameter of this tool . This parameter is the geostatistical model source to be analyzed. This is a required parameter.

Returns:
the Geostatistical model source

setInGaModelSource

public void setInGaModelSource(Object inGaModelSource)
Sets the Geostatistical model source parameter of this tool . This parameter is the geostatistical model source to be analyzed. This is a required parameter.

Parameters:
inGaModelSource - the geostatistical model source to be analyzed.

getInDatasets

public Object getInDatasets()
Returns the Input dataset(s) parameter of this tool . This parameter is input dataset(s) displays two pieces: This is a required parameter.

Returns:
the Input dataset(s)

setInDatasets

public void setInDatasets(Object inDatasets)
Sets the Input dataset(s) parameter of this tool . This parameter is input dataset(s) displays two pieces: This is a required parameter.

Parameters:
inDatasets - input dataset(s) displays two pieces:

getInLocations

public Object getInLocations()
Returns the Point observation locations parameter of this tool . This parameter is point locations where predictions or validations will be performed. This is a required parameter.

Returns:
the Point observation locations

setInLocations

public void setInLocations(Object inLocations)
Sets the Point observation locations parameter of this tool . This parameter is point locations where predictions or validations will be performed. This is a required parameter.

Parameters:
inLocations - point locations where predictions or validations will be performed.

getNeighborsMax

public int getNeighborsMax()
Returns the Neighbors to include parameter of this tool . This parameter is number of neighbors to use in the moving window. This is a required parameter.

Returns:
the Neighbors to include

setNeighborsMax

public void setNeighborsMax(int neighborsMax)
Sets the Neighbors to include parameter of this tool . This parameter is number of neighbors to use in the moving window. This is a required parameter.

Parameters:
neighborsMax - number of neighbors to use in the moving window.

getOutFeatureclass

public Object getOutFeatureclass()
Returns the Output feature class parameter of this tool . This parameter is feature class storing the results. 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 feature class storing the results. This is a required parameter.

Parameters:
outFeatureclass - feature class storing the results.

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.

getOutSurfaceGrid

public Object getOutSurfaceGrid()
Returns the Output surface raster parameter of this tool . This parameter is the Prediction values in the output feature class are interpolated onto a raster using the Local Polynomial Interpolation method. This is an optional parameter.

Returns:
the Output surface raster

setOutSurfaceGrid

public void setOutSurfaceGrid(Object outSurfaceGrid)
Sets the Output surface raster parameter of this tool . This parameter is the Prediction values in the output feature class are interpolated onto a raster using the Local Polynomial Interpolation method. This is an optional parameter.

Parameters:
outSurfaceGrid - the Prediction values in the output feature class are interpolated onto a raster using the Local Polynomial Interpolation method.

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