|
|||||||||
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.spatialstatisticstools.OrdinaryLeastSquares
public class OrdinaryLeastSquares
Performs global Ordinary Least Squares (OLS) linear regression to generate predictions or to model a dependent variable in terms of its relationships to a set of explanatory variables. Results are accessible from the Results window. The Ordinary Least Squares tool is contained in the Spatial Statistics Tools tool box.
Field Summary |
---|
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool |
---|
vals |
Constructor Summary | |
---|---|
OrdinaryLeastSquares()
Creates the Ordinary Least Squares tool with defaults. |
|
OrdinaryLeastSquares(Object inputFeatureClass,
Object uniqueIDField,
Object outputFeatureClass,
Object dependentVariable,
Object explanatoryVariables)
Creates the Ordinary Least Squares tool with the required parameters. |
Method Summary | |
---|---|
Object |
getCoefficientOutputTable()
Returns the Coefficient Output Table parameter of this tool . |
Object |
getDependentVariable()
Returns the Dependent Variable parameter of this tool . |
Object |
getDiagnosticOutputTable()
Returns the Diagnostic Output Table parameter of this tool . |
Object |
getExplanatoryVariables()
Returns the Explanatory Variables parameter of this tool . |
Object |
getInputFeatureClass()
Returns the Input Feature Class parameter of this tool . |
Object |
getOutputFeatureClass()
Returns the Output Feature Class 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. |
Object |
getUniqueIDField()
Returns the Unique ID Field parameter of this tool . |
void |
setCoefficientOutputTable(Object coefficientOutputTable)
Sets the Coefficient Output Table parameter of this tool . |
void |
setDependentVariable(Object dependentVariable)
Sets the Dependent Variable parameter of this tool . |
void |
setDiagnosticOutputTable(Object diagnosticOutputTable)
Sets the Diagnostic Output Table parameter of this tool . |
void |
setExplanatoryVariables(Object explanatoryVariables)
Sets the Explanatory Variables parameter of this tool . |
void |
setInputFeatureClass(Object inputFeatureClass)
Sets the Input Feature Class parameter of this tool . |
void |
setOutputFeatureClass(Object outputFeatureClass)
Sets the Output Feature Class parameter of this tool . |
void |
setUniqueIDField(Object uniqueIDField)
Sets the Unique ID Field 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 OrdinaryLeastSquares()
Initializes the array of tool parameters with the default values specified when the tool was created.
public OrdinaryLeastSquares(Object inputFeatureClass, Object uniqueIDField, Object outputFeatureClass, Object dependentVariable, Object explanatoryVariables)
Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.
inputFeatureClass
- the feature class containing the dependent and independent variables for analysis.uniqueIDField
- an integer field containing a different value for every feature in the Input Feature Class.outputFeatureClass
- the output feature class to receive dependent variable estimates and residuals.dependentVariable
- the numeric field containing values for what you are trying to model.explanatoryVariables
- a list of fields representing explanatory variables in your regression model.Method Detail |
---|
public Object getInputFeatureClass()
public void setInputFeatureClass(Object inputFeatureClass)
inputFeatureClass
- the feature class containing the dependent and independent variables for analysis.public Object getUniqueIDField()
public void setUniqueIDField(Object uniqueIDField)
uniqueIDField
- an integer field containing a different value for every feature in the Input Feature Class.public Object getOutputFeatureClass()
public void setOutputFeatureClass(Object outputFeatureClass)
outputFeatureClass
- the output feature class to receive dependent variable estimates and residuals.public Object getDependentVariable()
public void setDependentVariable(Object dependentVariable)
dependentVariable
- the numeric field containing values for what you are trying to model.public Object getExplanatoryVariables()
public void setExplanatoryVariables(Object explanatoryVariables)
explanatoryVariables
- a list of fields representing explanatory variables in your regression model.public Object getCoefficientOutputTable()
public void setCoefficientOutputTable(Object coefficientOutputTable)
coefficientOutputTable
- the full pathname to an optional table that will receive model coefficients, standard errors, and probabilities for each explanatory variable.public Object getDiagnosticOutputTable()
public void setDiagnosticOutputTable(Object diagnosticOutputTable)
diagnosticOutputTable
- the full pathname to an optional table that will receive model summary diagnostics.public String getToolName()
public String getToolboxName()
public String getToolboxAlias()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |