Copyright	(C) 2016 Christopher Chalmers
License	BSD-style (see the file LICENSE)
Maintainer	Christopher Chalmers
Stability	experimental
Portability	non-portable
Safe Haskell	None
Language	Haskell2010

Plots.Types.HeatMap

Contents

Heat map
Lenses
- Rendering functions
Heat matrix
Low level construction

Description

A heat map is a graphical representation of data where the individual values contained in a matrix are represented as colours.

(see heatMapIndexed example for code to make this plot)

Synopsis

data HeatMap v
heatMap :: (Foldable f, Foldable g, MonadState (Axis V2) m) => f (g Double) -> State (Plot (HeatMap V2)) () -> m ()
heatMap' :: (Foldable f, Foldable g, MonadState (Axis V2) m) => f (g Double) -> m ()
heatMapIndexed :: (VectorLike V2 Int i, MonadState (Axis V2) m) => i -> (i -> Double) -> State (Plot (HeatMap V2)) () -> m ()
heatMapIndexed' :: (VectorLike V2 Int i, MonadState (Axis V2) m) => i -> (i -> Double) -> m ()
class HasHeatMap f a where
- heatMapOptions :: LensLike' f a (HeatMap (V a))
- heatMapGridVisible :: Functor f => LensLike' f a Bool
- heatMapGridStyle :: Functor f => LensLike' f a (Style (V a) Double)
- heatMapSize :: Functor f => LensLike' f a (V2 Double)
- heatMapExtent :: Functor f => LensLike' f a (V2 Double)
- heatMapStart :: Functor f => LensLike' f a (P2 Double)
- heatMapCentre :: Functor f => LensLike' f a (P2 Double)
- heatMapLimits :: Functor f => LensLike' f a (Maybe (Double, Double))
- heatMapRender :: Functor f => LensLike' f a (HeatMatrix -> ColourMap -> Diagram (V a))
pathHeatRender :: HeatMatrix -> ColourMap -> Diagram V2
pixelHeatRender :: HeatMatrix -> ColourMap -> Diagram V2
pixelHeatRender' :: Int -> HeatMatrix -> ColourMap -> Diagram V2
data HeatMatrix = HeatMatrix {
- hmSize :: !(V2 Int)
- _hmVector :: !(Vector Double)
- hmBoundLower :: !Double
- hmBoundUpper :: !Double
}
heatImage :: HeatMatrix -> ColourMap -> Image PixelRGB8
hmPoints :: IndexedTraversal' (V2 Int) HeatMatrix Double
mkHeatMap :: HeatMatrix -> HeatMap V2
mkHeatSurface :: HeatMatrix -> HeatMap V3
mkHeatMatrix :: V2 Int -> (V2 Int -> Double) -> HeatMatrix
mkHeatMatrix' :: (Foldable f, Foldable g) => f (g Double) -> HeatMatrix

Heat map

data HeatMap v Source #

A mapping from points in a 2D axis do Doubles. These Doubles are converted to colours using the axis ColourMap.

Instances

HasHeatMap f (HeatMap v) Source #
Instance details Defined in Plots.Types.HeatMap Methods heatMapOptions :: LensLike' f (HeatMap v) (HeatMap (V (HeatMap v))) Source # heatMapGridVisible :: LensLike' f (HeatMap v) Bool Source # heatMapGridStyle :: LensLike' f (HeatMap v) (Style (V (HeatMap v)) Double) Source # heatMapSize :: LensLike' f (HeatMap v) (V2 Double) Source # heatMapExtent :: LensLike' f (HeatMap v) (V2 Double) Source # heatMapStart :: LensLike' f (HeatMap v) (P2 Double) Source # heatMapCentre :: LensLike' f (HeatMap v) (P2 Double) Source # heatMapLimits :: LensLike' f (HeatMap v) (Maybe (Double, Double)) Source # heatMapRender :: LensLike' f (HeatMap v) (HeatMatrix -> ColourMap -> Diagram (V (HeatMap v))) Source #
Enveloped (HeatMap V3) Source #
Instance details Defined in Plots.Types.HeatMap Methods getEnvelope :: HeatMap V3 -> Envelope (V (HeatMap V3)) (N (HeatMap V3)) boundingBox :: HeatMap V3 -> BoundingBox (V (HeatMap V3)) (N (HeatMap V3))
Enveloped (HeatMap V2) Source #
Instance details Defined in Plots.Types.HeatMap Methods getEnvelope :: HeatMap V2 -> Envelope (V (HeatMap V2)) (N (HeatMap V2)) boundingBox :: HeatMap V2 -> BoundingBox (V (HeatMap V2)) (N (HeatMap V2))
Plotable (HeatMap V3) Source #
Instance details Defined in Plots.Types.HeatMap Methods renderPlotable :: InSpace v Double (HeatMap V3) => AxisSpec v -> PlotStyle v -> HeatMap V3 -> Diagram v Source # defLegendPic :: InSpace v Double (HeatMap V3) => PlotStyle v -> HeatMap V3 -> Diagram v Source #
Plotable (HeatMap V2) Source #
Instance details Defined in Plots.Types.HeatMap Methods renderPlotable :: InSpace v Double (HeatMap V2) => AxisSpec v -> PlotStyle v -> HeatMap V2 -> Diagram v Source # defLegendPic :: InSpace v Double (HeatMap V2) => PlotStyle v -> HeatMap V2 -> Diagram v Source #
type N (HeatMap v) Source #
Instance details Defined in Plots.Types.HeatMap type N (HeatMap v) = Double
type V (HeatMap v) Source #
Instance details Defined in Plots.Types.HeatMap type V (HeatMap v) = v

heatMap Source #

Arguments

:: (Foldable f, Foldable g, MonadState (Axis V2) m)
=> f (g Double)
-> State (Plot (HeatMap V2)) ()	changes to plot options
-> m ()	add plot to `Axis`

Add a HeatMap plot using the extent of the heatmap and a generating function.

heatMap :: [[Double]] -> State (Plot (HeatMap b n)) () -> State (Axis b V2 n) ()

Example

Expand

import Plots
heatMapAxis :: Axis B V2 Double
heatMapAxis = r2Axis &~ do
  display colourBar
  axisExtend .= noExtend

  let xs = [[1,2,3],[4,5,6]]
  heatMap xs $ heatMapSize .= V2 10 10

heatMapExample = renderAxis heatMapAxis

heatMap' Source #

Arguments

:: (Foldable f, Foldable g, MonadState (Axis V2) m)
=> f (g Double)
-> m ()	add plot to `Axis`

Add a HeatMap plot using the extent of the heatmap and a generating function.

heatMap' :: [[Double]] -> State (Axis b V2 n) ()

Example

Expand

import Plots
heatMapAxis' :: Axis B V2 Double
heatMapAxis' = r2Axis &~ do
  display colourBar
  axisExtend .= noExtend
  axisColourMap .= Plots.magma

  let xs = [[1,2,3],[4,5,6]]
  heatMap' xs

heatMapExample' = renderAxis heatMapAxis'

heatMapIndexed Source #

Arguments

:: (VectorLike V2 Int i, MonadState (Axis V2) m)
=> i	extent of array
-> (i -> Double)	heat from index
-> State (Plot (HeatMap V2)) ()	changes to plot options
-> m ()	add plot to `Axis`

Add a HeatMap plot using the extent of the heatmap and a generating function.

heatMapIndexed :: V2 Int     -> (V2 Int -> Double)     -> State (Plot (HeatMap b n)) () -> State (Axis b V2 n) ()
heatMapIndexed :: (Int, Int) -> ((Int, Int) -> Double) -> State (Plot (HeatMap b n)) () -> State (Axis b V2 n) ()

Example

Expand

import Plots
heatMapIndexedAxis :: Axis B V2 Double
heatMapIndexedAxis = r2Axis &~ do
  display colourBar
  axisExtend .= noExtend

  let f (V2 x y) = fromIntegral x + fromIntegral y
  heatMapIndexed (V2 3 3) f $ heatMapSize .= V2 10 10

heatMapIndexedExample = renderAxis heatMapIndexedAxis

heatMapIndexed' Source #

Arguments

:: (VectorLike V2 Int i, MonadState (Axis V2) m)
=> i	extent of array
-> (i -> Double)	heat from index
-> m ()	add plot to `Axis`

Add a HeatMap plot using the extent of the heatmap and a generating function without changes to the heap map options.

heatMapIndexed :: V2 Int     -> (V2 Int -> Double)     -> State (Axis b V2 n) ()
heatMapIndexed :: (Int, Int) -> ((Int, Int) -> Double) -> State (Axis b V2 n) ()

Example

Expand

import Plots
heatMapIndexedAxis' :: Axis B V2 Double
heatMapIndexedAxis' = r2Axis &~ do
  display colourBar
  axisExtend .= noExtend
  axisColourMap .= Plots.magma

  let f (V2 x y) = fromIntegral x + fromIntegral y
  heatMapIndexed' (V2 3 3) f

heatMapIndexedExample' = renderAxis heatMapIndexedAxis'

Lenses

class HasHeatMap f a where Source #

Class of things that let you change the heatmap options.

Minimal complete definition

heatMapOptions

Methods

heatMapOptions :: LensLike' f a (HeatMap (V a)) Source #

Lens onto the heatmap options.

heatMapGridVisible :: Functor f => LensLike' f a Bool Source #

Whether there should be grid lines draw for the heat map.

Default is False.

heatMapGridStyle :: Functor f => LensLike' f a (Style (V a) Double) Source #

The style applied to the grid lines for the heat map, if they're visible.

Default is mempty.

heatMapSize :: Functor f => LensLike' f a (V2 Double) Source #

The size of each individual square in the heat map.

Default is V2 1 1.

heatMapExtent :: Functor f => LensLike' f a (V2 Double) Source #

The size of the full extent of the heat map.

Default is extent of the heat matrix.

heatMapStart :: Functor f => LensLike' f a (P2 Double) Source #

The starting point at the bottom left corner of the heat map.

Default is origin

heatMapCentre :: Functor f => LensLike' f a (P2 Double) Source #

The center point of the heat map.

heatMapLimits :: Functor f => LensLike' f a (Maybe (Double, Double)) Source #

Limits (a,b) used on the data such that a is the start of the ColourMap and b is the end of the ColourMap. Default is (0,1).

heatMapRender :: Functor f => LensLike' f a (HeatMatrix -> ColourMap -> Diagram (V a)) Source #

Funtion used to render the heat map. See pathHeatRender and pixelHeatRender.

Default is pathHeatRender.

Instances

(Functor f, HasHeatMap f a) => HasHeatMap f (Plot a) Source #
Instance details Defined in Plots.Types.HeatMap Methods heatMapOptions :: LensLike' f (Plot a) (HeatMap (V (Plot a))) Source # heatMapGridVisible :: LensLike' f (Plot a) Bool Source # heatMapGridStyle :: LensLike' f (Plot a) (Style (V (Plot a)) Double) Source # heatMapSize :: LensLike' f (Plot a) (V2 Double) Source # heatMapExtent :: LensLike' f (Plot a) (V2 Double) Source # heatMapStart :: LensLike' f (Plot a) (P2 Double) Source # heatMapCentre :: LensLike' f (Plot a) (P2 Double) Source # heatMapLimits :: LensLike' f (Plot a) (Maybe (Double, Double)) Source # heatMapRender :: LensLike' f (Plot a) (HeatMatrix -> ColourMap -> Diagram (V (Plot a))) Source #
HasHeatMap f (HeatMap v) Source #
Instance details Defined in Plots.Types.HeatMap Methods heatMapOptions :: LensLike' f (HeatMap v) (HeatMap (V (HeatMap v))) Source # heatMapGridVisible :: LensLike' f (HeatMap v) Bool Source # heatMapGridStyle :: LensLike' f (HeatMap v) (Style (V (HeatMap v)) Double) Source # heatMapSize :: LensLike' f (HeatMap v) (V2 Double) Source # heatMapExtent :: LensLike' f (HeatMap v) (V2 Double) Source # heatMapStart :: LensLike' f (HeatMap v) (P2 Double) Source # heatMapCentre :: LensLike' f (HeatMap v) (P2 Double) Source # heatMapLimits :: LensLike' f (HeatMap v) (Maybe (Double, Double)) Source # heatMapRender :: LensLike' f (HeatMap v) (HeatMatrix -> ColourMap -> Diagram (V (HeatMap v))) Source #

Rendering functions

pathHeatRender :: HeatMatrix -> ColourMap -> Diagram V2 Source #

Render the heat map as a collection squares made up of Trails. This method is compatible with all backends and should always look sharp. However it can become slow and large for large heat maps.

It is recommended to use pathHeatRender for small heat maps and pixelHeatRender for larger ones.

Example

Expand

import Plots

pathHeatRenderExample =
  let f (V2 x y) = fromIntegral x + fromIntegral y
      myHM       = mkHeatMatrix (V2 5 5) f
  in  pathHeatRender myHM viridis

pixelHeatRender :: HeatMatrix -> ColourMap -> Diagram V2 Source #

Render an heatmap as an ImageRGB8.

Example

Expand

import Plots

pixelHeatRenderExample =
  let f (V2 x y) = fromIntegral x + fromIntegral y
      myHM       = mkHeatMatrix (V2 5 5) f
  in  pixelHeatRender myHM viridis

pixelHeatRender' :: Int -> HeatMatrix -> ColourMap -> Diagram V2 Source #

Render an heatmap as an ImageRGB8 with n pixels per heat matrix point.

Example

Expand

import Plots

pixelHeatRenderExample' =
  let f (V2 x y) = fromIntegral x + fromIntegral y
      myHM       = mkHeatMatrix (V2 5 5) f
  in  pixelHeatRender' 10 myHM viridis

Heat matrix

data HeatMatrix Source #

2D Array of Doubles.

Constructors

HeatMatrix
Fields hmSize :: !(V2 Int) The size of heat matrix. _hmVector :: !(Vector Double) hmBoundLower :: !Double hmBoundUpper :: !Double

heatImage :: HeatMatrix -> ColourMap -> Image PixelRGB8 Source #

Create an image of PixelsRGB8 using the heat matrix.

hmPoints :: IndexedTraversal' (V2 Int) HeatMatrix Double Source #

Indexed traversal over the values of a HeatMatrix.

Low level construction

mkHeatMap :: HeatMatrix -> HeatMap V2 Source #

Construct a HeatMap using the given HeatMatrix.

mkHeatSurface :: HeatMatrix -> HeatMap V3 Source #

mkHeatMatrix :: V2 Int -> (V2 Int -> Double) -> HeatMatrix Source #

Construct a heat matrix from a size and a generating function.

mkHeatMatrix' :: (Foldable f, Foldable g) => f (g Double) -> HeatMatrix Source #

Construct a heat matrix from a foldable of foldables.

mkHeatMatrix' :: [[Double]] -> HeatMatrix
mkHeatMatrix' :: [Vector Double] -> HeatMatrix