Label | Explanation | Data Type |
Input Route Features | The route features to be calibrated. | Feature Layer |
Route Identifier Field | The field containing values that uniquely identify each route. This field can be numeric or character. | Field |
Input Point Features | The point features used to calibrate the routes. | Feature Layer |
Point Identifier Field | The field that identifies the route on which each calibration point is located. The values in this field match those in the route identifier field. This field can be numeric or character. | Field |
Measure Field | The field containing the measure value for each calibration point. This field must be numeric. | Field |
Output Route Feature Class | The feature class to be created. It can be a shapefile or a geodatabase feature class. | Feature Class |
Measure Calculation Method (Optional) | Specifies how route measures will be recalculated.
| String |
Search Radius (Optional) | Limits how far a calibration point can be from a route by specifying the distance and its unit of measure. If the unit of measure is unknown, the units of the coordinate system of the route feature class will be used. | Linear Unit |
Interpolate between calibration points (Optional) | Specifies whether measure values will be interpolated between the calibration points.
| Boolean |
Extrapolate before calibration points (Optional) | Specifies whether measure values will be extrapolated before the calibration points.
| Boolean |
Extrapolate after calibration points (Optional) | Specifies whether measure values will be extrapolated after the calibration points.
| Boolean |
Ignore spatial gaps (Optional) | Specifies whether spatial gaps will be ignored when recalculating the measures on disjointed routes.
| Boolean |
Include all features in the output feature class (Optional) | Specifies whether route features that do not have any calibration points will be excluded from the output feature class.
| Boolean |
Build index (Optional) | Specifies whether an attribute index will be created for the route identifier field that is written to the Output Route Feature Class.
| Boolean |
Summary
Recalculates route measures using points.
Usage
Either whole or partial routes can be calibrated. You can choose to interpolate between the input points, extrapolate before the input points, extrapolate after the input points, or use any combination of these three methods.
Use the Make Feature Layer or Make Query Table tool to effectively reduce the routes that will be calibrated.
If the Output Route Feature Class will be written to a geodatabase, an appropriate M Tolerance, M Resolution, and M Domain environment should be set.
The Output Route Feature Class will include all the fields from the Input Route Features.
The Output has M Values environment setting is ignored. The Output Route Feature Class will have m- (measure) values.
A search radius of infinity cannot be specified.
An attribute index on the route identifier field speeds up the dynamic segmentation process. If you will be using the Output Route Feature Class parameter value for dynamic segmentation, it is recommended that you choose to have an attribute index created.
If any features are rejected by the Calibrate Routes process, a text file is created in the temporary file path to store information about those features, for example, C:\Users\patrickb\AppData\Local\Temp\Calibrate_Output0.txt (where Calibrate_Output is the name of the Output Route Feature Class).
Parameters
arcpy.lr.CalibrateRoutes(in_route_features, route_id_field, in_point_features, point_id_field, measure_field, out_feature_class, {calibrate_method}, {search_radius}, {interpolate_between}, {extrapolate_before}, {extrapolate_after}, {ignore_gaps}, {keep_all_routes}, {build_index})
Name | Explanation | Data Type |
in_route_features | The route features to be calibrated. | Feature Layer |
route_id_field | The field containing values that uniquely identify each route. This field can be numeric or character. | Field |
in_point_features | The point features used to calibrate the routes. | Feature Layer |
point_id_field | The field that identifies the route on which each calibration point is located. The values in this field match those in the route identifier field. This field can be numeric or character. | Field |
measure_field | The field containing the measure value for each calibration point. This field must be numeric. | Field |
out_feature_class | The feature class to be created. It can be a shapefile or a geodatabase feature class. | Feature Class |
calibrate_method (Optional) | Specifies how route measures will be recalculated.
| String |
search_radius (Optional) | Limits how far a calibration point can be from a route by specifying the distance and its unit of measure. If the unit of measure is unknown, the units of the coordinate system of the route feature class will be used. | Linear Unit |
interpolate_between (Optional) | Specifies whether measure values will be interpolated between the calibration points.
| Boolean |
extrapolate_before (Optional) | Specifies whether measure values will be extrapolated before the calibration points.
| Boolean |
extrapolate_after (Optional) | Specifies whether measure values will be extrapolated after the calibration points.
| Boolean |
ignore_gaps (Optional) | Specifies whether spatial gaps will be ignored when recalculating the measures on disjointed routes.
| Boolean |
keep_all_routes (Optional) | Specifies whether route features that do not have any calibration points will be excluded from the output feature class.
| Boolean |
build_index (Optional) | Specifies whether an attribute index will be created for the route identifier field that is written to the out_feature_class.
| Boolean |
Code sample
The following Python window script demonstrates how to use the CalibrateRoutes function in immediate mode.
import arcpy
arcpy.env.workspace = "C:/data"
arcpy.CalibrateRoutes_lr("hwy.shp", "RID", "cal_pts.shp", "RID", "MEASURE",
"C:/output/hwy_new.shp","DISTANCE", "5.0 feet",
"BETWEEN", "BEFORE", "AFTER", "#", "NO_KEEP")
The following Python script demonstrates how to use the CalibrateRoutes function with file geodatabase data in a stand-alone Python script.
# Name CalibrateRoutes_Example2.py
# Description: Calibrate personal geodatabase routes with file geodatabase
# points.
# Import system modules
import arcpy
# Set workspace
arcpy.env.workspace = "C:/Data/Pitt.gdb"
# Set local variables
rts = "roads/hwy" # hwy is in the roads feature dataset
rid = "ROUTE1"
pts = "roads/cal_pts" # cal_pts is in the roads feature dataset
mfield = "MEASURE"
radius = "2.5 Meters"
out_fc = "roads/hwy_new" # new feature class in the roads feature dataset
# Execute CalibrateRoutes
arcpy.CalibrateRoutes_lr(rts, rid, pts, rid, mfield, out_fc, "DISTANCE", radius,
"BETWEEN", "NO_BEFORE", "NO_AFTER")
The following Python script demonstrates how to use the CalibrateRoutes function with enterprise geodatabase data in a stand-alone Python script.
# Name CalibrateRoutes_Example3.py
# Description: Calibrate enterprise geodatabase routes using enterprise
# geodatabase points.
# Import system modules
import arcpy
# Set workspace
wkspc = "C:/MyProject/myConn.sde"
arcpy.env.workspace = wkspc
# Set local variables
rts = arcpy.ValidateTableName("hwy", wkspc) # standalone feature class
rid = "ROUTE1"
pts = arcpy.ValidateTableName("cal_pts", wkspc) # standalone feature class
mfield = "MEASURE"
radius = "5.0 Feet"
out_fc = "hwy_new" # new standalone feature class
# Execute CalibrateRoutes
arcpy.CalibrateRoutes_lr(rts, rid, pts, rid, mfield, out_fc, "DISTANCE", radius,
"#", "#", "#", "#", "NO_KEEP")
Environments
Licensing information
- Basic: Yes
- Standard: Yes
- Advanced: Yes