Setup Level Territory Shape Parameters (Territory Design)

License Level:BasicStandardAdvanced

Summary

Allows the setup of parameter levels to create or balance territories.

Usage

Syntax

SetupLevelTerritoryShapeParameters_TD_td (in_territory_solution_layer, in_level, {in_measure_type}, {in_compactness}, {in_use_only_closest}, {in_territory_center_location}, {in_summary_attribute})
ParameterExplanationData Type
in_territory_solution_layer

The Territory Solution layer used to setup the parameters.

GP TD Layer
in_level

The Territory Level to modify.

String
in_measure_type
(Optional)

The Type of distance measure for building the territory shape.

  • STRAIGHT_LINE_DISTANCEstraight line distance will be used for calculate Maximum Distance, Minimum Distance and Minimum Distance Between Territory Centers
  • DRIVE_DISTANCEresults of the ArcGIS Network Analyst extension solver, with Distance Units, will be used for calculating distances
  • DRIVE_TIMEresults of the ArcGIS Network Analyst extension solver, with Time Units, will be used for calculating distances
String
in_compactness
(Optional)

This parameter adjusts the preference between territory shape and variable balance. A low value of compactness means good balance but shape is compromised.

Integer
in_use_only_closest
(Optional)

This option overrides previous balancing. Minimum attribute capacity constraints can be used to ensure a more ideal territory shape. Territories can only acquire features that are closest to their territory center, instead of centers of surrounding territories. This essentially puts less emphasis on statistical inputs and applies a heavier weight to maintaining a territory boundary.

  • USE_ONLY_CLOSEST_FEATURESonly the closest features will be used for deriving territories
  • USE_ALL_FEATURESall surrounding features will be used for deriving territories
Boolean
in_territory_center_location
(Optional)

The location of a non-fixed (not created from seed points) center is defined with this parameter. The territory center will change automatically as the territory shape changes but will always reside inside the territory boundary.

  • GEOMETRIC_CENTERterritory center will be placed at the geometric center of the territory (center of the territory’s bounding box)
  • MEAN_CENTERterritory center will be placed at the mean center as defined by spatial locations with or without a specified summary attribute
  • DENSITY_CENTERterritory center will be placed at the density center by spatial locations with or without a specified summary attribute
  • FARTHEST_POINT_FROM_ALL_BOUNDARIESterritory center will be located at the farthest location from all its territory boundaries
String
in_summary_attribute
(Optional)

The Territories can be calculated using the locations of each geography element or the summary value assigned to each geography element. This parameter is used to specify the base level field to calculate the territory. Set an empty value when using spatial locations only.

Field

Code Sample

SetupLevelTerritoryShapeParameters_TD example (Python window)

The following Python window script demonstrates how to use the tool in immediate mode.

import arcgisscripting
gp = arcgisscripting.create()
gp.SetupLevelTerritoryShapeParameters_TD("new layer", "Territories[1]", "STRAIGHT_LINE_DISTANCE", 50, "USE_ALL_FEATURES", "MEAN_CENTER", "TOTPOP_CY")
SetupLevelTerritoryShapeParameters_TD example 2 (stand-alone script)

The following stand-alone script demonstrates how to use the tool.

# Import system modules
import arcgisscripting
gp = arcgisscripting.create()

# Set local variables
solution = "new layer"
level = "Territories[1]"
measureType = "STRAIGHT_LINE_DISTANCE"
compactness = 50
useFeatures = "USE_ALL_FEATURES"
territoryCenterLocation = "MEAN_CENTER"
summaryAttribute = "TOTPOP_CY"

# Execute tool
gp.SetupLevelTerritoryShapeParameters_TD(solution, level, measureType, compactness, useFeatures, territoryCenterLocation, summaryAttribute)

Environments

This tool does not use any geoprocessing environments

Related Topics

Licensing Information

ArcGIS for Desktop Basic: Requires Business Analyst
ArcGIS for Desktop Standard: Requires Business Analyst
ArcGIS for Desktop Advanced: Requires Business Analyst
3/25/2014