Skip To Content

Overlay Events

Summary

Overlays one or more linear event feature layers against a target network and outputs a feature class or table that represents the dynamic segmentation of the inputs.

Usage

  • All input Event Layers must be line events.

  • The Event Layers parameter may only include linear event feature classes registered with an ArcGIS Pipeline Referencing network.

  • If the input events use different Linear Referencing Methods (LRM), they will be translated against the LRM of the target network.

  • This tool supports selection sets.

  • This tool supports definition filters.

  • This tool supports input Event Layers that are configured to contain events that span multiple routes. The output will still dynamically segment at the route level of the target network using the Network Fields parameter.

  • This tool supports temporal segmentation (time slicing). This will occur by default and can be overridden by creating a time-based definition query or applying a selection set to the inputs.

  • This tool supports including one or more fields from the network feature class in the output using the Network Fields parameter.

  • The output can be saved as either a table or a feature class.

  • If saved as a table or feature class, the output will have the following indexes and fields:

    IndexFields

    Route_ID

    • Route_ID

    Rid_Dates_Me

    • Route_ID
    • From_Date
    • To_Date
    • From_Measure
    • To_Measure

Syntax

OverlayEvents_locref (in_route_features, event_layers, output_dataset, {include_geometry}, {network_fields})
ParameterExplanationData Type
in_route_features

The target network against which the event layers will be dynamically segmented.

Feature Layer
event_layers
[event_layers,...]

The event layers to be dynamically segmented together against a target network.

Feature Layer
output_dataset

The table or feature class to be created, containing the output event records.

Table
include_geometry
(Optional)

Determines whether the output_dataset will include a geometry column.

  • EXCLUDE_GEOMETRYWill not include the event geometry in the output_dataset. Event records will be stored as a table. This is the default.
  • INCLUDE_GEOMETRYWill include the event geometry in the output_dataset. Event records will be stored as a feature class.
Boolean
network_fields
[network_fields,...]
(Optional)

Fields from the network layer that will be included in the output.

Field

Code sample

OverlayEvents example 1 (Python window)

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

# tool variables
in_route_features = r"C:\Data\NY_Data.gdb\LRSN_MilePoint"
event_layers = [r"C:\Data\NY_Data.gdb\LRSE_Access_Control", r"C:\Data\NY_Data.gdb\LRSE_Functional_Class"]
output_dataset = r"C:\Data\NY_Data.gdb\Output"
include_geometry = "EXCLUDE_GEOMETRY"
network_fields = ""

# set current workspace
arcpy.env.workspace = "C:/Data/NY_Data.gdb"

# execute the tool
arcpy.OverlayEvents_locref(in_route_features, event_layers, output_dataset, include_geometry, network_fields)
OverlayEvents example 2 (stand-alone script)

The following Python script demonstrates how to use the OverlayEvents tool in a stand-alone Python script.

# Name: OverlayEvents.py
# Description: Overlays one or more linear event feature layers against a target network and outputs a feature class or table that represents the dynamic segmentation of the inputs.
# Requires: ArcGIS Pipeline Referencing
 
# Import arcpy module
import arcpy
 
# Check out any necessary licenses
arcpy.CheckOutExtension("LocationReferencing")

# Local variables:
Network = r"C:\Data\NY_Data.gdb\LRSN_MilePoint"
Events = [r"C:\Data\NY_Data.gdb\LRSE_Access_Control", r"C:\Data\NY_Data.gdb\LRSE_Functional_Class"]
Output_Dataset = r"C:\Data\NY_Data.gdb\Output"
Geometry = "EXCLUDE_GEOMETRY"
Network_Fields = ""

# Process: Overlay Events
arcpy.OverlayEvents_locref(Network, Events, Output_Dataset, Geometry, Network_Fields)

Environments

Licensing information

  • ArcGIS Desktop Basic: Requires ArcGIS Pipeline Referencing
  • ArcGIS Desktop Standard: Requires ArcGIS Pipeline Referencing
  • ArcGIS Desktop Advanced: Requires ArcGIS Pipeline Referencing

Related topics