Spreadsheet Viewing

Navigation:  User Interface > Canvas >

Spreadsheet Viewing

Previous pageReturn to chapter overviewNext page

Introduction

 

The calculations carried out on a canvas can be viewed in a more traditional spread sheet form using the Spreadsheet Viewer. The spreadsheet view of a canvas calculation can be saved with the container in which the calculation sits, and recalled anytime that calculation is used. Once in spreadsheet form, the interactive elements on the modules that make up the calculation can be edited directly from the spreadsheet, meaning for very fixed calculations, users have the option of carrying out assessments using the spreadsheet only.

 

In addition to being used for spreadsheet viewing, spreadsheet calculations are also those that get printed when printing calculation sheets.

 

Viewing spreadsheets involves first selecting the calculation chains on the canvas you would like to view in spreadsheet form using the 'Spreadsheet Calculation Selector', then opening a spreadsheet viewer to view them. The Spreadsheet Calculation Selector can be opened by either selecting 'Select Spreadsheet Calcs' from the Home tab on the Main Ribbon Bar, or by pressing F2. This opens the following window.

 

Calc Selector

Calc Groups

 

Calc groups allow you to group your calculations in whatever way your project requires. Groups can be added, edited and deleted using the Group Operations buttons on the Ribbon Bar. As mentioned above, the calc spreadsheets are also those that get printed. As such, a Group Print Prefix can also be set for each calc group either when creating it or by editing it, which can be used when printing the calculation sheets to identify specific types of calcs. See the Print Manager for more details.

 

Calculations

 

Once a calc group has been created, calculations can be added to it. There are a number of ways to do this, which are described below.

 

Create a New Calc

 

This is the most basic method of creating a new calculation. Clicking the 'New Calc' button will open the following 'Define Spreadsheet Calculation' dialog box.

 

Calc Details

 

Each calculation consists of a collection of 'start nodes' and 'end nodes'. For example, if you wanted to show a calculation from a noise source to an external receiver, the start node would be the noise levels output node on the noise source, and the end node would be the noise level input node on the external receiver.

 

The simplest way of adding the start and end nodes to the spreadsheet calculation is to use the 'Smart Select' function. Clicking the 'Start' button will hide the 'Define Spreadsheet Calculation' window to show the canvas, and will allow you to select the nodes that form the calculation. The background of the canvas will also go dark gray to indicate that node selection is in progress, and a 'Select Nodes' dialog box will open to allow you to tell the programme that you have finished adding the nodes.

 

As nodes are added to the calculation, the resulting chain between the nodes will be highlighted to show the selected calc, as shown in the following image.

 

Node Sel - Smart 

 

While using Smart Select, output nodes will be assumed to be start nodes, and input nodes will be assumed to be end nodes. Nodes that have already been added can be removed by clicking on them again. Once all the nodes that are required have been added, clicking 'Done' on the 'Select Nodes' dialog box will bring back the 'Define Spreadsheet Calculation' dialog box.

 

Start or End nodes can also be added by clicking the 'Select Nodes' buttons, and going through the process described above to select the nodes you want. The calculation chains will not be highlighted, instead just the other Start or End nodes. Start nodes must always be output nodes, however End nodes can be either input or output nodes. Having an output node as an End node may be useful when, for example, you want to include the total noise levels and criteria in a spreadsheet at an external receiver, rather that just the contribution from a specific noise source. In this case, you would want the End nodes of the calculation to be the two output nodes on the External Receiver, rather than the input node. As mentioned above, input nodes are assumed to be End nodes while using Smart Select, however using the individual select function output nodes can be added as End nodes.

 

Nodes that are added to the calculation will appear in the Start Node or End Node lists. Where there are multiple start or end nodes, the order they will be presented on the calculation spreadsheet will depend on the order they appear in the 'Define Spreadsheet Calculation' dialog box. Their order can be rearranged by dragging the node in the list of nodes, and dropping it in the desired location.

 

When nodes are added, a default calculation name is assigned to the calculation. For calculations that have data components (e.g. noise source, external receiver etc.) at either end of the calculation chain, the selected data component will be used to form the name. For example, a calculation chain from noise source 'AHU-01' to external receiver 'AP1' will be given the default name 'AHU-01 to AP1'. If the chain does not have a data component at an end, the default name will be made up using the module labels at the start or end of the chain. The default name can be overridden by clicking the 'Override Default Name' check box, at which point the Calc Name text box will become editable, allowing the user to enter whatever name they desire.

 

The Calc Group in which the calculation is located can also be changed from the 'Define Calculation Spreadsheet' dialog box by choosing a different group from the combo box.

 

Add All Calcs on Canvas

 

Clicking the 'Add All Calcs on Canvas' button on the ribbon bar of the Spreadsheet Calculation Selector will add a new calculation chain from and to each start and end module on the canvas. For example, if the canvas has 1 noise source splitting off to 4 external receivers, 4 new calculations will be added to the selected group from the noise source to each of the external receivers in turn.

 

Select Specific Calcs

 

Clicking the 'Select Specific Calcs' button will bring up the node selector in the same way as using the Smart Select method of defining specific calcs. However, when multiple start or end nodes are selected, a new calculation will be made for each chain. For example, if the output node from a noise source is selected, along with the input nodes on 2 external receivers before 'Done' on the 'Select Nodes' dialog box is pressed, 2 new calcs will be created, one from the noise source to each of the external receivers.

 

Spreadsheet Calculation Selector

 

Once a calculation is added, it will appear in the Spreadsheet Calculation Selector. Clicking the different calculations in this window will also highlight them on the canvas to make identification of the different calcs easier.

 

The calc groups or individual calcs can be made inactive by checking or un-checking the 'Active' check boxes. Calcs or groups of calcs that are set to inactive will not appear when a Spreadsheet viewer is opened. Also, when a calculation sheet template in the Print Manager is selected, calc groups or individual calcs that are set to inactive will also be set not to print. These can still be selected to print however by using the check boxes in the Print Manager.

 

The order in which calc groups or individual calcs are presented in the spreadsheet viewer and when printing is dependent on their order in the list in the Spreadsheet Calculation Selector. These can be rearranged as desired by dragging and dropping the group or calc to the desired location.

 

The Spreadsheet Viewer

 

Once the required calculations have been defined using the process outlined above, they can be viewed in spreadsheet form by opening a new spreadsheet viewer (either clicking on 'View Spreadsheet Calcs' on the Home tab of the main ribbon bar, or by pressing F3). The following image shows the spreadsheet version of the calculation chain shown previously.

 

Spreadsheet Viewer

 

As can be seen from the above figure, when using the spreadsheet viewer, the interactive elements on the front of modules that form the calculation chain are also presented, allowing the specifics of the calculation to be modified through the spreadsheet viewer. The spreadsheet viewer has various options on the ribbon bar at the top. these are discussed below.

 

Calculation Group Selector

 

By default, when a spreadsheet viewer is opened, 'All Active Groups' will be selected on the combo box on the ribbon bar. This means that all calcs from all groups that are set to 'Active' in the Spreadsheet Calculation Selector will be shown. Selecting a specific calculation group from the combo box will show only the calcs associated with the selected group.

 

Viewing Options

 

The viewing options section of the ribbon bar contains options that will modify how the settings of the entire spreadfshhet (e.g. the number of decimal places, whether the interactive elements are visible etc.). These are as follows:

 

Increase/Decrease Decimal Places - this will change the number of decimal places shown on the entire spreadsheet.

Third Octave - this will show the third octave bands used in the project, instead of the octave bands. If third-octave bands are not set to visible but you have third octave band data in the calculation chain, this will be shown across three rows, with the centre frequency in the centre row, and the adjacent third octave bands above and below.

Primary Connections - Selecting this will show the input connections on each of the modules shown in the spreadsheet providing they are included in the calculation chain.

Secondary Connections - Selecting this will show the input connections on each of the modules shown in the spreadsheet that are not included in the calculation chain.

Interactive Elements - Selecting this (selected by default) will show the interactive elements on any modules included in the calculation chain. Deselecting this will remove them.

Sub-Total - Selecting this will show the sub-total value for each module in the calculation chain at the output nodes, providing the calculation chain uses that output node.

Difference -  Selecting this will show the difference between any input nodes and output nodes used in the calculation, i.e. it will show the difference to the noise levels passing through that module has made.

Common Reference - see Presenting Parallel Calculations below.

Common Colour - see Presenting Parallel Calculations below.

 

Highlight Chain

 

Selecting 'Highlight Chain' will make the calculation chain on the canvas represented by the current spreadsheet glow to assist with identification.

 

Copy to Clipboard

 

Clicking the 'Copy to Clipboard' button will copy the contents of your calculation spread sheet to the clipboard to allow you to paste these into a spread sheet programme, for example.

 

Export to Spreadsheet

 

Clicking 'Export to Spreadsheet' will create a .xlsx file containing all active calcs in every active calc group in the entire project. A 'Save As' dialog box will open to allow you to specificy where the spreadsheet should be saved.

 

Presenting Parallel Calculations

 

As calculations can have multiple start and/or end nodes, parts of the calculation chain can run in parallel. To present the calculation chain in series (i.e. as one continuous spreadsheet), Sound Design identifies common points where the chain either divides or combines, and presents the parts of the calculations to and from these points as separate sections. To illustrate this, the following chain is used, where the calculation chain contains one combining section and a dividing section as shown in the following image.

 

Parallel CalcsPNG

 

The following image shows the spreadsheet representation of the above calc chain.

 

Parallel Calcs Spreadsheet

 

As the above figure shows, the values at the points at which the chain initially combines through the arithmetic subtract component are indicated using 'Row A' and 'Row B', which are also colour-coded. These are then shown as inputs to the Arithmetic Subtract component, and identified as 'From Row A' and 'From Row B', and also use the same colour coding. From here the chain continues as one until it reaches the output of the 10 log(S) container. At this point the value is designated as 'Row C', which is then shown as an input 'From Row C' into the components at the start of the two remaining chain sections which are taken to their respective External Receiver endings.

 

Both the Common References ('Row A', 'From Row A') and Common Colours are used to identify parts where the calculation chain is cut and continued, which allows the parallel calcs to be presented in series. These Common References and Colours (which are active by default) can be turned-off however by deselecting the relevant buttons on the ribbon bar.

 

The colours used as the Common Colours can be changed in the 'Colours' dialog box activated from the Home Tab of the Main Ribbon Bar. The common colours do not print on calcualtion sheets however, and only the common reference will if selected.

 

Expanding the Containers

 

By default, only calculations at the canvas level of the selected start and end nodes are shown. Where containers are used on the canvas, calculations within these can be shown by clicking on the '+' icon beside the name of the container. Once clicked, calculation that are directly in-line with the calculation chain will be shown.

 

Module Options

 

In addition to the global spreadsheet settings (e.g. show Interactive Elements, Show Primary Connections etc.) these can also be specified for each module. This is done by clicking on the module name, which will bring up the options menu for that module as illustrated below.

SS Mod Adorner

 

In addition to modifying the different parts of the modules that are displayed, the number of decimal places along with the same single figures available on the canvas node values can also be shown by clicking on the desired line on the spreadsheet, and modifying its options as illustrated below.

 

SS Mod SF Adorner

Changes made to the display options in the spreadsheet viewer are saved with each calculation. As such, once these are made, they will be permanent.

 

In addition, calculation spreadsheets made for chains in which the entire chain is located inside a container are saved along with the container if desired. The option not to include the spreadsheets with the container will be presented when saving the container to a toolbox. The spreadsheets are then automatically added to the project when the container is added to the canvas.