OD Output Configuration

Origin-Destination (OD) Output Configuration implementation

Description

The Origin-Destination (OD) output configuration allows you to configure options regarding the OD outputs of your traffic assignment run.

OD information is stored by Mode, Time Period, and Iteration, where the user can configure what information is persisted for each OD 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 OD remains in place. Currently, this requires including (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`	activated	`OutputProperties.<enum>`	`None`
`OutputProperty.TIME_PERIOD_EXTERNAL_ID`	activated	`OutputProperties.<enum>`	`None`
`OutputProperty.MODE_EXTERNAL_ID`	activated	`OutputProperties.<enum>`	`None`
`OutputProperty.ORIGIN_ZONE_EXTERNAL_ID`	activated	`OutputProperties.<enum>`	`None`
`OutputProperty.DESTINATION_ZONE_EXTERNAL_ID`	activated	`OutputProperties.<enum>`	`None`

OUTPUT_PRIORITY fields

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

Methods

OD output configuration exposes the following methods.

Name	Description
`.add(+)`	Add an output property to the be included in each OD’s output entry
`.remove(+)`	Exclude an output property from each OD’s output entry
`.remove_all_properties()`	Exclude all output properties from each OD’s output entry

To support skims you can also activate and de-activate sub-output types. This feature is currently not implemented correctly, and therefore should not be used. The two methods below are only provided for completeness. As it is, only the cost-skim is available and it is activated by default when OD outputs are active.

Name	Description
`.activate(+)`	Activate a sub-output type, i.e., OD skim result (UNSUPPORTED)
`.deactivate(+)`	Deactivate a sub-output type, i.e., OD skim result (UNSUPPORTED)

Properties

OD output configuration does not expose properties (yet)

Example 1

from planit import *

# prep
planit_instance = PLANit()
planit_instance.set(TrafficAssignment.TRADITIONAL_STATIC )

# this will activate the OD cost skim
planit_instance.assignment.activate_output(OutputType.OD)

Identification

Each OD is by default identified by

OutputProperty.ORIGIN_ZONE_EXTERNAL_ID, and
OutputProperty.DESTINATION_ZONE_EXTERNAL_ID

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

OutputProperty.ORIGIN_ZONE_ID, and
OutputProperty.DESTINATION_ZONE_ID

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