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

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

All Implemented Interfaces:

GPTool

public class GASemivariogramSensitivity
extends AbstractGPTool

Performs a sensitivity analysis with varying Nugget, Partial Sill, and Range values. The Semivariogram Sensitivity tool is contained in the Geostatistical Analyst Tools tool box.

Usage tips:

• The geostatistical model source is either a geostatistical layer or a geostatistical model (XML).
• Set the environment variable equal to a nonzero value if the random sequence should be repeatable.
• For data formats that support Null values, such as file and personal geodatabase feature classes, a Null value will be used to indicate that a prediction could not be made for that location or that the value showed be ignored when used as input. For data formats that do not support Null values, such as shapefiles, the value of -1.7976931348623158e+308 is used (this is the negative of the C++ defined constant DBL_MAX) to indicate that a prediction could not be made for that location.

Field Summary

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

vals

Constructor Summary

GASemivariogramSensitivity()
Creates the Semivariogram Sensitivity tool with defaults.

GASemivariogramSensitivity(Object inGaModelSource, Object inDatasets, Object inLocations, Object outTable)
Creates the Semivariogram Sensitivity tool with the required parameters.

Method Summary

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	getMinrangeCalcTimes() Returns the Number of calculations for Minor Range parameter of this tool .
double	getMinrangeSpanPercents() Returns the Minor Range span (% of model value) parameter of this tool .
int	getNuggetCalcTimes() Returns the Number of calculations for Nugget parameter of this tool .
double	getNuggetSpanPercents() Returns the Nugget span (% of model value) parameter of this tool .
Object	getOutTable() Returns the Output table parameter of this tool .
int	getPartialsillCalcTimes() Returns the Number of calculations for Partial Sill parameter of this tool .
double	getPartialsillSpanPercents() Returns the Partial Sill span (% of model value) parameter of this tool .
int	getRangeCalcTimes() Returns the Number of calculations for Major Range parameter of this tool .
double	getRangeSpanPercents() Returns the Major Range span (% of model value) 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	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	setMinrangeCalcTimes(int minrangeCalcTimes) Sets the Number of calculations for Minor Range parameter of this tool .
void	setMinrangeSpanPercents(double minrangeSpanPercents) Sets the Minor Range span (% of model value) parameter of this tool .
void	setNuggetCalcTimes(int nuggetCalcTimes) Sets the Number of calculations for Nugget parameter of this tool .
void	setNuggetSpanPercents(double nuggetSpanPercents) Sets the Nugget span (% of model value) parameter of this tool .
void	setOutTable(Object outTable) Sets the Output table parameter of this tool .
void	setPartialsillCalcTimes(int partialsillCalcTimes) Sets the Number of calculations for Partial Sill parameter of this tool .
void	setPartialsillSpanPercents(double partialsillSpanPercents) Sets the Partial Sill span (% of model value) parameter of this tool .
void	setRangeCalcTimes(int rangeCalcTimes) Sets the Number of calculations for Major Range parameter of this tool .
void	setRangeSpanPercents(double rangeSpanPercents) Sets the Major Range span (% of model value) 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

GASemivariogramSensitivity

public GASemivariogramSensitivity()

Creates the Semivariogram Sensitivity tool with defaults.

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

GASemivariogramSensitivity

public GASemivariogramSensitivity(Object inGaModelSource,
                                  Object inDatasets,
                                  Object inLocations,
                                  Object outTable)

Creates the Semivariogram Sensitivity 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 - points locations where the sensitivity analysis is performed.

outTable - table storing the sensitivity 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 points locations where the sensitivity analysis is 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 points locations where the sensitivity analysis is performed. This is a required parameter.

Parameters:

inLocations - points locations where the sensitivity analysis is performed.

getNuggetSpanPercents

public double getNuggetSpanPercents()

Returns the Nugget span (% of model value) parameter of this tool . This parameter is the percentage subtracted and added to the Nugget parameter to create a range for subsequent random Nugget parameter selection. This is an optional parameter.

Returns:

the Nugget span (% of model value)

setNuggetSpanPercents

public void setNuggetSpanPercents(double nuggetSpanPercents)

Sets the Nugget span (% of model value) parameter of this tool . This parameter is the percentage subtracted and added to the Nugget parameter to create a range for subsequent random Nugget parameter selection. This is an optional parameter.

Parameters:

nuggetSpanPercents - the percentage subtracted and added to the Nugget parameter to create a range for subsequent random Nugget parameter selection.

getNuggetCalcTimes

public int getNuggetCalcTimes()

Returns the Number of calculations for Nugget parameter of this tool . This parameter is number of random Nugget values drawn from the Nugget span. This is an optional parameter.

Returns:

the Number of calculations for Nugget

setNuggetCalcTimes

public void setNuggetCalcTimes(int nuggetCalcTimes)

Sets the Number of calculations for Nugget parameter of this tool . This parameter is number of random Nugget values drawn from the Nugget span. This is an optional parameter.

Parameters:

nuggetCalcTimes - number of random Nugget values drawn from the Nugget span.

getPartialsillSpanPercents

public double getPartialsillSpanPercents()

Returns the Partial Sill span (% of model value) parameter of this tool . This parameter is percentage subtracted from and added to the Partial Sill parameter to create a range for random Partial Sill selection. This is an optional parameter.

Returns:

the Partial Sill span (% of model value)

setPartialsillSpanPercents

public void setPartialsillSpanPercents(double partialsillSpanPercents)

Sets the Partial Sill span (% of model value) parameter of this tool . This parameter is percentage subtracted from and added to the Partial Sill parameter to create a range for random Partial Sill selection. This is an optional parameter.

Parameters:

partialsillSpanPercents - percentage subtracted from and added to the Partial Sill parameter to create a range for random Partial Sill selection.

getPartialsillCalcTimes

public int getPartialsillCalcTimes()

Returns the Number of calculations for Partial Sill parameter of this tool . This parameter is number of random Partial Sill values drawn from the Partial Sill span. This is an optional parameter.

Returns:

the Number of calculations for Partial Sill

setPartialsillCalcTimes

public void setPartialsillCalcTimes(int partialsillCalcTimes)

Sets the Number of calculations for Partial Sill parameter of this tool . This parameter is number of random Partial Sill values drawn from the Partial Sill span. This is an optional parameter.

Parameters:

partialsillCalcTimes - number of random Partial Sill values drawn from the Partial Sill span.

getRangeSpanPercents

public double getRangeSpanPercents()

Returns the Major Range span (% of model value) parameter of this tool . This parameter is percentage subtracted and added to the Major Range parameter to create a range for a random Major Range selection. This is an optional parameter.

Returns:

the Major Range span (% of model value)

setRangeSpanPercents

public void setRangeSpanPercents(double rangeSpanPercents)

Sets the Major Range span (% of model value) parameter of this tool . This parameter is percentage subtracted and added to the Major Range parameter to create a range for a random Major Range selection. This is an optional parameter.

Parameters:

rangeSpanPercents - percentage subtracted and added to the Major Range parameter to create a range for a random Major Range selection.

getRangeCalcTimes

public int getRangeCalcTimes()

Returns the Number of calculations for Major Range parameter of this tool . This parameter is number of random Major Range values drawn from the Major Range span. This is an optional parameter.

Returns:

the Number of calculations for Major Range

setRangeCalcTimes

public void setRangeCalcTimes(int rangeCalcTimes)

Sets the Number of calculations for Major Range parameter of this tool . This parameter is number of random Major Range values drawn from the Major Range span. This is an optional parameter.

Parameters:

rangeCalcTimes - number of random Major Range values drawn from the Major Range span.

getMinrangeSpanPercents

public double getMinrangeSpanPercents()

Returns the Minor Range span (% of model value) parameter of this tool . This parameter is percentage subtracted and added to the Minor Range parameter to create a range for random Minor Range selection. This is an optional parameter.

Returns:

the Minor Range span (% of model value)

setMinrangeSpanPercents

public void setMinrangeSpanPercents(double minrangeSpanPercents)

Sets the Minor Range span (% of model value) parameter of this tool . This parameter is percentage subtracted and added to the Minor Range parameter to create a range for random Minor Range selection. This is an optional parameter.

Parameters:

minrangeSpanPercents - percentage subtracted and added to the Minor Range parameter to create a range for random Minor Range selection.

getMinrangeCalcTimes

public int getMinrangeCalcTimes()

Returns the Number of calculations for Minor Range parameter of this tool . This parameter is number of random Minor Range values drawn from the Minor Range span. If Anisotropy has been set in , a value is required. This is an optional parameter.

Returns:

the Number of calculations for Minor Range

setMinrangeCalcTimes

public void setMinrangeCalcTimes(int minrangeCalcTimes)

Sets the Number of calculations for Minor Range parameter of this tool . This parameter is number of random Minor Range values drawn from the Minor Range span. If Anisotropy has been set in , a value is required. This is an optional parameter.

Parameters:

minrangeCalcTimes - number of random Minor Range values drawn from the Minor Range span. If Anisotropy has been set in , a value is required.

getOutTable

public Object getOutTable()

Returns the Output table parameter of this tool . This parameter is table storing the sensitivity results. This is a required parameter.

Returns:

the Output table

setOutTable

public void setOutTable(Object outTable)

Sets the Output table parameter of this tool . This parameter is table storing the sensitivity results. This is a required parameter.

Parameters:

outTable - table storing the sensitivity 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