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

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

public class GaussianGeostatisticalSimulations
extends AbstractGPTool

This tool performs conditional or unconditional geostatistical simulation based on a Simple Kriging model. The Gaussian Geostatistical Simulations tool is contained in the Geostatistical Analyst Tools tool box.
Learn more about Gaussian Geostatistical Simulations

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
GaussianGeostatisticalSimulations()
          Creates the Gaussian Geostatistical Simulations tool with defaults.
GaussianGeostatisticalSimulations(Object inGeostatLayer, int numberOfRealizations, Object outputWorkspace, String outputSimulationPrefix)
          Creates the Gaussian Geostatistical Simulations tool with the required parameters.
 
Method Summary
 Object getCellSize()
          Returns the Output cell size parameter of this tool .
 Object getConditioningField()
          Returns the Conditioning field parameter of this tool .
 Object getInBoundingDataset()
          Returns the Bounding feature class parameter of this tool .
 Object getInConditioningFeatures()
          Returns the Conditioning dataset parameter of this tool .
 Object getInGeostatLayer()
          Returns the Input geostatistical layer parameter of this tool .
 Object getInStatsPolygons()
          Returns the Input statistical polygons parameter of this tool .
 int getNumberOfRealizations()
          Returns the Number of realizations parameter of this tool .
 double getOutConvergenceValue()
          Returns the Convergence parameter of this tool (Read only).
 Object getOutPolygonStat()
          Returns the Output statistical polygons parameter of this tool (Read only).
 String getOutputSimulationPrefix()
          Returns the Output simulation prefix parameter of this tool .
 Object getOutputWorkspace()
          Returns the Output workspace parameter of this tool .
 Object getOutRasterSimulation()
          Returns the Output simulation rasters parameter of this tool (Read only).
 Object getOutRasterStat()
          Returns the Output statistical rasters parameter of this tool (Read only).
 Object getOutWorkspace()
          Returns the Output workspace parameter of this tool (Read only).
 double getQuantile()
          Returns the Quantile (0
 Object getRasterStatType()
          Returns the Raster statistics type parameter of this tool .
 String getSaveSimulatedRasters()
          Returns the Save simulated rasters parameter of this tool .
 double getThreshold()
          Returns the Threshold 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 setConditioningField(Object conditioningField)
          Sets the Conditioning field parameter of this tool .
 void setInBoundingDataset(Object inBoundingDataset)
          Sets the Bounding feature class parameter of this tool .
 void setInConditioningFeatures(Object inConditioningFeatures)
          Sets the Conditioning dataset parameter of this tool .
 void setInGeostatLayer(Object inGeostatLayer)
          Sets the Input geostatistical layer parameter of this tool .
 void setInStatsPolygons(Object inStatsPolygons)
          Sets the Input statistical polygons parameter of this tool .
 void setNumberOfRealizations(int numberOfRealizations)
          Sets the Number of realizations parameter of this tool .
 void setOutputSimulationPrefix(String outputSimulationPrefix)
          Sets the Output simulation prefix parameter of this tool .
 void setOutputWorkspace(Object outputWorkspace)
          Sets the Output workspace parameter of this tool .
 void setQuantile(double quantile)
          Sets the Quantile (0
 void setRasterStatType(Object rasterStatType)
          Sets the Raster statistics type parameter of this tool .
 void setSaveSimulatedRasters(String saveSimulatedRasters)
          Sets the Save simulated rasters parameter of this tool .
 void setThreshold(double threshold)
          Sets the Threshold 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

GaussianGeostatisticalSimulations

public GaussianGeostatisticalSimulations()
Creates the Gaussian Geostatistical Simulations tool with defaults.

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


GaussianGeostatisticalSimulations

public GaussianGeostatisticalSimulations(Object inGeostatLayer,
                                         int numberOfRealizations,
                                         Object outputWorkspace,
                                         String outputSimulationPrefix)
Creates the Gaussian Geostatistical Simulations 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:
inGeostatLayer - Geostatistical Layer, input a geostatistical layer resulting from a Simple Kriging model.
numberOfRealizations - Long, the number of realizations to perform.
outputWorkspace - Workspace, the workspace for all the output results.
outputSimulationPrefix - String, 1- to 3-character alphanumeric prefix that will automatically be added to the output dataset names.
Method Detail

getInGeostatLayer

public Object getInGeostatLayer()
Returns the Input geostatistical layer parameter of this tool . This parameter is Geostatistical Layer, input a geostatistical layer resulting from a Simple Kriging model. This is a required parameter.

Returns:
the Input geostatistical layer

setInGeostatLayer

public void setInGeostatLayer(Object inGeostatLayer)
Sets the Input geostatistical layer parameter of this tool . This parameter is Geostatistical Layer, input a geostatistical layer resulting from a Simple Kriging model. This is a required parameter.

Parameters:
inGeostatLayer - Geostatistical Layer, input a geostatistical layer resulting from a Simple Kriging model.

getNumberOfRealizations

public int getNumberOfRealizations()
Returns the Number of realizations parameter of this tool . This parameter is Long, the number of realizations to perform. This is a required parameter.

Returns:
the Number of realizations

setNumberOfRealizations

public void setNumberOfRealizations(int numberOfRealizations)
Sets the Number of realizations parameter of this tool . This parameter is Long, the number of realizations to perform. This is a required parameter.

Parameters:
numberOfRealizations - Long, the number of realizations to perform.

getOutputWorkspace

public Object getOutputWorkspace()
Returns the Output workspace parameter of this tool . This parameter is Workspace, the workspace for all the output results. This is a required parameter.

Returns:
the Output workspace

setOutputWorkspace

public void setOutputWorkspace(Object outputWorkspace)
Sets the Output workspace parameter of this tool . This parameter is Workspace, the workspace for all the output results. This is a required parameter.

Parameters:
outputWorkspace - Workspace, the workspace for all the output results.

getOutputSimulationPrefix

public String getOutputSimulationPrefix()
Returns the Output simulation prefix parameter of this tool . This parameter is String, 1- to 3-character alphanumeric prefix that will automatically be added to the output dataset names. This is a required parameter.

Returns:
the Output simulation prefix

setOutputSimulationPrefix

public void setOutputSimulationPrefix(String outputSimulationPrefix)
Sets the Output simulation prefix parameter of this tool . This parameter is String, 1- to 3-character alphanumeric prefix that will automatically be added to the output dataset names. This is a required parameter.

Parameters:
outputSimulationPrefix - String, 1- to 3-character alphanumeric prefix that will automatically be added to the output dataset names.

getInConditioningFeatures

public Object getInConditioningFeatures()
Returns the Conditioning dataset parameter of this tool . This parameter is Feature Layer, the features that are used to condition the realizations. Leave this blank to produce unconditional realizations. This is an optional parameter.

Returns:
the Conditioning dataset

setInConditioningFeatures

public void setInConditioningFeatures(Object inConditioningFeatures)
Sets the Conditioning dataset parameter of this tool . This parameter is Feature Layer, the features that are used to condition the realizations. Leave this blank to produce unconditional realizations. This is an optional parameter.

Parameters:
inConditioningFeatures - Feature Layer, the features that are used to condition the realizations. Leave this blank to produce unconditional realizations.

getConditioningField

public Object getConditioningField()
Returns the Conditioning field parameter of this tool . This parameter is Field, the field used to condition the realizations. Leave this blank to produce unconditional realizations. This is an optional parameter.

Returns:
the Conditioning field

setConditioningField

public void setConditioningField(Object conditioningField)
Sets the Conditioning field parameter of this tool . This parameter is Field, the field used to condition the realizations. Leave this blank to produce unconditional realizations. This is an optional parameter.

Parameters:
conditioningField - Field, the field used to condition the realizations. Leave this blank to produce unconditional realizations.

getCellSize

public Object getCellSize()
Returns the Output cell size parameter of this tool . This parameter is Analysis cell size, this will default to the value set in the environment settings (if it has been specified). Otherwise, the default is the shorter of the width or the height of the extent of the input point features 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 Analysis cell size, this will default to the value set in the environment settings (if it has been specified). Otherwise, the default is the shorter of the width or the height of the extent of the input point features divided by 250. This is an optional parameter.

Parameters:
cellSize - Analysis cell size, this will default to the value set in the environment settings (if it has been specified). Otherwise, the default is the shorter of the width or the height of the extent of the input point features divided by 250.

getInBoundingDataset

public Object getInBoundingDataset()
Returns the Bounding feature class parameter of this tool . This parameter is Feature Layer, the feature outline to which the analysis is to be limited. If point features are entered, then a convex hull polygon will be created automatically and the realizations will be performed within that polygon. This is an optional parameter.

Returns:
the Bounding feature class

setInBoundingDataset

public void setInBoundingDataset(Object inBoundingDataset)
Sets the Bounding feature class parameter of this tool . This parameter is Feature Layer, the feature outline to which the analysis is to be limited. If point features are entered, then a convex hull polygon will be created automatically and the realizations will be performed within that polygon. This is an optional parameter.

Parameters:
inBoundingDataset - Feature Layer, the feature outline to which the analysis is to be limited. If point features are entered, then a convex hull polygon will be created automatically and the realizations will be performed within that polygon.

getSaveSimulatedRasters

public String getSaveSimulatedRasters()
Returns the Save simulated rasters parameter of this tool . This parameter is String, the option of whether the simulated rasters be persisted (saved to disk). This is an optional parameter.

Returns:
the Save simulated rasters

setSaveSimulatedRasters

public void setSaveSimulatedRasters(String saveSimulatedRasters)
Sets the Save simulated rasters parameter of this tool . This parameter is String, the option of whether the simulated rasters be persisted (saved to disk). This is an optional parameter.

Parameters:
saveSimulatedRasters - String, the option of whether the simulated rasters be persisted (saved to disk).

getQuantile

public double getQuantile()
Returns the Quantile (0
Returns:
the Quantile (0

setQuantile

public void setQuantile(double quantile)
Sets the Quantile (0
Parameters:
quantile - Double, the quantile value (0 < Q < 1) for which the output raster will be generated.

getThreshold

public double getThreshold()
Returns the Threshold parameter of this tool . This parameter is Double, the threshold value for which the output raster will be generated. This is an optional parameter.

Returns:
the Threshold

setThreshold

public void setThreshold(double threshold)
Sets the Threshold parameter of this tool . This parameter is Double, the threshold value for which the output raster will be generated. This is an optional parameter.

Parameters:
threshold - Double, the threshold value for which the output raster will be generated.

getInStatsPolygons

public Object getInStatsPolygons()
Returns the Input statistical polygons parameter of this tool . This parameter is Feature Layer, input polygons representing areas of interest for the summary statistics to be calculated. This is an optional parameter.

Returns:
the Input statistical polygons

setInStatsPolygons

public void setInStatsPolygons(Object inStatsPolygons)
Sets the Input statistical polygons parameter of this tool . This parameter is Feature Layer, input polygons representing areas of interest for the summary statistics to be calculated. This is an optional parameter.

Parameters:
inStatsPolygons - Feature Layer, input polygons representing areas of interest for the summary statistics to be calculated.

getRasterStatType

public Object getRasterStatType()
Returns the Raster statistics type parameter of this tool . This parameter is Multiple Value, the simulated rasters are post-processed on a cell by cell basis. Each of the selected statistics will be calculated and reported in an output raster. This is an optional parameter.

Returns:
the Raster statistics type

setRasterStatType

public void setRasterStatType(Object rasterStatType)
Sets the Raster statistics type parameter of this tool . This parameter is Multiple Value, the simulated rasters are post-processed on a cell by cell basis. Each of the selected statistics will be calculated and reported in an output raster. This is an optional parameter.

Parameters:
rasterStatType - Multiple Value, the simulated rasters are post-processed on a cell by cell basis. Each of the selected statistics will be calculated and reported in an output raster.

getOutWorkspace

public Object getOutWorkspace()
Returns the Output workspace parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output workspace

getOutPolygonStat

public Object getOutPolygonStat()
Returns the Output statistical polygons parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output statistical polygons

getOutRasterSimulation

public Object getOutRasterSimulation()
Returns the Output simulation rasters parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output simulation rasters

getOutRasterStat

public Object getOutRasterStat()
Returns the Output statistical rasters parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output statistical rasters

getOutConvergenceValue

public double getOutConvergenceValue()
Returns the Convergence parameter of this tool (Read only). This is an derived parameter.

Returns:
the Convergence

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