Path Output Configuration

Path Output Configuration implementation

Description

The path output configuration allows you to configure options regarding the path outputs of your traffic assignment run.

Path information is stored by Mode, Time Period, and Iteration, where the user can configure what information is persisted for each path under each available combination of these labels.

If you decide to add and remove output properties, ensure that at least one method of unique identification for the path remains in place. Currently, this requires including internal/XML/external ids of the related origin-destination zone. If not, the assignment will fail.

Defaults

ID_PRIORITY fields

Name	Value	Type	Unit
`OutputProperty.RUN_ID`	deactivated	`OutputProperties.<enum>`	`None`
`OutputProperty.TIME_PERIOD_XML_ID`	activated	`OutputProperties.<enum>`	`None`
`OutputProperty.TIME_PERIOD_EXTERNAL_ID`	deactivated	`OutputProperties.<enum>`	`None`
`OutputProperty.MODE_XML_ID`	activated	`OutputProperties.<enum>`	`None`
`OutputProperty.MODE_EXTERNAL_ID`	deactivated	`OutputProperties.<enum>`	`None`
`OutputProperty.ORIGIN_ZONE_XML_ID`	activated	`OutputProperties.<enum>`	`None`
`OutputProperty.ORIGIN_ZONE_EXTERNAL_ID`	deactivated	`OutputProperties.<enum>`	`None`
`OutputProperty.DESTINATION_ZONE_XML_ID`	activated	`OutputProperties.<enum>`	`None`
`OutputProperty.DESTINATION_ZONE_EXTERNAL_ID`	deactivated	`OutputProperties.<enum>`	`None`
`OutputProperty.DESTINATION_ZONE_XML_ID`	activated	`OutputProperties.<enum>`	`None`
`OutputProperty.DESTINATION_ZONE_EXTERNAL_ID`	deactivated	`OutputProperties.<enum>`	`None`

OUTPUT_PRIORITY fields

Name	Value	Type	Unit
`OutputProperty.PATH_STRING`	activated	`OutputProperties.<enum>`	`None`

Path output representation fields

Name	Value	Type	Unit
`PathIdType.LINK_SEGMENT_ID`	deactivated	`PathIdType.<enum>`	`None`
`PathIdType.LINK_SEGMENT_XML_ID`	activated	`PathIdType.<enum>`	`None`
`PathIdType.LINK_SEGMENT_EXTERNAL_ID`	deactivated	`PathIdType.<enum>`	`None`

Methods

Path output configuration exposes the following methods.

Name	Description
`.add(+)`	Add an output property to the be included in each path’s output entry
`.remove(+)`	Exclude an output property from each path’s output entry
`.remove_all_properties()`	Exclude all output properties from each path’s output entry
`.override_output_property_units(+)`	Override the units used for the output property in the results
`.set_path_id_type(+)`	Choose what id’s to use in the path (string) representation
`.get_path_id_type()`	Find out what id type is used for the paths (MISSING METHOD)

Properties

Path output configuration does not expose properties (yet)

Example 1

from planit import *

# prep
planit_instance = Planit()
planit_instance.project.set(TrafficAssignment.TRADITIONAL_STATIC )
planit_instance.project.assignment.activate_output(OutputType.PATH)


# add the internal ids for the OD used in PLANit to the path output, in addition to the default xml ids available from the input files.
planit_instance.project.assignment.path_configuration.add(OutputProperty.ORIGIN_ZONE_ID)
planit_instance.project.assignment.path_configuration.add(OutputProperty.DESTINATION_ZONE_ID)

# switch the path identification from LINK_SEGMENT_XML_ID (default) to NODE_XML_ID 
planit_instance.project.assignment.path_configuration.set_path_id_type(PathIdType.NODE_XML_ID)

Identification

Each path (in addition to its path identifier) is by default identified by

OutputProperty.ORIGIN_ZONE_XML_ID, and
OutputProperty.DESTINATION_ZONE_XML_ID

Alternatively, the user can reconfigure this to using .add(+) and .remove(+) to

OutputProperty.ORIGIN_ZONE_ID, OutputProperty.DESTINATION_ZONE_ID
OutputProperty.ORIGIN_ZONE_EXTERNAL_ID, OutputProperty.DESTINATION_ZONE_EXTERNAL_ID

Currently, no other identification methods are supported. So, make sure the properties of one of the two approaches are included in your configuration