Difference between revisions of "Component Guide III: Displays and Controls"

From Numerus
Jump to navigation Jump to search
 
(65 intermediate revisions by the same user not shown)
Line 10: Line 10:
;Multi-controls
;Multi-controls
: If multiple instances of a chip is required with each instance having a unique input value, a multi-input control may be used instead of pinning the control and having individual control instances to accommodate all of the chip input. A multi-control is single control with a list containing all of the chips. To set the input for specific chip select that chip from the list and adjust the control accordingly. This approach avoids the clutter of too many input devices and organizes them by function.
: If multiple instances of a chip is required with each instance having a unique input value, a multi-input control may be used instead of pinning the control and having individual control instances to accommodate all of the chip input. A multi-control is single control with a list containing all of the chips. To set the input for specific chip select that chip from the list and adjust the control accordingly. This approach avoids the clutter of too many input devices and organizes them by function.
;Saving Data
: Data may be saved from any displays to a comma- or tab-separated list <ref>Choice of comma or tab is respectively determined by the <tt>.csv</tt> or <tt>.tsv</tt> extension.</ref> File names used for saving data should be specified before the first run using the '''File | Save Data As ...''' menu item. After each run, selecting '''File | Save Data''' causes the data to be saved to the file as specified, with numerical "_xx" sequence number appended to the end of the filename (so that separate runs can be easily saved).


==Line Graph==
==<span id="LineGraph"></span>Line Graph==


[[File: graph.png|400xpx|left]]
[[File: graph.png|400xpx|left]]
A Graph display is used to display results of a simulation. A Graph has the capability to display multiple series / variables simultaneously. You can also compare the results of different simulations on the same graph.
A Line Graph display is used to display results of a simulation over time. A Line Graph has the capability to display multiple series / variables simultaneously. You can also compare the results of different simulations on the same graph.
<br clear="all">
[[File: graphprop.png|360xpx|right]]
===Properties===
*'''Caption'''. This text appears with the graph at runtime.
*'''Items'''. Table showing the items to be graphed. These can include any value-producing element (component or output pin). To add an item click the '''+''' button and either right-click the item or select it from the selection list. To delete one or more items, click the item(s) (using the shift key for multiple selections) and then click the '''-''' button.
*'''X-Axis'''. By default the X-Axis is full time interval of the simulation. An alternate range can be specified by providing low and high endpoints.
*'''Array Input'''. If this is selected, the last entry in the Items table is treated as an array, with each array element treated as a separate data stream. The array dimension must be provided.
*'''Enable Compare'''. If only a single item appears in the Items table this may be selected. If so, each run of the simulation until a reload is executed will produce a separate plot on the graph.
*'''Multiple Axes'''. If selected, the low and high values of each item will separately determine extents for different y-axes. Otherwise only the lo/hi of the first item is used. If axis entries are omitted the graph will re-scale as needed.
*'''Multi Display'''. If the graph is pinned, and Multi Display is selected, streams from all chip instances will appear on a single graph.
*'''Tolerance'''. If Tolerance is greater than 0, it determines the precision of the plot, possibly reducing the number of individual points plotted.<ref>Graph simplification uses the [https://en.wikipedia.org/wiki/Ramer%E2%80%93Douglas%E2%80%93Peucker_algorithm Ramer-Douglas-Peucker algorithm.]</ref>
 
''Note:'' At runtime you may select '''Table View''' to view the data in table form. Switching between graph and table view is not restricted in any way.
 
==<span id="ScatterChart"></span>Scatter Chart==
Each entry in a Scatter Chart uses an ''<x,y>'', input pair to plot a point on the x-y axis.
{|
|[[File: scatter.png | left]]
<br clear="all">
===Properties===
*'''Caption''' and '''Items'''. As in the [[#Line Graph|Line Graph]], only the number of items must be 2.
*'''X/Y Minimum and Maximum'''. Determines the axes intervals. If omitted the graph re-scales as needed.
*'''Dot radius'''. The number of pixels used to render a graph entry.
*'''Connect Dots'''. If selected points will be connected in the sequence in which they appear.
*'''Enable Compare, Pinned, Complete, Continuous etc.''' As in the Line Graph.
|[[File: scatterprops.png]]
|}
 
==<span id="BarChart"></span>Bar Chart==
The bar chart accepts 1 or more inputs (or an array of inputs) and shows the current values of those inputs as a bar graph.
{|
|[[File: barchart.gif | left]]
<br clear="all">
===Properties===
*'''Caption, Items, etc.''' As in [[#Line Graph|Line Graph]].
*'''Y-Axis'''. Endpoints must be provided.
|[[File: barchartprops.png]]
|}
 
==Histogram==
Displays a histogram of data accumulated as the simulation progresses.
{|
|[[File: histo.gif | left]]
<br clear="all">
===Properties===
*'''Y Axis'''. Range for the bar graph displaying the result.
*'''X Range'''. Total range under consideration for inclusion;
*'''Input'''. Component or pin providing data to the histogram.
*'''No. of Bins'''. Coupled with X Range, this determines the extent of each histogram interval. For the example shown, bins are [37, 39), [39, 41), etc.
*'''Complete Plot, etc.''' as in [[#Line Graph|Line Graph]].
''Note:'' X Range and No. of Bins represent initial values only. These can be changed using controls on the runtime canvas.
|[[File: histoprops.png]]
|}


'''Usage:''' To add a Graph to a model, press on the '''Linegraph''' entry in the '''Displays and Controls''' list, and drag onto the canvas. You can have multiple graph objects in one model, and you can have graph objects on different levels of a multi-level model.  
==Table==
A table renders one or more data streams in tabular form.
{|
|[[File: table.png]]
<br clear="all">
<br clear="all">
===Properties===
*'''Display Interval'''. Number of time steps between table entries.
See [[#Line Chart|Line Chart]] for a description of other properties.
|[[File: tableprop.png]]
|}
==Slider==
Sliders can be moved using the mouse or using arrow keys to obtain finer control.
{|
|[[File: slider.png]]
===Properties===
*'''Minimum/Maximum Value'''. Sets the endpoints of the input interval.
*'''Step'''. Determines the interval between potential input values.
*'''Initial Value'''. Sets the input value upon launch. This value can be set using the slider shown in the properties panel.
*'''Unit'''. If included, this appears in the runtime frame.
<br clear="all">
|[[File: sliderprop.png]]
|}
==Spinner==
A spinner can either duplicate the functionality of a slider, as in the first example below, or provide input specified using scientific notation, as in the second.
{|
|[[File: spinner.png]]
<br clear="all">
===Properties===
*'''Mantissa'''. Identical to [[#Slider|Slider]].
*'''Exponent'''. If the base is set to 1, the spinner operates like a slider. Other choices for the base produce runtime spinners for the mantissa and exponent.
|[[File: spinnerprop.png]]
|}
==Toggle==
A toggle is a convenient 0-1 input.
{|
|[[File: toggle.png]]
<br clear="all">
===Properties===
Toggle properties determine initial value and detail labels, background color and text color.
|[[File: toggleprop.png]]
|}
==Notes==

Latest revision as of 17:05, 4 October 2018

Numerus includes several different display and control components for displaying output and specifying input. These include Tables, Line Graphs, Scatter Charts, Bar Graphs and Histograms (display); and Sliders, Spinners and Toggles (control).

Features

Adding a display or control
Find the component in the Displays and Controls list on the left side of the design frame. Press and drag the component onto the design canvas and release the mouse.
Continuous vs. Complete Plot
All displays provide the option of Continuous Plot (data is displayed continuously throughout the simulation) or Complete Plot (data is only displayed at the end of the run). In the case of Continuous Plot, a Plot Frequency is also be specified. The Plot Frequency gives the number of time steps between plots.
Pinning
If a display/control appears in a submodel it is usually not included in the runtime canvas. However, if that submodel is used in a chip and pinning is selected, the component will be appear in the runtime canvas. If a display/control is used in an aggregator it will not be part of the runtime; the alternative is to use input and output pins to connect displays and controls to the aggregator's contents.
Multi-controls
If multiple instances of a chip is required with each instance having a unique input value, a multi-input control may be used instead of pinning the control and having individual control instances to accommodate all of the chip input. A multi-control is single control with a list containing all of the chips. To set the input for specific chip select that chip from the list and adjust the control accordingly. This approach avoids the clutter of too many input devices and organizes them by function.
Saving Data
Data may be saved from any displays to a comma- or tab-separated list [1] File names used for saving data should be specified before the first run using the File | Save Data As ... menu item. After each run, selecting File | Save Data causes the data to be saved to the file as specified, with numerical "_xx" sequence number appended to the end of the filename (so that separate runs can be easily saved).

Line Graph

Graph.png

A Line Graph display is used to display results of a simulation over time. A Line Graph has the capability to display multiple series / variables simultaneously. You can also compare the results of different simulations on the same graph.

Graphprop.png

Properties

  • Caption. This text appears with the graph at runtime.
  • Items. Table showing the items to be graphed. These can include any value-producing element (component or output pin). To add an item click the + button and either right-click the item or select it from the selection list. To delete one or more items, click the item(s) (using the shift key for multiple selections) and then click the - button.
  • X-Axis. By default the X-Axis is full time interval of the simulation. An alternate range can be specified by providing low and high endpoints.
  • Array Input. If this is selected, the last entry in the Items table is treated as an array, with each array element treated as a separate data stream. The array dimension must be provided.
  • Enable Compare. If only a single item appears in the Items table this may be selected. If so, each run of the simulation until a reload is executed will produce a separate plot on the graph.
  • Multiple Axes. If selected, the low and high values of each item will separately determine extents for different y-axes. Otherwise only the lo/hi of the first item is used. If axis entries are omitted the graph will re-scale as needed.
  • Multi Display. If the graph is pinned, and Multi Display is selected, streams from all chip instances will appear on a single graph.
  • Tolerance. If Tolerance is greater than 0, it determines the precision of the plot, possibly reducing the number of individual points plotted.[2]

Note: At runtime you may select Table View to view the data in table form. Switching between graph and table view is not restricted in any way.

Scatter Chart

Each entry in a Scatter Chart uses an <x,y>, input pair to plot a point on the x-y axis.

Scatter.png


Properties

  • Caption and Items. As in the Line Graph, only the number of items must be 2.
  • X/Y Minimum and Maximum. Determines the axes intervals. If omitted the graph re-scales as needed.
  • Dot radius. The number of pixels used to render a graph entry.
  • Connect Dots. If selected points will be connected in the sequence in which they appear.
  • Enable Compare, Pinned, Complete, Continuous etc. As in the Line Graph.
 Scatterprops.png

Bar Chart

The bar chart accepts 1 or more inputs (or an array of inputs) and shows the current values of those inputs as a bar graph.

Barchart.gif


Properties

  • Caption, Items, etc. As in Line Graph.
  • Y-Axis. Endpoints must be provided.
 Barchartprops.png

Histogram

Displays a histogram of data accumulated as the simulation progresses.

Histo.gif


Properties

  • Y Axis. Range for the bar graph displaying the result.
  • X Range. Total range under consideration for inclusion;
  • Input. Component or pin providing data to the histogram.
  • No. of Bins. Coupled with X Range, this determines the extent of each histogram interval. For the example shown, bins are [37, 39), [39, 41), etc.
  • Complete Plot, etc. as in Line Graph.

Note: X Range and No. of Bins represent initial values only. These can be changed using controls on the runtime canvas.

Histoprops.png

Table

A table renders one or more data streams in tabular form.

Table.png


Properties

  • Display Interval. Number of time steps between table entries.

See Line Chart for a description of other properties.

Tableprop.png

Slider

Sliders can be moved using the mouse or using arrow keys to obtain finer control.

Slider.png

Properties

  • Minimum/Maximum Value. Sets the endpoints of the input interval.
  • Step. Determines the interval between potential input values.
  • Initial Value. Sets the input value upon launch. This value can be set using the slider shown in the properties panel.
  • Unit. If included, this appears in the runtime frame.


 Sliderprop.png

Spinner

A spinner can either duplicate the functionality of a slider, as in the first example below, or provide input specified using scientific notation, as in the second.

Spinner.png


Properties

  • Mantissa. Identical to Slider.
  • Exponent. If the base is set to 1, the spinner operates like a slider. Other choices for the base produce runtime spinners for the mantissa and exponent.
 Spinnerprop.png

Toggle

A toggle is a convenient 0-1 input.

Toggle.png


Properties

Toggle properties determine initial value and detail labels, background color and text color.

Toggleprop.png

Notes

  1. ↑ Choice of comma or tab is respectively determined by the .csv or .tsv extension.
  2. ↑ Graph simplification uses the Ramer-Douglas-Peucker algorithm.
Retrieved from "https://wiki.numerusinc.com/index.php?title=Component_Guide_III:_Displays_and_Controls&oldid=1022"