OutputPropertyType.<enum>

OutputProperty types

Description

Class exposing the available Output property types as enums. Output properties are used to mark particular inputs and/or results for inclusion or exclusion in the output. By identifying for each property separately if it is to be included or not, you have maximum flexibility over your generated results. To avoid unnecessary configuration, a reasonable set of default properties is activated on each of the different output types whenever you choose to activate them.

For each output property we keep information on on:

Name: the name of the property
Type: the data type used by result values of this output property
Unit: the unit of the result values
Priority: the priority reflects the column priority (order) as well as its source, 3 levels in descending order of importance exist:
- 0: (ID_PRIORITY), e.g. the output property can be used as an id to uniquely define the entity
- 1: (INPUT_PRIORITY), e.g. the output property is an input, i.e., constant
- 2: (OUTPUT_PRIORITY), e.g., the output property is a result value

Output properties are not always available for all types of output, see the supported by OutputType.<enum> column in the Fields section. Further, it is possible some traffic assignment implementations do not support all link/path/od output properties either.

Fields

Each field has a priority. Since, the priority reflects the location in a result entry - where a higher priority (id, input) ensures the property value is offered earlier than lower priority properties (output) - we provide the available properties categorised by their priority.

For information on what property is supported by what output type (link, od, path, etc.), please refer to the Data Formats Output section, where you will find links to a dedicated page for each of the output types and their supported output properties.

ID_PRIORITY Fields

<enum> Fields	Description	Type	Unit
`DESTINATION_ZONE_ID`	Destination zone id (internal)	`long`	`None`
`DESTINATION_ZONE_XML_ID`	Destination zone XML id (user)	`string`	`None`
`DESTINATION_ZONE_EXTERNAL_ID`	Destination zone external id (user)	`string`	`None`
`DOWNSTREAM_NODE_ID`	Link segment’s downstream node id (internal)	`long`	`None`
`DOWNSTREAM_NODE_XML_ID`	Link segment’s downstream node XML id (user)	`string`	`None`
`DOWNSTREAM_NODE_EXTERNAL_ID`	Link segment’s downstream node external id (user)	`string`	`None`
`ITERATION_INDEX`	Iteration index of simulation	`integer`	`None`
`LINK_SEGMENT_ID`	Link segment id (internal)	`long`	`None`
`LINK_SEGMENT_XML_ID`	Link segment XML id (user)	`string`	`None`
`LINK_SEGMENT_EXTERNAL_ID`	Link segment external id (user)	`string`	`None`
`LINK_SEGMENT_TYPE_ID`	The link segment type’s internal id	`string`	`None`
`LINK_SEGMENT_TYPE_XML_ID`	The link segment type’s XML id	`string`	`None`
`MODE_ID`	Mode id (internal)	`long`	`None`
`MODE_XML_ID`	Mode id XML (user)	`string`	`None`
`MODE_EXTERNAL_ID`	Mode id external (user)	`string`	`None`
`ORIGIN_ZONE_ID`	Origin zone id (internal)	`long`	`None`
`ORIGIN_ZONE_XML_ID`	Origin zone XML id (user)	`string`	`None`
`ORIGIN_ZONE_EXTERNAL_ID`	Origin zone external id (user)	`string`	`None`
`PATH_ID`	Path id (internal)	`long`	`None`
`RUN_ID`	simulation run id	`long`	`None`
`TIME_PERIOD_ID`	time period id (internal)	`long`	`None`
`TIME_PERIOD_XML_ID`	time period XML id (user)	`string`	`None`
`TIME_PERIOD_EXTERNAL_ID`	time period external id (user)	`string`	`None`
`UPSTREAM_NODE_ID`	Link segment’s upstream node id (internal)	`long`	`None`
`UPSTREAM_NODE_XML_ID`	Link segment’s upstream node XML id (user)	`string`	`None`
`UPSTREAM_NODE_EXTERNAL_ID`	Link segment’s upstream node external id (user)	`string`	`None`

INPUT_PRIORITY Fields

<enum> Fields	Description	Type	Unit
`CAPACITY_PER_LANE`	The capacity flow rate for a lane	`float`	`pcu/h(/l)`
`DOWNSTREAM_NODE_LOCATION`	The geographic location of the downstream node (if present)	`string`	`SRS`
`LENGTH`	The length	`float`	`km`
`LINK_SEGMENT_TYPE_NAME`	The link segment type’s name (input)	`string`	`None`
`MAXIMUM_DENSITY`	The maximum density allowed on the link segment	`float`	`pcu/km`
`MAXIMUM_SPEED`	The maximum allowed speed	`float`	`km/h`
`NUMBER_OF_LANES`	The number of lanes	`integer`	`None`
`UPSTREAM_NODE_LOCATION`	The geographic location of the upstream node (if present)	`string`	`SRS`

OUTPUT_PRIORITY Fields

<enum> Fields	Description	Type	Unit
`CALCULATED_SPEED`	The calculate speed	`float`	`km/h`
`COST_TIMES_FLOW`	The cost (per pcu) multiplied with the volume (per hour) on the entity	`float`	`h` (i.e., (h/pcu)*(pcu/1))
`DENSITY`	The density on a link segment	`float`	`pcu/km`
`INFLOW`	The inflow rate	`float`	`pcu/h`
`FLOW`	The flow rate	`float`	`pcu/h`
`OUTFLOW`	The outflow rate	`float`	`pcu/h`
`LINK_SEGMENT_COST`	The link segment’s generalised cost	`float`	`h`
`OD_COST`	The origin-destination’s generalised cost	`float`	`h`
`PATH_STRING`	The path represented in CSV format	`string`	`None`
`VC_RATIO`	The volume to capacity ratio	`float`	`None` (`(pcu/h)/(pcu/h)`)

Example 1

from planit import *

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


# PATH
# add the internal ids for the OD used in PLANit to the path output, in addition to
# the default XML ids 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)

Example 2

from planit import *

# prep
planit_instance = Planit()
planit_instance.project.set(TrafficAssignment.TRADITIONAL_STATIC )


# LINK (activated by default)
# remove geo location from output
planit_instance.project.assignment.link_configuration.remove(OutputProperty.UPSTREAM_NODE_LOCATION)
planit_instance.project.assignment.link_configuration.remove(OutputProperty.DOWNSTREAM_NODE_LOCATION)

# add V/C ratio since this is a static assignment, so we do not need to compute it afterwards by hand 
planit_instance.project.assignment.link_configuration.add(OutputProperty.VC_RATIO)

Compatibility

Source code

Class OutputProperty in enums.py