aivika-experiment-chart-1.1: Simulation experiments with charting for the Aivika library

Stabilityexperimental
MaintainerDavid Sorokin <david.sorokin@gmail.com>
Safe HaskellNone

Simulation.Aivika.Experiment.Chart.HistogramView

Description

Tested with: GHC 7.6.3

The module defines HistogramView that saves the histogram in the PNG files by all integration time points for each simulation run separately.

Synopsis

Documentation

data HistogramView Source

Defines the View that saves the histogram in the PNG files by all integration time points for each simulation run separately.

Constructors

HistogramView 

Fields

histogramTitle :: String

This is a title used in HTML.

histogramDescription :: String

This is a description used in HTML.

histogramWidth :: Int

The width of the histogram.

histogramHeight :: Int

The height of the histogram.

histogramFileName :: FileName

It defines the file name for each PNG file. It may include special variables $TITLE, $RUN_INDEX and $RUN_COUNT.

An example is

   histogramFileName = UniqueFileName "$TITLE - $RUN_INDEX" ".png"
histogramPredicate :: Event Bool

It specifies the predicate that defines when we count data when plotting the histogram.

histogramBuild :: [[Double]] -> Histogram

Builds a histogram by the specified list of data series.

histogramSeries :: [String]

It contains the labels of data for which the histogram is plotted.

histogramPlotTitle :: String

This is a title used in the histogram when simulating a single run. It may include special variable $TITLE.

An example is

   histogramPlotTitle = "$TITLE"
histogramRunPlotTitle :: String

The run title for the histogram. It is used when simulating multiple runs and it may include special variables $RUN_INDEX, $RUN_COUNT and $PLOT_TITLE.

An example is

   histogramRunPlotTitle = "$PLOT_TITLE / Run $RUN_INDEX of $RUN_COUNT"
histogramPlotBars :: PlotBars Double Double -> PlotBars Double Double

A transformation based on which the plot bar is constructed for the series.

Here you can define a colour or style of the plot bars.

histogramLayout :: Layout Double Double -> Layout Double Double

A transformation of the plot layout, where you can redefine the axes, for example.

defaultHistogramView :: HistogramViewSource

The default histogram view.