Ribbon Commands
3.3 Assign Ribbon Commands
This section describes the Ribbon Commands of SIDRA ASSIGN, including Ribbon Commands for Assign Setup, Volume Bins and Assign Output Tabs.
3.3.1 Setup Commands
Table 3.3.1 describes the commands available under the Assign Setup Tab. Use the dropdown arrow of commands to access options applicable to the command.
Add Assign Dialog
The Add Assign Network dialog creates a new Assign Network. A Basic Network is a prerequisite to create a new Assign Network. There are four steps in creating an Assign Network.
Step 1 of 4: Select a Network
The selected Network will be cloned, and the clone will be converted to an Assign Network in this step. Click on the Network to select and click Next. Double-clicking on the Network will select the Network and move to the next step. The selected Network is illustrated in the Configuration Pane.
Step 2 of 4: Setup Assign Volume Bin
The Assign Volume Bin will be linked to the Assign Network in this step. This will establish the Zones and the O-D Volumes for the Assign Network. If the Assign Volume Bin already exists, use the Select Existing Bin Option. Select the Bin from the list and click Next. Alternatively, double-clicking on the Bin will select it and move to the next step.
If the Assign Volume Bin has not been created yet, use the Create New Bin Option. Set the Assign Volume Bin Name, Number of Zones and Bin Folder. A Bin ID and Zones will be automatically set for the New Bin, which can be edited after the Assign Network setup has been completed. Click Next to move to the next step.
Table 3.3.1 — Command Buttons in the Assign Setup Tab and their function
| Command | Function |
|---|---|
| Process | Process input data, carry out computations and create output for the Selected Network(s). |
| Network Layout | Display a detailed picture of the physical layout of the Selected Network(s). |
| Assign Layout | Display a detailed picture of the physical layout of the Selected Assign Network(s). |
| Add Assign | Opens the Add Assign Network Wizard for creating a new Assign Network. |
| Modify | Modify the configuration of the Selected Assign Network. |
| Clone | Make a copy of the Selected Network(s) and add to the Project as new Network(s). |
| Convert | Convert the Selected Assign Network(s) to Basic Network(s). |
| Import | Import one or more Networks from another Project File (sipx). |
| Export | Export the selected Network(s) to a new Project File (sipx). |
| New Folder | Create a new folder in the Project Pane |
| Move To | Moves the selected Network to another folder. |
| Move Up/Down | Moves the selected Network up or down the list in the Project Pane. |
| Delete | Deletes the selected Network, Folder or Route. |
| Desire Lines | Displays the Desire Lines for the selected Assign Network(s). |
| Trip Matrix | Reports the Trip Matrix for the selected Assign Network(s). |
| Fixed Routes | Displays the active Fixed Routes for the selected Assign Network(s). |
| G/A Trips | Displays the Trip Generation/Attraction for the selected Assign Network(s). |
| Input Report | Create a Network Input Report for the Selected Network(s). |
Step 3 of 4: Connect Zones
The Zones will be connected to the Assign Network in this step. Zones are listed on the left side of the dialog. Select and drag the Zone from the list into the Configuration Pane. Place the Zone in the correct position relative to the Assign Network.
To connect the Zone, click the grey connection bar at the end of the Site Leg, dragging the green line that appears towards the Zone, and dropping in the grey connection section on the perimeter of the Zone. Alternatively, the connection process can also start with the connection section of the Zone and end at the connection bar at the end of the Site Leg. The connection bar of the Site Leg and the connection section of the Zone will turn green when there is a Zone Connector.
"Auto-Connect Zones" will programmatically connect Zones to the Network.
The Zone can be disconnected by clicking the [x] symbol on the green connection bar at the end of the Site Leg. The Zone can be removed from the Configuration Pane and return to the Zones List by clicking the [x] symbol next to the Zone in the Zones List. Zone Connectors will be deleted when the Zone is removed from the Configuration Pane.
Zones do not need to be connected to the Assign Network to complete the process of creating a new Assign Network. However, processing and Assign Network with unconnected Zones will result in a processing error. Use the Modify Assign function to continue setting up Zones.
Step 4 of 4: Finalise Network
The new Assign Network's Name and ID will be set in this step. Enter the Name and ID and click Finish to create the new Assign Network in the Networks Section of the Project Pane and close the Add Assign Network dialog. The new Assign Network will be in the same Folder as the Basic Network selected in Step 1.
Use the Back button to go back a Step (applies to Steps 2 and 3, as well).
Modify Assign Dialog
Use the Modify Assign dialog to re-arrange Zones and Zone Connectors or to change the Assign Volume Bin linked to the Assign Network. Click on the [x] in the Zones List or on the Configuration Pane to remove Zone Connectors. Click and drag to connect a Zone to up to eight external legs of the Network. Click Select a different Volume Bin to open a dialog to select a new Assign Volume Bin, then connect the Zones of the new Assign Volume Bin. "Auto-Connect Zones" will programmatically connect Zones to the Network.
Convert Function
The Convert Function changes the Assign Network to a Basic Network. There are two options. The first option is to "Convert to Basic Network (Remove Assign Data)" without Assign Flows as Site Volumes. This option will also remove the Assign Data, Assign Scenarios and its link to an Assign Volume Bin, which will delete references to the Zones and its Zone Connectors. For an unprocessed Assign Network, this is the only Convert Function option.
If the Assign Network has been processed successfully, there is another option to "Convert to Basic Network with Assign Flows as Site Volumes". This Convert Function option will also remove any ASSIGN data like the first Convert option and the Movement Flow outputs will be converted to Input Site Volumes.
3.3.2 Assign Output Commands
Table 3.3.2 describes the commands available under the Assign Output Tab. Use the dropdown arrow of commands to access options applicable to the command.
Table 3.3.2 — Command Buttons in the Assign Output Tab and their function
| Command | Function |
|---|---|
| Process | Process input data, carry out computations and create output for the Selected Network(s). |
| Assign Layout | Display a detailed picture of the physical layout of the Selected Assign Network(s). |
| User Report | Create a Network User Report for the Selected Network(s). |
| O-D Presets | Opens a dialog to create O-D Presets. The dialog can also create Output Reports for the O-D Preset. |
| Diagnostics | Create a Diagnostics report for the Selected Network(s). |
| Trip Performance | Report on the Performance of Routes used by Trips for an O-D Preset. |
| Trip Route Displays | Create Displays of performance indicators of Routes used for an O-D Preset. |
| Fixed Route Displays | Create Displays of performance indicators of Routes used for selected Fixed Route(s). |
| Movement Displays | Create Displays of performance indicators of Movements along Routes used for an O-D Preset. |
User Reports
User Reports are reports based on templates prepared by the user. User Report templates are created in the Tools Tab. Refer to the SIDRA INTERSECTION User Guide, Section 11 for preparing User Report Templates. Network User Reports applies to Assign Networks and Basic Networks.
To open a User Report for a selected Assign Network, click the down arrow next to the command name (User Report), select the desired Network User Report Template(s), and click OK. Note that the O-D Presets options are not available for User Reports, i.e. the All O-Ds option will be used for all Assign reports and displays in User Reports.
O-D Presets
An O-D Preset is a set of O-D Pairs used to filter Assign Outputs. Defined and selected O-D Presets are attributes of the Assign Volume Bin. O-D Presets of an Assign Network is also available to any Assign Network that uses the same Assign Volume Bin.
Clicking the O-D Preset button in the Ribbon will open a dialog. On the left-hand side of the dialog is the O-D Presets List. Use the radio button to select an O-D Preset. The Add button will create a new O-D Preset. Double click on the O-D Preset or click on the pencil icon on the List to rename it. The Clone button will create a copy of the selected O-D Preset and the Delete button will erase the O-D Preset. An All O-Ds Preset is available as read only, i.e. could not be edited or deleted but can be cloned and used for creating reports.
There are three view options to select O-D Pairs for the O-D Preset: Layout View, Square Matrix View and Column Matrix View. They are described in the succeeding sections.
O-D Pair Selection in Layout View
Click on the Show Layout View button to select O-D Pairs in layout View. Hover over a Zone in the selector pane to show arrowed lines representing Generated Interzonal Trips, i.e. all O-D Pairs with the Zone as the Origin. The arrowed line starts with the Origin and the points to the Destination. The Zone circle represents Intrazonal Trips. The colour of the line (for interzonal trips) and circle (for intrazonal trips) indicates if the O-D Pair is selected or not: orange = unselected and blue = selected. Click on the line or circle to toggle between being unselected and selected.
Right-click on the Zone to access the following functions:
-
Show Attracted Trips for this Zone shows arrowed lines for O-D Pairs with the hovered Zone as the Destination
-
Show Generated Trips for this Zone, as described above
-
Show All Trips for this Zone shows arrowed lines for all O-D Pairs with the hovered Zone as Origin or Destination
-
Select All Visible Trips for this Zone sets all visible arrowed lines (i.e. O-D Pairs) as selected for the O-D Preset
-
Deselect All Selected Trips for this Zone toggles all selected arrowed lines (i.e. O-D Pairs) as unselected
Use the Hide Interzonal O-D Pairs with Zero Volumes checkbox to manage the number of visible O-D Pairs in the selector pane. Type a Zone Name in the Search feature to find the Zone and highlight its Generated Trips.
O-D Pair Selection in Square Matrix View
Click on the Show Square Matrix View button to select O-D Pairs using a square matrix. The row headers are Origins and the column headers are Destinations. Tick the checkbox to select the O-D Pair for the O-D Preset. Untick to deselect. Double-click the row or column header to toggle the selection state for all O-D Pairs of the Origin or Destination, respectively.
Use the Block O-D Pairs with Zero Volumes checkbox as well as the Origin and Destination Zone filters to manage the number of selectable O-D Pairs in the matrix. Type the Zone Names of an O-D Pair (e.g. Z1 to Z2) in the Search feature to find and highlight a specific O-D Pair.
O-D Pair Selection in Column Matrix View
Click on the Show Column Matrix View button to select O-D Pairs using a column matrix. Tick the checkbox in the Selected Column to select the O-D Pair for the O-D Preset. Untick to deselect.
Use the Hide O-D Pairs with Zero Volumes checkbox as well as the Origin and Destination Zone filters to manage the number of selectable O-D Pairs in the matrix. Type the Zones Names of an O-D Pair (e.g. Z1 to Z2) in the Search feature to find and highlight a specific O-D Pair.
Select Reports for O-D Preset
Click on the Select Reports button to open a dialog to create Assign Output Reports for the selected O-D Preset. Use the slider to set the reports and displays to be created. The dialog allows for creation of the following reports:
-
Diagnostics Report
-
Trip Performance Report
-
Trip Route Displays
-
Fixed Route Displays (all Fixed Routes for the O-D Preset will be included)
-
Movement Display.
Use the report options feature to set the Movement Class and Display Type for each report. Click the "Create Selected Reports" button to save the O-D Presets and to generate the reports.
Trip Performance
The Trip Performance Report creates a table of the performance of Assign and Fixed Routes between O-D Pairs. Use the dropdown menu of the Trip Performance command button to set the O-D Preset and Movement Class.
The Routes are grouped by O-D Pairs in the Report. Routes are labelled in the Report according to the following rules:
-
If the Route has been defined under the Network in the Network Section of the Project Pane, then its user-defined Route ID will be used as its reference in the Report.
-
Otherwise, the Route will be programmatically labelled using the format {Origin Zone ID} -- {Destination Zone ID} {(Route Number)}. The Route Number is a program-generated identifier designated to the Route. The Route Number of a particular route can change when the Assign Network is reprocessed.
Right-click on the Report to open a menu to open the Output to PDF dialog, Select All (i.e. the report) or Select Output Table (note: applies only when right-click is on the table). Use Copy in the right-click menu to copy to clipboard the selected Report or Output Table. Once copied the selected item can be pasted in a document. The right-click menu also includes a checkbox feature to include or exclude specific Output Parameters.
Trip Route Displays
Trip Route Display shows the layout of Assign and Fixed Routes between O-D Pairs. Use the dropdown menu of the Trip Routes Display command button to set the O-D Preset and MC. Use the checkbox to include or exclude Assign and Fixed Routes in the Display. Select the Output Parameter to be shown in the Popups of the Display.
The visible Output Parameters in the dialog are set in the Manage Tab -- Customised Displays Dialog -- Trip Displays Tab. Check or uncheck the parameter to include or exclude from the dropdown list of the Trip Route Displays button.
Click the Open All Popups to open popup labels for all Routes. Click on a point along a Route to open the popup for the Route. If multiple Routes overlap on the point where a Route is clicked, the popups of ALL of Routes that pass through the point will open. Popups can be dragged to change its position.
Route identifiers are set using the same rules as described in the Trip Performance section. Click [x] button on popups to close individual popups. If all popups are open, you can use the Close All Popups to remove all popups from the Display.
A Network Route can be created as a copy of an Assign Route. Right Click on Assign Route and click on Create Network Route from Assign Route. This function is disabled if a Network Route already exists for the Assign Route.
Fixed Route Displays
Fixed Route Display shows the layout of Fixed Routes between O-D Pairs. Use the dropdown menu of the Trip Routes Display command button to select the Fixed Routes and MC to include in the Display. Select the Output Parameter for the Display.
The visible Output Parameters in the dialog are set in the Manage Tab -- Customised Displays Dialog -- Trip Displays Tab. Check or uncheck the parameter to include or exclude from the dropdown list of the Fixed Route Displays button.
Click the Open All Popups to open popup labels for all Routes. Click on a Route to open the popup for the Route. If multiple Routes overlap on the point where a Route is clicked, the popups of ALL Routes will open. Popups can be dragged to change its position. Click [x] button on popups to close individual popups. If all popups are open, you can use the Close All Popups to remove all popups from the Display.
Movement Displays
A Movement Display shows the performance of Movements that are used by Assign and Fixed Trips between O-D Pairs. It is similar to the Network Movement Display. The Movements included in the Display are the Movements along the Trip Routes between the selected O-D Pairs.
It is important to note the Movement Displays accounts for the performance of all Movement Flows which includes all Trips from all O-D Pairs and Initial Volumes, not just the Assign and Fixed Trips for the selected O-D Pairs.
Use the dropdown menu of the Movement Displays command button to set the O-D Preset and Movement Class. Use the checkbox to include or exclude Assign and Fixed Routes in the Display. Select the Output Parameter for the Display.
The visible Output Parameters in the dialog are set in the Manage Tab -- Customised Displays Dialog -- Movement Displays Tab. Check or uncheck the parameter to include or exclude from the dropdown list of the Movement Displays button.
Click the Open All Popups to open popup labels for all Approaches. Click on an Approach value in the Display to open the popup for the Approach to show Movement Values. Popups can be dragged to change its position.
Network, Route, Network Site and Reports/Displays Output Tab for Assign
Outputs for a Basic Network are also available for an Assign Network. The Network and Route Output tab provides the same outputs as Network and Route outputs for a Network Model. Similarly, the Network Site Reports and Displays tab provides outputs for the selected Site.
3.3.3 Assign Volume Bins Commands
Table 3.3.3 describes the commands available under the Volume Store - Assign Volume Bins Tab. Use the dropdown arrow of commands to access options applicable to the command.
Table 3.3.3 — Command Buttons in the Volume Store - Assign Volume Bin Tab and their function
| Command | Function |
|---|---|
| Add Bin | Add a New Assign Volume Bin in the current Assign Volume Bins Folder. |
| Import | Import one or more Assign Volume Bins from another Project file (sipx) as new Bin(s) in the current Project. Decide Destination Folder(s). |
| Clone | Make a copy of the Selected Site Volume Bin(s) and add to the Project as new Bin(s). |
| New Folder | Create a new Volume Bin Folder in the Assign Volume Bins section of the Project pane. |
| Move To | Move the Selected Volume Bin(s) to another Bin Folder. You can Drag and Drop Bins between Folders. |
| Move Up/Down | Move the selected Volume Bin(s) or Bin Folder(s) up the Volume Bin list to reorganise the list. |
| Delete | Delete the selected Volume Bin(s) or Bin Folder(s). Once deleted, these Bins cannot be restored. Deleting a Volume Bin Folder will also delete all Bins in the Folder. |
| O-D Volumes | Creates a Trip Matrix Report of the selected O-D Volume of the selected Volume Bin. |