|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.geoprocessing.AbstractGPTool com.esri.arcgis.geoprocessing.tools.geostatisticalanalysttools.GaussianGeostatisticalSimulations
public class GaussianGeostatisticalSimulations
Performs a 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.
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 |
getConditioningMeasurementErrorField()
Returns the Conditioning measurement error 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 |
setConditioningMeasurementErrorField(Object conditioningMeasurementErrorField)
Sets the Conditioning measurement error 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 |
---|
public GaussianGeostatisticalSimulations()
Initializes the array of tool parameters with the default values specified when the tool was created.
public GaussianGeostatisticalSimulations(Object inGeostatLayer, int numberOfRealizations, Object outputWorkspace, String outputSimulationPrefix)
Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.
inGeostatLayer
- input a geostatistical layer resulting from a Simple Kriging model.numberOfRealizations
- the number of simulations to perform.outputWorkspace
- stores all the simulation results.outputSimulationPrefix
- a 1- to 3-character alphanumeric prefix that is automatically added to the output dataset names.Method Detail |
---|
public Object getInGeostatLayer()
public void setInGeostatLayer(Object inGeostatLayer)
inGeostatLayer
- input a geostatistical layer resulting from a Simple Kriging model.public int getNumberOfRealizations()
public void setNumberOfRealizations(int numberOfRealizations)
numberOfRealizations
- the number of simulations to perform.public Object getOutputWorkspace()
public void setOutputWorkspace(Object outputWorkspace)
outputWorkspace
- stores all the simulation results.public String getOutputSimulationPrefix()
public void setOutputSimulationPrefix(String outputSimulationPrefix)
outputSimulationPrefix
- a 1- to 3-character alphanumeric prefix that is automatically added to the output dataset names.public Object getInConditioningFeatures()
public void setInConditioningFeatures(Object inConditioningFeatures)
inConditioningFeatures
- the features used to condition the realizations. If left blank, unconditional realizations are produced.public Object getConditioningField()
public void setConditioningField(Object conditioningField)
conditioningField
- the field used to condition the realizations. If left blank, unconditional realizations are produced.public Object getCellSize()
public void setCellSize(Object cellSize)
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.public Object getInBoundingDataset()
public void setInBoundingDataset(Object inBoundingDataset)
inBoundingDataset
- limits the analysis to these features' bounding polygon. If point features are entered, then a convex hull polygon is automatically created. Realizations are then performed within that polygon.public String getSaveSimulatedRasters()
public void setSaveSimulatedRasters(String saveSimulatedRasters)
saveSimulatedRasters
- determines whether the simulated rasters are saved to disk or not.public double getQuantile()
- Returns:
- the Quantile (0
setQuantile
public void setQuantile(double quantile)
- Sets the Quantile (0
- Parameters:
quantile
- the quantile value for which the output raster will be generated.
getThreshold
public double getThreshold()
- Returns the Threshold parameter of this tool . This parameter is the threshold value for which the output raster will be generated, as the percentage of the number of times the set threshold was exceeded, on a cell by cell basis. This is an optional parameter.
- Returns:
- the Threshold
setThreshold
public void setThreshold(double threshold)
- Sets the Threshold parameter of this tool . This parameter is the threshold value for which the output raster will be generated, as the percentage of the number of times the set threshold was exceeded, on a cell by cell basis. This is an optional parameter.
- Parameters:
threshold
- the threshold value for which the output raster will be generated, as the percentage of the number of times the set threshold was exceeded, on a cell by cell basis.
getInStatsPolygons
public Object getInStatsPolygons()
- Returns the Input statistical polygons parameter of this tool . This parameter is these polygons represent areas of interest for which summary statistics are 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 these polygons represent areas of interest for which summary statistics are calculated. This is an optional parameter.
- Parameters:
inStatsPolygons
- these polygons represent areas of interest for which summary statistics are calculated.
getRasterStatType
public Object getRasterStatType()
- Returns the Raster statistics type parameter of this tool . This parameter is the simulated rasters are post-processed on a cell by cell basis and each selected statistics type is 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 the simulated rasters are post-processed on a cell by cell basis and each selected statistics type is calculated and reported in an output raster. This is an optional parameter.
- Parameters:
rasterStatType
- the simulated rasters are post-processed on a cell by cell basis and each selected statistics type is calculated and reported in an output raster.
getConditioningMeasurementErrorField
public Object getConditioningMeasurementErrorField()
- Returns the Conditioning measurement error field parameter of this tool . This parameter is specifies a constant measurement error for all input data in the input semivariogram model. Use this field if the measurement error values are not the same at each sampling location. The input's unit of measurement is applied. leave this blank if there are no measurement error values. This is an optional parameter.
- Returns:
- the Conditioning measurement error field
setConditioningMeasurementErrorField
public void setConditioningMeasurementErrorField(Object conditioningMeasurementErrorField)
- Sets the Conditioning measurement error field parameter of this tool . This parameter is specifies a constant measurement error for all input data in the input semivariogram model. Use this field if the measurement error values are not the same at each sampling location. The input's unit of measurement is applied. leave this blank if there are no measurement error values. This is an optional parameter.
- Parameters:
conditioningMeasurementErrorField
- specifies a constant measurement error for all input data in the input semivariogram model. Use this field if the measurement error values are not the same at each sampling location. The input's unit of measurement is applied. leave this blank if there are no measurement error values.
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
Overview Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD