module Simulation.Aivika.Experiment.DeviationChartView
(DeviationChartView(..),
defaultDeviationChartView) where
import Control.Monad
import Control.Monad.Trans
import Control.Concurrent.MVar
import qualified Data.Map as M
import Data.IORef
import Data.Maybe
import Data.Either
import Data.Array
import Data.Array.IO.Safe
import Data.Accessor
import System.IO
import System.FilePath
import Graphics.Rendering.Chart
import Simulation.Aivika.Experiment
import Simulation.Aivika.Experiment.HtmlWriter
import Simulation.Aivika.Experiment.Utils (divideBy, replace)
import Simulation.Aivika.Experiment.Chart (colourisePlotLines, colourisePlotFillBetween)
import Simulation.Aivika.Experiment.SamplingStatsSource
import Simulation.Aivika.Dynamics
import Simulation.Aivika.Dynamics.Simulation
import Simulation.Aivika.Dynamics.Signal
import Simulation.Aivika.Dynamics.EventQueue
import Simulation.Aivika.Dynamics.Base (starttime, integIterationBnds, integTimes, integIteration)
import Simulation.Aivika.Statistics
data DeviationChartView =
DeviationChartView { deviationChartTitle :: String,
deviationChartDescription :: String,
deviationChartWidth :: Int,
deviationChartHeight :: Int,
deviationChartFileName :: FileName,
deviationChartSeries :: [Either String String],
deviationChartPlotTitle :: String,
deviationChartPlotLines :: [PlotLines Double Double ->
PlotLines Double Double],
deviationChartPlotFillBetween :: [PlotFillBetween Double Double ->
PlotFillBetween Double Double],
deviationChartBottomAxis :: LayoutAxis Double ->
LayoutAxis Double,
deviationChartLayout :: Layout1 Double Double ->
Layout1 Double Double
}
defaultDeviationChartView :: DeviationChartView
defaultDeviationChartView =
DeviationChartView { deviationChartTitle = "Deviation Chart",
deviationChartDescription = "It shows the Deviation chart by rule 3-sigma.",
deviationChartWidth = 640,
deviationChartHeight = 480,
deviationChartFileName = UniqueFileName "$TITLE" ".png",
deviationChartSeries = [],
deviationChartPlotTitle = "$TITLE",
deviationChartPlotLines = colourisePlotLines,
deviationChartPlotFillBetween = colourisePlotFillBetween,
deviationChartBottomAxis = id,
deviationChartLayout = id }
instance View DeviationChartView where
outputView v =
let reporter exp dir =
do st <- newDeviationChart v exp dir
return Reporter { reporterInitialise = return (),
reporterFinalise = finaliseDeviationChart st,
reporterSimulate = simulateDeviationChart st,
reporterTOCHtml = deviationChartTOCHtml st,
reporterHtml = deviationChartHtml st }
in Generator { generateReporter = reporter }
data DeviationChartViewState =
DeviationChartViewState { deviationChartView :: DeviationChartView,
deviationChartExperiment :: Experiment,
deviationChartDir :: FilePath,
deviationChartFile :: IORef (Maybe FilePath),
deviationChartLock :: MVar (),
deviationChartResults :: IORef (Maybe DeviationChartResults) }
data DeviationChartResults =
DeviationChartResults { deviationChartTimes :: IOArray Int Double,
deviationChartNames :: [Either String String],
deviationChartStats :: [IOArray Int (SamplingStats Double)] }
newDeviationChart :: DeviationChartView -> Experiment -> FilePath -> IO DeviationChartViewState
newDeviationChart view exp dir =
do f <- newIORef Nothing
l <- newMVar ()
r <- newIORef Nothing
return DeviationChartViewState { deviationChartView = view,
deviationChartExperiment = exp,
deviationChartDir = dir,
deviationChartFile = f,
deviationChartLock = l,
deviationChartResults = r }
newDeviationChartResults :: [Either String String] -> Experiment -> IO DeviationChartResults
newDeviationChartResults names exp =
do let specs = experimentSpecs exp
bnds = integIterationBnds specs
times <- liftIO $ newListArray bnds (integTimes specs)
stats <- forM names $ \_ ->
liftIO $ newArray bnds emptySamplingStats
return DeviationChartResults { deviationChartTimes = times,
deviationChartNames = names,
deviationChartStats = stats }
simulateDeviationChart :: DeviationChartViewState -> ExperimentData -> Dynamics (Dynamics ())
simulateDeviationChart st expdata =
do let protolabels = deviationChartSeries $ deviationChartView st
protoproviders = flip map protolabels $ \protolabel ->
case protolabel of
Left label -> map Left $ experimentSeriesProviders expdata [label]
Right label -> map Right $ experimentSeriesProviders expdata [label]
joinedproviders = join protoproviders
providers = flip map joinedproviders $ either id id
input =
flip map providers $ \provider ->
case providerToDoubleStatsSource provider of
Nothing -> error $
"Cannot represent series " ++
providerName provider ++
" as a series of double values: simulateDeviationChart"
Just input -> samplingStatsSourceData input
names = flip map joinedproviders $ \protoprovider ->
case protoprovider of
Left provider -> Left $ providerName provider
Right provider -> Right $ providerName provider
exp = deviationChartExperiment st
lock = deviationChartLock st
results <- liftIO $ readIORef (deviationChartResults st)
case results of
Nothing ->
liftIO $
do results <- newDeviationChartResults names exp
writeIORef (deviationChartResults st) $ Just results
Just results ->
when (names /= deviationChartNames results) $
error "Series with different names are returned for different runs: simulateDeviationChart"
results <- liftIO $ fmap fromJust $ readIORef (deviationChartResults st)
let stats = deviationChartStats results
t0 <- starttime
enqueue (experimentQueue expdata) t0 $
do let h = experimentSignalInIntegTimes expdata
handleSignal_ h $ \_ ->
do xs <- sequence input
i <- integIteration
liftIO $ withMVar lock $ \() ->
forM_ (zip xs stats) $ \(x, stats) ->
do y <- readArray stats i
let y' = addDataToSamplingStats x y
y' `seq` writeArray stats i y'
return $ return ()
finaliseDeviationChart :: DeviationChartViewState -> IO ()
finaliseDeviationChart st =
do let title = deviationChartTitle $ deviationChartView st
plotTitle =
replace "$TITLE" title
(deviationChartPlotTitle $ deviationChartView st)
width = deviationChartWidth $ deviationChartView st
height = deviationChartHeight $ deviationChartView st
plotLines = deviationChartPlotLines $ deviationChartView st
plotFillBetween = deviationChartPlotFillBetween $ deviationChartView st
plotBottomAxis = deviationChartBottomAxis $ deviationChartView st
plotLayout = deviationChartLayout $ deviationChartView st
results <- readIORef $ deviationChartResults st
case results of
Nothing -> return ()
Just results ->
do let times = deviationChartTimes results
names = deviationChartNames results
stats = deviationChartStats results
ps1 <- forM (zip3 names stats plotLines) $ \(name, stats, plotLines) ->
do xs <- getAssocs stats
zs <- forM xs $ \(i, stats) ->
do t <- readArray times i
return (t, samplingStatsMean stats)
let p = toPlot $
plotLines $
plot_lines_values ^= filterPlotLinesValues zs $
plot_lines_title ^= either id id name $
defaultPlotLines
case name of
Left _ -> return $ Left p
Right _ -> return $ Right p
ps2 <- forM (zip3 names stats plotFillBetween) $ \(name, stats, plotFillBetween) ->
do xs <- getAssocs stats
zs <- forM xs $ \(i, stats) ->
do t <- readArray times i
let mu = samplingStatsMean stats
sigma = samplingStatsDeviation stats
return (t, (mu 3 * sigma, mu + 3 * sigma))
let p = toPlot $
plotFillBetween $
plot_fillbetween_values ^= filterPlotFillBetweenValues zs $
plot_fillbetween_title ^= either id id name $
defaultPlotFillBetween
case name of
Left _ -> return $ Left p
Right _ -> return $ Right p
let ps = join $ flip map (zip ps1 ps2) $ \(p1, p2) -> [p2, p1]
axis = plotBottomAxis $
laxis_title ^= "time" $
defaultLayoutAxis
chart = plotLayout $
layout1_bottom_axis ^= axis $
layout1_title ^= plotTitle $
layout1_plots ^= ps $
defaultLayout1
file <- resolveFileName
(Just $ deviationChartDir st)
(deviationChartFileName $ deviationChartView st) $
M.fromList [("$TITLE", title)]
renderableToPNGFile (toRenderable chart) width height file
when (experimentVerbose $ deviationChartExperiment st) $
putStr "Generated file " >> putStrLn file
writeIORef (deviationChartFile st) $ Just file
filterPlotLinesValues :: [(Double, Double)] -> [[(Double, Double)]]
filterPlotLinesValues =
filter (not . null) .
divideBy (\(t, x) -> isNaN x || isInfinite x)
filterPlotFillBetweenValues :: [(Double, (Double, Double))] -> [(Double, (Double, Double))]
filterPlotFillBetweenValues =
filter $ \(t, (x1, x2)) -> not $ isNaN x1 || isInfinite x1 || isNaN x2 || isInfinite x2
deviationChartHtml :: DeviationChartViewState -> Int -> HtmlWriter ()
deviationChartHtml st index =
do header st index
file <- liftIO $ readIORef (deviationChartFile st)
case file of
Nothing -> return ()
Just f ->
writeHtmlParagraph $
writeHtmlImage (makeRelative (deviationChartDir st) f)
header :: DeviationChartViewState -> Int -> HtmlWriter ()
header st index =
do writeHtmlHeader3WithId ("id" ++ show index) $
writeHtmlText (deviationChartTitle $ deviationChartView st)
let description = deviationChartDescription $ deviationChartView st
unless (null description) $
writeHtmlParagraph $
writeHtmlText description
deviationChartTOCHtml :: DeviationChartViewState -> Int -> HtmlWriter ()
deviationChartTOCHtml st index =
writeHtmlListItem $
writeHtmlLink ("#id" ++ show index) $
writeHtmlText (deviationChartTitle $ deviationChartView st)