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

CopyrightCopyright (c) 2012-2015, David Sorokin <david.sorokin@gmail.com>
LicenseBSD3
MaintainerDavid Sorokin <david.sorokin@gmail.com>
Stabilityexperimental
Safe HaskellNone
LanguageHaskell98

Simulation.Aivika.Experiment.Chart.DeviationChartView

Description

Tested with: GHC 7.10.1

The module defines DeviationChartView that plots the deviation chart using rule of 3-sigma.

Synopsis

Documentation

data DeviationChartView Source

Defines the View that plots the deviation chart.

Constructors

DeviationChartView 

Fields

deviationChartTitle :: String

This is a title used in HTML.

deviationChartDescription :: String

This is a description used in HTML.

deviationChartWidth :: Int

The width of the chart.

deviationChartHeight :: Int

The height of the chart.

deviationChartFileName :: ExperimentFilePath

It defines the file name with optional extension for each image to be saved. It may include special variable $TITLE.

An example is

  deviationChartFileName = UniqueFilePath "$TITLE"
deviationChartTransform :: ResultTransform

The transform applied to the results before receiving series.

deviationChartLeftYSeries :: ResultTransform

It defines the series to be plotted basing on the left Y axis.

deviationChartRightYSeries :: ResultTransform

It defines the series to be plotted basing on the right Y axis.

deviationChartPlotTitle :: String

This is a title used in the chart. It may include special variable $TITLE.

An example is

  deviationChartPlotTitle = "$TITLE"
deviationChartPlotLines :: [PlotLines Double Double -> PlotLines Double Double]

Probably, an infinite sequence of plot transformations based on which the plot is constructed for each series. Generally, it may not coincide with a sequence of labels as one label may denote a whole list or an array of data providers.

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

deviationChartPlotFillBetween :: [PlotFillBetween Double Double -> PlotFillBetween Double Double]

Corresponds exactly to deviationChartPlotLines but used for plotting the deviation areas by the rule of 3-sigma, while the former is used for plotting the trends of the random processes.

deviationChartBottomAxis :: LayoutAxis Double -> LayoutAxis Double

A transformation of the bottom axis, after title time is added.

deviationChartLayout :: LayoutLR Double Double Double -> LayoutLR Double Double Double

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

defaultDeviationChartView :: DeviationChartView Source

The default deviation chart view.