networkODMatrix

Origin Destination (OD) Matrix

Calculates the cost along a Bidirectional Network (BDN) from each Origin to each Destination. The result can be stored as straight lines or polylines representing the shortest/quickest path between the origins and destinations

Inputs:

A Network created with ET GeoWizards (.etn file). Must be a Bidirectional Network (BDN).
Input Origin Points layer.
Input Destination Point layer representing the points to be visited.
Snap tolerance - a distance to the network features. If the points are closer than this distance to a network feature they will be used in the analysis otherwise they will be ignored. The distance is in the linear units of the spatial reference used as a source for creation of the Network.

Input Point Barrier layer. The points of this layer represent barriers. The closest edge to each of these points (if within the snap tolerance) will be considered closed and will not participate in the network analysis.
Direction field for the Input Point Barrier layer. In Bidirectional network the barriers can be set for only one of the directions. This can be indicated if the Barrier Point dataset has a field that indicates in which direction the barrier works.

FT - indicates the Barrier will prohibit movement only in the direction of the polyline. Movement against the direction of the polyline is allowed.
TF - indicates the Barrier will prohibit movement only against the direction of the polyline. Movement in the direction of the polyline is allowed.
Any other values in the Direction field will prohibit movement in both directions

User option - whether the output to be represented as straight lines or routes along the network
Cut Off cost - if the cost between the Origin and Destination is larger than this distance, no record is added in the output.

Outputs:

A Polyline feature layer. Depending on the user selected option the result will be:

Straight lines connecting the Origin to Destination points.
Polylines that represent the routes between the Origin and Destination points along the network. The polylines will have M values where the M will be 0 for the Origin point and the total cost for the end point of the route.

The attribute table of the output will have 4 fields.

ET_From - indicates the ID of the start point of this route
ET_To - indicates the end point of this route
ET_Dist - the distance between the start and end point along the network in the linear units of the spatial reference used as a source for creation of the Network.
ET_Cost - the cost to travel from the start point to the end point of the route in the units of the cost used by the Network (meters, feet, minutes, etc.)

Notes :

It is recommended that the input point layers has the same spatial reference as the layer used as a source for the Network.
If the spatial reference of the points and the Network are different, the points will be projected to the spatial reference of the Network.
The result layer will have the spatial reference of the Network.

Example:

Results from the OD Matrix function - Network created with no cost field - length of the street segments used as cost. Although straight lines are used as an output, the cost/distance values populated in the attribute table are the values calculated along the network.

Results from the OD Matrix function

Running Programmatically

(Go to TOP)

Parameters

Expression	Explanation
Function Name	ODMatrix
<Network to Use>	A String - the full name of the Network file (.etn).
<Input Origin Points>	A String representing the Input Origin Points layer.
<Input Destination Points>	A String representing the input destinations layer.
<output dataset>	A String - the full name of the output layer.
<snap tolerance>	A Double representing the snap tolerance(in the units of the spatial reference of the Network).
{Input Barrier Points}	A String representing the input layer with barrier points. Must be of Point type.
{Barriers Direction Field}	A String representing the name of the field in the Input Barrier Points that will indicate the direction in which the barrier defined by each point work . Must be of String type.
{Straight Lines Output}	A Boolean indicating whether the output to be represented by straight lines. Default = FALSE
{CutOff Cost}	A Double representing the CutOff cost

Running the function

ETGWPath used in the table below is the full path to ETGWRun.exe (E.G. "C:\Program Files\ETSpatial Techniques\ETGeo Wizards\ETGWRun.exe")

Language	Syntax
Python	subprocess.call([ETGWPath, "ODMatrix", "Network to Use", "Input Origin Points","Input Destination Points", "output dataset","snap tolerance", "Input Barrier Points", "Barriers Direction Field", "Straight Lines Output" "CutOff Cost"])
.NET using ETGWRun.exe	StartInfo.FileName = ETGWPath StartInfo.Arguments = "ODMatrix" "Network to Use" "Input Origin Points" "Input Destination Points" "output dataset" "snap tolerance" "Input Barrier Points" "Barriers Direction Field" "Straight Lines Output" "CutOff Cost"
.NET using ETGWOutX.dll	ODMatrix(Network to Use,Input Origin Points,Input Destination Points, output dataset, snap tolerance, Input Barrier Points, Barriers Direction Field, Straight Lines Output,CutOff Cost)
ArcPy	arcpy.ODMatrix(Network to Use,Input Origin Points,Input Destination Points, output dataset, snap tolerance, Input Barrier Points, Barriers Direction Field, Straight Lines Output, CutOff Cost)

Notes:

<> - required parameter
{} - optional parameter
See examples for Python , .NET or ArcPy
The argument separator for StartInfo.Arguments is space. If a string might contain a space, you need to double quote it.

(Go to TOP)