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

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

public class GASemivariogramSensitivity
extends AbstractGPTool

The semivariogram parameters Nugget, Partial Sill and Range can be varied to perform a sensitivity analysis. The Semivariogram Sensitivity tool is contained in the Geostatistical Analyst Tools tool box.
Learn more about Semivariogram Sensitivity

Software restrictions: none

Usage tips:


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 - Geostatistical Layer | Geostatistical Model, input geostatistical model source.
inDatasets - Geostatistical Value Table, this input has two sections:
inLocations - Feature Layer, the locations of the points where the analysis will be performed.
outTable - Table, table of sensitivity results.
Method Detail

getInGaModelSource

public Object getInGaModelSource()
Returns the Geostatistical model source parameter of this tool . This parameter is Geostatistical Layer | Geostatistical Model, input geostatistical model source. 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 Geostatistical Layer | Geostatistical Model, input geostatistical model source. This is a required parameter.

Parameters:
inGaModelSource - Geostatistical Layer | Geostatistical Model, input geostatistical model source.

getInDatasets

public Object getInDatasets()
Returns the Input dataset(s) parameter of this tool . This parameter is Geostatistical Value Table, this input has two sections: 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 Geostatistical Value Table, this input has two sections: This is a required parameter.

Parameters:
inDatasets - Geostatistical Value Table, this input has two sections:

getInLocations

public Object getInLocations()
Returns the Point observation locations parameter of this tool . This parameter is Feature Layer, the locations of the points where the analysis 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 Feature Layer, the locations of the points where the analysis will be performed. This is a required parameter.

Parameters:
inLocations - Feature Layer, the locations of the points where the analysis will be performed.

getNuggetSpanPercents

public double getNuggetSpanPercents()
Returns the Nugget span (% of model value) parameter of this tool . This parameter is Double, the percentage that is subtracted and added to the Nugget parameter to create a range from which a random Nugget parameter will be selected. 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 Double, the percentage that is subtracted and added to the Nugget parameter to create a range from which a random Nugget parameter will be selected. This is an optional parameter.

Parameters:
nuggetSpanPercents - Double, the percentage that is subtracted and added to the Nugget parameter to create a range from which a random Nugget parameter will be selected.

getNuggetCalcTimes

public int getNuggetCalcTimes()
Returns the Number of calculations for Nugget parameter of this tool . This parameter is Long, the number of random Nugget parameters that will be 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 Long, the number of random Nugget parameters that will be drawn from the Nugget span. This is an optional parameter.

Parameters:
nuggetCalcTimes - Long, the number of random Nugget parameters that will be drawn from the Nugget span.

getPartialsillSpanPercents

public double getPartialsillSpanPercents()
Returns the Partial Sill span (% of model value) parameter of this tool . This parameter is Double, the percentage that is subtracted and added to the Partial Sill parameter to create a range from which a random Partial Sill parameter will be selected. 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 Double, the percentage that is subtracted and added to the Partial Sill parameter to create a range from which a random Partial Sill parameter will be selected. This is an optional parameter.

Parameters:
partialsillSpanPercents - Double, the percentage that is subtracted and added to the Partial Sill parameter to create a range from which a random Partial Sill parameter will be selected.

getPartialsillCalcTimes

public int getPartialsillCalcTimes()
Returns the Number of calculations for Partial Sill parameter of this tool . This parameter is Long, the number of random Partial Sill parameters that will be 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 Long, the number of random Partial Sill parameters that will be drawn from the Partial Sill span. This is an optional parameter.

Parameters:
partialsillCalcTimes - Long, the number of random Partial Sill parameters that will be 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 Double, the percentage that is subtracted and added to the Major Range parameter to create a range from which a random Major Range parameter will be selected. 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 Double, the percentage that is subtracted and added to the Major Range parameter to create a range from which a random Major Range parameter will be selected. This is an optional parameter.

Parameters:
rangeSpanPercents - Double, the percentage that is subtracted and added to the Major Range parameter to create a range from which a random Major Range parameter will be selected.

getRangeCalcTimes

public int getRangeCalcTimes()
Returns the Number of calculations for Major Range parameter of this tool . This parameter is Long, the number of random Major Range parameters that will be 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 Long, the number of random Major Range parameters that will be drawn from the Major Range span. This is an optional parameter.

Parameters:
rangeCalcTimes - Long, the number of random Major Range parameters that will be 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 Double, the percentage that is subtracted and added to the Minor Range parameter to create a range from which a random Minor Range parameter will be selected. 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 Double, the percentage that is subtracted and added to the Minor Range parameter to create a range from which a random Minor Range parameter will be selected. This is an optional parameter.

Parameters:
minrangeSpanPercents - Double, the percentage that is subtracted and added to the Minor Range parameter to create a range from which a random Minor Range parameter will be selected.

getMinrangeCalcTimes

public int getMinrangeCalcTimes()
Returns the Number of calculations for Minor Range parameter of this tool . This parameter is Long, the number of random Minor Range parameters that will be drawn from the Minor Range span. 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 Long, the number of random Minor Range parameters that will be drawn from the Minor Range span. This is an optional parameter.

Parameters:
minrangeCalcTimes - Long, the number of random Minor Range parameters that will be drawn from the Minor Range span.

getOutTable

public Object getOutTable()
Returns the Output table parameter of this tool . This parameter is Table, table of 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, table of sensitivity results. This is a required parameter.

Parameters:
outTable - Table, table of 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