HistogramPlotter

Results / HistogramPlotter
Block Name: HistogramPlotter

Code File Location: VisualSim/actor/lib/gui/HistogramPlotter

Block Overview

o Plot a histogram using the input data.

o View the plot in real-time or save for future viewing.

Description

The plotter accepts data on the input and plots them as a histogram. The X-axis of the plot is the value and the Y-axis is the number of instances. Every wire connected to this block input is considered a separate dataset and plotted separately. The order of these datasets is the wire number. The input data type is double.

The output plot consists of a set of vertical bars, each representing a histogram bin. The height of the bar is the count of the number of inputs that have been observed that fall within that bin.

Some trial and error must be incorporated to determine the correct binWidth and binOffset. The n-th bin represents values in the range (x - w/2 + o, x + w/2 + o), where w is the value of the binWidth parameter, and o is the value of the binOffset parameter. So for example, if o = w/2, then each bin represents values from nw to (n + 1)w for some integer n. The default offset is 0.5, half the default bin width, which is 1.0.

The block behavior is controlled as follows:

If there is no PlotManager in the model, then the blocks will save or view based on the settings in the block.
If the PlotManager is included in the model, then the Configure Model will create the XML file. The generated index file will list the Displays/Plotters with view/save and base file names.
When the simulation is run with the PlotManager scenario, two updates are performed- the index file contains an unique identifier for the run and a set of outputs are written with the identifier as a suffix to the file names. The unique identifier is a incremental number. The unique run is determined by the matching of the parameter values from the list in the index file.
If the parameter combination already exists, then the file is simply overwritten. If the parameter combination does not exist then the XML is updated with the new number + parameter values. In this case, the file is created and populated.

To understand the usage, view the Histogram Example in the BDE. To determine the right file format, view the File Format demo.

Notes

If there are two many tiny columns in your plot, then increase the size of the binWidth. This will eliminate incorrect results that could affect your decision. If there is only a single column, then make the binWidth smaller. This will provide greater visibility to the operations.

Parameter	Explanation	Type
fillOnWrapup	This (Checkbox) determines whether to fill the plot when wapup is invoked.	-
startingDataset	The index number of the first dataset to start the display. All datasets with number prior to this are not displayed.	string
legend	The legend parameter is a comma-separated list of labels to attach to each dataset. The number of elements in this list should equal the number of input channels, although this is not enforced.	Comma-separated list of strings
ViewPlot or SavePlot	There are four options here- if neither are selected, then no display and no save in file. If both are selected, then plot is shown durig the simulation and also saved to the file at the end of the simulation. The filename is required for saving. If either is selected, then plot is either view only or save only. The values here can be overridden by the PostProcessor. The viewPlot must be unselected for batch mode.	-
fileName	This block accepts a file name as a parameter. There are a number of file path options available for this block. To see the list, view the section on File Paths in the Reference Guide document here. The file name is a concatenation of any number of individual strings and parameters, separated by "+". To view the file path in a demo model, click here.	String as a file path + name
binWidth	The width of the bin of the histogram. This parameter has type double, with default value 1.0.	Double
binOffset	The offset for bins of the histogram. This parameter has type double, with default value 0.5.	Double

Port	Explanation	Type
Input	The input port is a multiport. This means that each port or relation can be connected directly to this port and will be treated as an unique dataset.	Double

Created with the Personal Edition of HelpNDoc: Easy EPub and documentation editor