- URL:https://<geoanalytics-url>/GeographicallyWeightedRegression
- Version Introduced:10.8.1
Description
This tool performs GeographicallyWeightedRegression (GWR), which is a local form of linear regression used to model spatially varying relationships.
The following are examples of the types of questions you can answer using this tool:
- Is the relationship between educational attainment and income consistent across the study area?
- What are the key variables that explain high forest fire frequency?
- Where are the districts in which children are achieving high test scores? What characteristics seem to be associated? Where is each characteristic most important?
Request parameters
Parameter | Details |
---|---|
inputLayer (Required) | The layer containing the dependent and independent variables. Syntax: As described in Feature input, this parameter can be one of the following:
REST examples
|
explanatoryVariables (Required) | One or more fields representing independent explanatory variables in your regression model. REST examples
|
dependentVariable (Required) | The numeric field containing the observed values you want to model. REST examples
|
modelType (Required) | Specifies the type of data that will be modeled. REST examples
|
neighborhoodSelectionMethod (Required) | Specifies how the neighborhood size will be determined.
REST examples
|
neighborhoodType (Required) | Specifies whether the neighborhood used is constructed as a fixed distance or allowed to vary in spatial extent depending on the density of the features.
REST examples
|
distanceBand (Required if neighborhoodType is DistanceBand) | The distance for the spatial extent of the neighborhood. REST examples
|
distanceBandUnit (Required if distanceBand is used) | The unit of the distance for the spatial extent of the neighborhood. Values: Meters | Kilometers | Feet | FeetInt | FeetUS | Miles | MilesInt | MilesUS | NauticalMiles | NauticalMilesInt | NauticalMilesUS | Yards | YardsInt | YardsUS REST examples
|
numberOfNeighbors (Required if neighborhoodType is NumberOfNeighbors) | The closest number of neighbors (up to 1000) to consider for each feature. The number should be an integer between 2 and 1000. REST examples
|
localWeightingScheme (Optional) | Specifies the kernel type that will be used to provide the spatial weighting in the model. The kernel defines how each feature is related to other features within its neighborhood.
REST examples
|
outputTrainedName | The task will create a feature service of the results. You define the name of the service. REST examples
|
context (Optional) | The context parameter contains additional settings that affect task execution. For this task, there are four settings:
|
f | The response format. The default response format is html. Values: html | json |
Example usage
Below is a sample request URL for GeographicallyWeightedRegression:
https://webadaptor.domain.com/server/rest/services/System/GeoAnalyticsTools/GPServer/GeogrpahicallyWeightedRegression/submitJob?inputLayer={"url":"https://webadaptor.domain.com/server/rest/services/Hurricane/hurricaneTrack2017/0"}&dependentVariable=ShelterCapacity&explanatoryVariables=CityDensity, ShelterLocations&modelType=Continuous&neighborhoodType=NumberOfNeighbors&numberOfNeighbors=100&outputTrainedName=myoutput&context={"extent":{"xmin":-122.68,"ymin":45.53,"xmax":-122.45,"ymax":45.6,"spatialReference":{"wkid":4326}}}&f=json
Response
When you submit a request, the service assigns a unique job ID for the transaction.
{
"jobId": "<unique job identifier>",
"jobStatus": "<job status>"
}
After the initial request is submitted, you can use jobId to periodically check the status of the job and messages as described in Check job status. Once the job has successfully completed, use jobId to retrieve the results. To track the status, you can make a request of the following form:
https://<analysis url>/GeographicallyWeightedRegression/jobs/<jobId>
Access results
When the status of the job request is esriJobSucceeded, you can access the results of the analysis by making a request of the following form:
https://<analysis-url>/GeographicallyWeightedRegression/jobs/<jobId>/results/<response type>?token=<your token>&f=json
Response | Description |
---|---|
output | The input features that are fit to the model. The type of feature (table, point, line, or polygon) depends on the input layers.
The result has properties for parameter name, data type, and value. The contents of value depend on the outputName parameter provided in the initial request. The value contains the URL of the feature service layer. See Feature output for more information about how the result layer is accessed. |
processInfo | The processInfo parameter contains strings that summarize the Geographically Weighted Regression result. These strings are used for reporting by Map Viewer Classic. You can create your own custom reports for your application using these strings. There are four parts in the returned JSON as follows:
|