More interesting plots, images, grids, quiver

Author: abarbu

matplotlib.cabal

@@ -48,6 +48,7 @@ test-suite matplotlib-test
                      , random
                      , raw-strings-qq
                      , split
+                     , ad
   ghc-options:         -threaded -rtsopts -with-rtsopts=-N
   default-language:    Haskell2010
 

src/Graphics/Matplotlib.hs

@@ -57,13 +57,14 @@
 -- in "ax". Plotting commands should use the current axis, never the plot
 -- itself; the two APIs are almost identical. When creating low-level bindings
 -- one must remember to call "plot.sci" to set the current image when plotting a
--- graph. The current spine of the axes that's being manipulated is in "spine".
+-- graph. The current spine of the axes that's being manipulated is in
+-- "spine". The current quiver is in "q"
 -----------------------------------------------------------------------------
 
 module Graphics.Matplotlib
   ( module Graphics.Matplotlib
     -- * Creating custom plots and applying options
-  , Matplotlib(), Option(),(@@), (%), o1, o2, (##), (#), mp, def, readData
+  , Matplotlib(), Option(),(@@), (%), o1, o2, (##), (#), mp, def, readData, readImage
   , str, raw, lit, updateAxes, updateFigure, mapLinear)
 where
 import Data.List
@@ -89,6 +90,7 @@ file filename m = withMplot m (\s -> python $ pyIncludes (pyBackend "agg") ++ s
 -- | Plot the cross-correlation and autocorrelation of several variables. TODO Due to
 -- a limitation in the options mechanism this takes explicit options.
 xacorr xs ys opts = readData (xs, ys)
+  % figure
   % addSubplot 2 1 1
   % xcorr xs ys @@ opts
   % grid True
@@ -111,6 +113,11 @@ scatter :: (ToJSON t1, ToJSON t) => t1 -> t -> Matplotlib
 scatter x y = readData (x, y)
   % mp # "plot.sci(ax.scatter(data[0], data[1]" ## "))"
 
+-- | Create a bar at a position with a height
+bar :: (ToJSON t1, ToJSON t) => t1 -> t -> Matplotlib
+bar left height = readData (left, height)
+  % mp # "ax.bar(data[0], data[1]" ## ")"
+
 -- | Plot a line
 line :: (ToJSON t1, ToJSON t) => t1 -> t -> Matplotlib
 line x y = plot x y `def` [o1 "-"]
@@ -171,11 +178,29 @@ matShow :: ToJSON a => a -> Matplotlib
 matShow d = readData d
             % (mp # "plot.sci(ax.matshow(data" ## "))")
 
+-- | Plot an image
+imshow :: MplotImage a => a -> Matplotlib
+imshow i = readImage i
+            % (mp # "plot.sci(ax.imshow(img" ## "))")
+
 -- | Plot a matrix
 pcolor :: ToJSON a => a -> Matplotlib
 pcolor d = readData d
             % (mp # "plot.sci(ax.pcolor(np.array(data)" ## "))")
 
+-- | Plot a matrix
+pcolor3 x y z = readData (x,y,z)
+                % (mp # "plot.sci(ax.pcolor(np.array(data[0]),np.array(data[1]),np.array(data[2])" ## "))")
+
+-- | Create a non-uniform image from samples
+nonUniformImage x y z = readData (x,y,z)
+  % mp # "im = mpimg.NonUniformImage(ax" ## ")"
+  % mp # "im.set_data(data[0], data[1], data[2])"
+
+-- | Create a pie chart
+pie l = readData l
+  % mp # "plot.pie(" # l ## ")"
+
 -- | Plot a KDE of the given functions; a good bandwith will be chosen automatically
 density :: [Double] -> Maybe (Double, Double) -> Matplotlib
 density l maybeStartEnd =
@@ -186,6 +211,9 @@ density l maybeStartEnd =
 
 -- * Matplotlib configuration
 
+-- | Set an rc parameter
+rc s = mp # "plot.rc(" # str s ## ")"
+
 -- | Set an rcParams key-value
 setParameter k v = mp # "matplotlib.rcParams["# str k #"] = " # v
 
@@ -207,6 +235,9 @@ dataPlot a b = mp # "p = ax.plot(data[" # a # "], data[" # b # "]" ## ")"
 plot :: (ToJSON t, ToJSON t1) => t1 -> t -> Matplotlib
 plot x y = readData (x, y) % dataPlot 0 1
 
+streamplot x y u v = readData (x, y, u, v)
+  % mp # "ax.streamplot(np.asarray(data[0]), np.asarray(data[1]), np.asarray(data[2]), np.asarray(data[3])" ## ")"
+
 -- | Plot x against y where x is a date.
 --   xunit is something like 'weeks', yearStart, monthStart, dayStart are an offset to x.
 -- TODO This isn't general enough; it's missing some settings about the format. The call is also a mess.
@@ -310,11 +341,24 @@ xcorr x y = readData (x, y) % mp # "ax.xcorr(data[0], data[1]" ## ")"
 -- | Plot auto-correlation
 acorr x = readData x % mp # "ax.acorr(data" ## ")"
 
+-- | A quiver plot; color is optional and can be nothing
+quiver x y u v Nothing = readData(x,y,u,v)
+  % mp # "q = ax.quiver(data[0], data[1], data[2], data[3]" ## ")"
+quiver x y u v (Just c) = readData(x,y,u,v,c)
+  % mp # "q = ax.quiver(data[0], data[1], data[2], data[3], data[4]" ## ")"
+
+-- | A key of a given size with a label for a quiver plot
+quiverKey x y u label = mp # "ax.quiverkey(q, "#x#", "#y#", "#u#", "#label##")"
+
 -- | Plot text at a specified location
 text x y s = mp # "ax.text(" # x # "," # y # "," # raw s ## ")"
 
+-- | Add a text to a figure instead of a particular plot
 figText x y s = mp # "plot.figtext(" # x # "," # y # "," # raw s ## ")"
 
+-- | Add an annotation
+annotate s = mp # "ax.annotate(" # str s ## ")"
+
 -- * Layout, axes, and legends
 
 -- | Square up the aspect ratio of a plot.
@@ -386,16 +430,16 @@ axis3DLabels xs ys zs =
   % mp # "ax.set_zlim3d(" # minimum2 zs # ", " # maximum2 zs # ")"
 
 -- | Add a label to the x axis
-xLabel :: String -> Matplotlib
-xLabel label = mp # "ax.set_xlabel(" # raw label ## ")"
+xlabel :: String -> Matplotlib
+xlabel label = mp # "ax.set_xlabel(" # raw label ## ")"
 
 -- | Add a label to the y axis
-yLabel :: String -> Matplotlib
-yLabel label = mp # "ax.set_ylabel(" # raw label ## ")"
+ylabel :: String -> Matplotlib
+ylabel label = mp # "ax.set_ylabel(" # raw label ## ")"
 
 -- | Add a label to the z axis
-zLabel :: String -> Matplotlib
-zLabel label = mp # "ax.set_zlabel(" # raw label ## ")"
+zlabel :: String -> Matplotlib
+zlabel label = mp # "ax.set_zlabel(" # raw label ## ")"
 
 setSizeInches w h = mp # "fig.set_size_inches(" # w # "," # h # ", forward=True)"
 
@@ -461,9 +505,12 @@ subplots = mp # "fig, axes = plot.subplots(" ## ")"
 -- | Access a subplot
 setSubplot s = mp # "ax = axes[" # s # "]" % setAx
 
--- | Add axes to a figure
+-- | Add axes to a plot
 axes = mp # "ax = plot.axes(" ## ")" % updateAxes % setAx
 
+-- | Add axes to a figure
+addAxes = mp # "ax = fig.add_axes(" ## ")" % updateAxes % setAx
+
 -- | Creates a new figure with the given id. If the Id is already in use it
 -- switches to that figure.
-figure id = mp # "plot.figure(" # id ## ")" % updateFigure
+figure = mp # "plot.figure(" ## ")" % updateFigure

src/Graphics/Matplotlib/Internal.hs

@@ -1,4 +1,4 @@
-{-# LANGUAGE FlexibleInstances, ScopedTypeVariables, FlexibleContexts, ExtendedDefaultRules #-}
+{-# LANGUAGE FlexibleInstances, ScopedTypeVariables, FlexibleContexts, ExtendedDefaultRules, ExistentialQuantification #-}
 -- |
 -- Internal representations of the Matplotlib data. These are not API-stable
 -- and may change. You can easily extend the provided bindings without relying
@@ -33,10 +33,10 @@ data Matplotlib = Matplotlib {
 -- | A maplotlib command, right now we have a very shallow embedding essentially
 -- dealing in strings containing python code as well as the ability to load
 -- data. The loaded data should be a json object.
-data MplotCommand
-  = LoadData B.ByteString
+data MplotCommand =
+  LoadData B.ByteString
+  | forall x. MplotImage x => LoadImage x
   | Exec { es :: String }
-  deriving (Show, Eq, Ord)
 
 -- | Throughout the API we need to accept options in order to expose
 -- matplotlib's many configuration options.
@@ -50,6 +50,7 @@ data Option =
 -- | Convert an 'MplotCommand' to python code, doesn't do much right now
 toPy :: MplotCommand -> String
 toPy (LoadData _) = error "withMplot needed to load data"
+toPy (LoadImage _) = error "withMplot needed to load images"
 toPy (Exec str)   = str
 
 -- | Resolve the pending command with no options provided.
@@ -75,6 +76,12 @@ withMplot m f = preload cs []
                 B.hPutStr dataHandle obj
                 hClose dataHandle
                 preload l $ ((map Exec $ pyReadData dataFile) ++ cmds))
+    preload ((LoadImage img):l) cmds = do
+      withSystemTempFile "data.json" $
+        (\dataFile dataHandle -> do
+            hClose dataHandle
+            obj <- saveHaskellImage img dataFile
+            preload l $ ([Exec $ "img = " ++ (loadPythonImage img obj dataFile)] ++ cmds))
     preload (c:l) cmds = preload l (c:cmds)
 
 -- | Create a plot that executes the string as python code
@@ -85,10 +92,14 @@ mplotString s = Matplotlib S.empty Nothing (S.singleton $ Exec s)
 mp :: Matplotlib
 mp = Matplotlib S.empty Nothing S.empty
 
--- | Load the given data into the 'data' array
+-- | Load the given data into the python "data" array
 readData :: ToJSON a => a -> Matplotlib
 readData d = Matplotlib (S.singleton $ LoadData $ encode d) Nothing S.empty
 
+-- | Load the given image into python "img" variable
+readImage :: MplotImage i => i -> Matplotlib
+readImage i = Matplotlib (S.singleton $ LoadImage i) Nothing S.empty
+
 infixl 5 %
 -- | Combine two matplotlib commands
 (%) :: Matplotlib -> Matplotlib -> Matplotlib
@@ -187,9 +198,28 @@ instance (MplotValue (x, y)) => MplotValue [(x, y)] where
 instance MplotValue x => MplotValue (Maybe x) where
   toPython Nothing  = "None"
   toPython (Just x) = toPython x
+instance MplotValue [[Double]] where
+  toPython s = "np.asarray([" ++ f s ++ "])"
+    where f [] = ""
+          f (x:xs) = toPython x ++ "," ++ f xs
 
 default (Integer, Int, Double)
 
+-- | The class of Haskell images or references to imagese which can be
+-- transferred to matplotlib.
+class MplotImage a where
+  saveHaskellImage :: a -> FilePath -> IO String
+  loadPythonImage :: a -> String -> FilePath -> String
+
+-- | An image that is a string is a file path.
+instance MplotImage String where
+  saveHaskellImage _ _ = return ""
+  loadPythonImage s _ _ = "mpimg.imread('" ++ toPython s ++ "')"
+
+instance ToJSON a => MplotImage [[a]] where
+  saveHaskellImage d fp = (B.writeFile fp $ encode d) >> return ""
+  loadPythonImage s _ fp = unlines $ pyReadData fp
+
 -- $ Options
 
 -- | Add an option to the last matplotlib command. Commands can have only one option!
@@ -285,10 +315,11 @@ pyIncludes backend = ["import matplotlib"
                      ,"import matplotlib.patches as mpatches"
                      ,"import matplotlib.pyplot as plot"
                      ,"import matplotlib.mlab as mlab"
+                     ,"import matplotlib.cm as cm"
                      ,"import matplotlib.colors as mcolors"
                      ,"import matplotlib.collections as mcollections"
                      ,"import matplotlib.ticker as mticker"
-                     ,"from matplotlib import cm"
+                     ,"import matplotlib.image as mpimg"
                      ,"from mpl_toolkits.mplot3d import axes3d"
                      ,"import numpy as np"
                      ,"import os"
@@ -304,6 +335,10 @@ pyIncludes backend = ["import matplotlib"
 pyReadData :: [Char] -> [[Char]]
 pyReadData filename = ["data = json.loads(open('" ++ filename ++ "').read())"]
 
+-- | The python command that reads an image into the img variable
+pyReadImage :: [Char] -> [[Char]]
+pyReadImage filename = ["img = mpimg.imread('" ++ filename ++ "')"]
+
 -- | Detach python so we don't block (TODO This isn't working reliably)
 pyDetach :: [[Char]]
 pyDetach = ["pid = os.fork()"