Generate Calibration Points (Location Referencing)

Available with Location Referencing license.

Summary

Generates calibration points for any route shape provided, including complex shapes such as self-closing, self-intersecting, and branched routes.

Usage

• An LRS dataset is required to run this tool.

  Learn more about creating an LRS dataset in ArcGIS Pipeline Referencing or creating an LRS dataset in ArcGIS Roads and Highways .

• The Input Polyline Features parameter value is the basis for the calibration points that will be generated.

• The Calibration Point Feature Class parameter value must be registered with the LRS.

• The LRS Network parameter value must be registered with the LRS.

• Derived LRS Networks are not supported as the LRS Network parameter value.

• Z-values are considered when calculating the geometric length of the centerlines.

• Gap calibration rules will be followed while generating calibration points using the Geometry length and Attribute fields options for the Calibration Method parameter.

  Learn more about calibrating routes with physical gaps in ArcGIS Roads and Highways or calibrating routes with physical gaps in ArcGIS Pipeline Referencing.

• If the Calibration Method parameter is set to M on route, m-values will be used at the start vertex and end vertex of the input routes to create beginning and ending calibration points.

• When the Calibration Method parameter is set to Attribute fields, the following occur:

  • The Attribute fields option will be used to evaluate fields with a Double field type for calibration.
  • The From Measure Field parameter value will be used to provide the from measure of the route and the To Measure Field parameter value will be used to provide the to measure of the route.

• The Input Polyline Features parameter value can be a feature service layer that does not have the linear referencing capability. If the Calibration Point Feature Class parameter value is a feature service layer, it must have the linear referencing capability enabled.

Parameters

Dialog

Label	Explanation	Data Type
Input Polyline Features	The features that will be used as the source to calculate the measure values for calibration points.	Feature Layer
Route ID Field	The field containing values that uniquely identify each route. The field type must match the Route ID field in the calibration point feature class.	Field
From Date Field	The field containing the from date values of a route.	Field
To Date Field	The field containing the to date values of a route.	Field
Calibration Point Feature Class	The existing calibration point feature class to which new features will be added.	Feature Layer
LRS Network	The LRS Network for which the measure values will be generated in the calibration points feature class.	String
Calibration Direction (Optional)	Specifies the direction of increasing calibration on a route when creating calibration points. Digitized direction—The direction of digitization of the individual polyline feature determines the direction of calibration for the route. This is the default. Measure direction—The direction of increasing m-values of the individual polyline feature determines the direction of calibration for the route.If the individual polyline feature does not include m-values, the digitized direction will be used.	String
Calibration Method (Optional)	Specifies the method that will be used to determine the measures on a route when creating calibration points. Geometry length—The geometrical length of the input route feature will be used as the calibration method. This is the default. M on route—The measure values on the input route feature will be used as the calibration method. Attribute fields—The measure values stored in attribute fields of the input route feature will be used as the calibration method.	String
From Measure Field (Optional)	The field containing the from measure for the selected route. This parameter is active when the Calibration Method parameter is set to Attribute fields.	Field
To Measure Field (Optional)	The field containing the to measure for the selected route. This parameter is active when the Calibration Method parameter is set to Attribute fields.	Field

Derived Output

Label	Explanation	Data Type
Updated Calibration Point Feature Class	The updated calibration features.	Feature Layer
Output Details File	A text file that details changes made by the tool.	Text File

Python

arcpy.locref.GenerateCalibrationPoints(in_polyline_features, route_id_field, from_date_field, to_date_field, in_calibration_point_feature_class, lrs_network, {calibration_direction}, {calibration_method}, {from_measure_field}, {to_measure_field})

Name	Explanation	Data Type
in_polyline_features	The features that will be used as the source to calculate the measure values for calibration points.	Feature Layer
route_id_field	The field containing values that uniquely identify each route. The field type must match the Route ID field in the calibration point feature class.	Field
from_date_field	The field containing the from date values of a route.	Field
to_date_field	The field containing the to date values of a route.	Field
in_calibration_point_feature_class	The existing calibration point feature class to which new features will be added.	Feature Layer
lrs_network	The LRS Network for which the measure values will be generated in the calibration points feature class.	String
calibration_direction (Optional)	Specifies the direction of increasing calibration on a route when creating calibration points. DIGITIZED_DIRECTION—The direction of digitization of the individual polyline features determines the direction of calibration for the route. This is the default. MEASURE_DIRECTION—The direction of increasing m-values of the individual polyline feature determines the direction of calibration for the route.If the individual polyline feature does not include m-values, the digitized direction will be used.	String
calibration_method (Optional)	Specifies the method that will be used to determine the measures on a route when creating calibration points. GEOMETRY_LENGTH—The geometrical length of the input route feature will be used as the calibration method. This is the default. M_ON_ROUTE—The measure values on the input route feature will be used as the calibration method. ATTRIBUTE_FIELDS—The measure values stored in attribute fields of the input route feature will be used as the calibration method.	String
from_measure_field (Optional)	The field containing the from measure for the selected route. This parameter is enabled when the calibration_method parameter is set to ATTRIBUTE_FIELDS.	Field
to_measure_field (Optional)	The field containing the to measure for the selected route. This parameter is enabled when the calibration_method parameter is set to ATTRIBUTE_FIELDS.	Field

Derived Output

Name	Explanation	Data Type
out_calibration_point_feature_class	The updated calibration features.	Feature Layer
out_details_file	A text file that details changes made by the tool.	Text File

Code sample

GenerateCalibrationPoints example 1 (Python window)

The following Python window script demonstrates how to use the GenerateCalibrationPoints function in the Python window.

# Name: GenerateCalibrationPoints.py
# Description: Build calibration point features when an LRS already exists in the geodatabase.
# Requires: ArcGIS Location Referencing

# Tool variables:
in_polyline_features = "SourceRoutes"
route_id_field = "RouteID"
from_date_field = "FromDate"
to_date_field = "ToDate"
in_calibration_point_feature_class = "Calibration_Point"
lrs_network = "NonLineNetwork"
calibration_direction = "MEASURE_DIRECTION"
calibration_method = "GEOMETRY_LENGTH"

# Set current workspace
arcpy.env.workspace = r"C:\Data\UPDM.gdb"

# Execute Generate Calibration Points
arcpy.locref.GenerateCalibrationPoints(in_polyline_features, route_id_field, from_date_field, 
                                       to_date_field, in_calibration_point_feature_class, 
                                       lrs_network, calibration_direction, calibration_method)

GenerateCalibrationPoints example 2 (stand-alone script)

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

# Name: GenerateCalibrationPoints.py
# Description: Build calibration point features when an LRS already exists in the geodatabase.
# Requires: ArcGIS Location Referencing

# Import arcpy module
import arcpy

# Check out license
arcpy.CheckOutExtension("LocationReferencing")

# Local variables:
in_polyline_features = r"C:\Data\SourceData.gdb\LRS\SourceRoutes"
route_id_field = "RouteID"
from_date_field = "FromDate"
to_date_field = "ToDate"
in_calibration_point_feature_class = r"C:\\Data\UPDM.gdb\LRS\Calibration_Point"
lrs_network = "EngineeringNetwork"
calibration_direction = "MEASURE_DIRECTION"
calibration_method = "GEOMETRY_LENGTH"

# Process: Generate Calibration Points
arcpy.locref.GenerateCalibrationPoints(in_polyline_features, route_id_field, from_date_field, 
                                       to_date_field, in_calibration_point_feature_class, 
                                       lrs_network, calibration_direction, calibration_method)

# Check in license
arcpy.CheckInExtension('LocationReferencing')

GenerateCalibrationPoints example 3 (stand-alone script)

The following stand-alone script demonstrates how to use the GenerateCalibrationPoints function to build calibration points into an existing feature service.

# Name: GenerateCPs_Pro_standalone_fs.py
# Description: Build calibration point features in an existing feature service.
# Requires: ArcGIS Location Referencing

# Import arcpy module
import arcpy

# Check out license
arcpy.CheckOutExtension("LocationReferencing"

# Local variables:
in_polyline_features = r"C:\Data\SourceData.gdb\LRS\SourceRoutes"
route_id_field = "RouteID"
from_date_field = "FromDate"
to_date_field = "ToDate"
in_calibration_point_feature_class = r"https://yourdomain.com/server/rest/services/FeatureServiceName/FeatureServer/1"
calibration_direction = "MEASURE_DIRECTION"
calibration_method = "GEOMETRY_LENGTH"

# Input LRS route network is in feature service.  Signing in portal is required to access the feature service.
arcpy.SignInToPortal('https://yourdomain.com/portal', 'username', 'password')

# Map the calibration point layer from the feature service. Here, 5 corresponds to the calibration point layer.
lrs_network = r"https://yourdomain.com/server/rest/services/FeatureServiceName/FeatureServer/1"

# Execute the tool
arcpy.locref.GenerateCalibrationPoints(in_calibration_point_feature_class)

# Process: Generate Calibration Points
arcpy.locref.GenerateCalibrationPoints(in_polyline_features, route_id_field, from_date_field, 
                                       to_date_field, in_calibration_point_feature_class, 
                                       lrs_network, calibration_direction, calibration_method)
                                                         
## Check in license
arcpy.CheckInExtension('LocationReferencing')

Environments

Current Workspace, Parallel Processing Factor

Special cases

Parallel Processing Factor

The default value for this environment, if left blank, is 0%. Any absolute value for the environment is always clamped between 0 and the number of logical cores in that machine.

Licensing information

• Basic: Requires ArcGIS Location Referencing (ArcGIS Pipeline Referencing or ArcGIS Roads and Highways)
• Standard: Requires ArcGIS Location Referencing (ArcGIS Pipeline Referencing or ArcGIS Roads and Highways)
• Advanced: Requires ArcGIS Location Referencing (ArcGIS Pipeline Referencing or ArcGIS Roads and Highways)