Graphics.Rendering.Plot.Light

`plot-light` provides functionality for rendering vector graphics in SVG format. It is geared in particular towards scientific plotting, and it is termed "light" because it only requires few native Haskell dependencies.

It builds upon `blaze-svg` by adding type-safe combinators, geometry primitives and related functions.

Usage

To use this project you just need to import this module qualified (to avoid name clashes with any other modules you might have loaded on the side), for example as follows :

import Graphics.Rendering.Plot.Light as P

If you wish to try out the examples in this page, you will need to have renderSvg in scope as well:

import Text.Blaze.Svg.Renderer.String (renderSvg)

Graphical elements

rectCentered

Arguments

:: Point Double

Center coordinates

-> Double

Width

-> Double

Height

-> Colour Double

Colour

-> Svg

A filled rectangle

line

Arguments

:: Point Double

First point

-> Point Double

Second point

-> Double

Stroke width

-> Colour Double

Stroke colour

-> Svg

Line segment between two Points

> putStrLn $ renderSvg (line 0 0 1 1 0.1 C.blueviolet)
<line x1="0.0" y1="0.0" x2="1.0" y2="1.0" stroke="#8a2be2" stroke-width="0.1" />

axis

Arguments

:: (Functor t, Foldable t)

=> Axis

Axis (i.e. either X or Y)

-> Double

Length

-> Double

Stroke width

-> Colour Double

Stroke colour

-> Double

Tick length fraction (w.r.t axis length)

-> Point Double

Axis center coordinate

-> t (Point Double)

Tick center coordinates

-> Svg

An axis with tickmarks

> putStrLn $ renderSvg $ axis X 200 2 C.red 0.05 (Point 150 10) [Point 50 1, Point 60 1, Point 70 1]
<line x1="50.0" y1="10.0" x2="250.0" y2="10.0" stroke="#ff0000" stroke-width="2.0" /><line x1="50.0" y1="5.0" x2="50.0" y2="15.0" stroke="#ff0000" stroke-width="2.0" /><line x1="60.0" y1="5.0" x2="60.0" y2="15.0" stroke="#ff0000" stroke-width="2.0" /><line x1="70.0" y1="5.0" x2="70.0" y2="15.0" stroke="#ff0000" stroke-width="2.0" />

text

Arguments

:: (Show a, Show a1, ToValue a2)

=> a1

Rotation angle

-> Colour Double

Font colour

-> Text

Text

-> V2 a2

Displacement

-> Point a

Initial center position of the text box

-> Svg

text renders text onto the SVG canvas. It is also possible to rotate and move the text, however the order of these modifiers matters.

NB1: The Point parameter p determines the initial position of the bottom-left corner of the text box. If a nonzero rotation is applied, the whole text box will move on a circle of radius || x^2 + y^2 || centered at p.

NB2: the rotate and translate attributes apply to the center of the visible text instead.

> putStrLn $ renderSvg $ text (-45) C.red "hullo!" (V2 (-30) 0) (Point 0 20)
<text x="-30" y="0" transform="translate(0 20)rotate(-45)" fill="#ff0000">hullo!</text>

polyline

Arguments

:: (Show a1, Show a)

=> [(a1, a)]

Data

-> Double

Stroke width

-> Colour Double

Stroke colour

-> Svg

Polyline (piecewise straight line)

> putStrLn $ renderSvg (polyline [(1,1), (2,1), (2,2), (3,4)] 0.1 C.red)
<polyline points="1,1 2,1 2,2 3,4" fill="none" stroke="#ff0000" stroke-width="0.1" />

Types

data FigureData a

Constructors

FigData

Fields

• _width :: a
• _height :: a
• _xmin :: a
• _xmax :: a
• _ymin :: a
• _ymax :: a

Instances

Eq a => Eq (FigureData a)

Methods

(==) :: FigureData a -> FigureData a -> Bool

(/=) :: FigureData a -> FigureData a -> Bool

Show a => Show (FigureData a)

Methods

showsPrec :: Int -> FigureData a -> ShowS

show :: FigureData a -> String

showList :: [FigureData a] -> ShowS

data Point a

A Point defines a point in R2

Constructors

Point

Fields

• _px :: a
• _py :: a

Instances

Eq a => Eq (Point a)

Methods

(==) :: Point a -> Point a -> Bool

(/=) :: Point a -> Point a -> Bool

Show a => Show (Point a)

Methods

showsPrec :: Int -> Point a -> ShowS

show :: Point a -> String

showList :: [Point a] -> ShowS

data LabeledPoint l a

A LabeledPoint carries a "label" (i.e. any additional information such as a text tag, or any other data structure), in addition to position information. Data points on a plot are LabeledPoints.

Constructors

LabeledPoint

Fields

• _lp :: Point a
• _lplabel :: l

Instances

(Eq l, Eq a) => Eq (LabeledPoint l a)

Methods

(==) :: LabeledPoint l a -> LabeledPoint l a -> Bool

(/=) :: LabeledPoint l a -> LabeledPoint l a -> Bool

(Show l, Show a) => Show (LabeledPoint l a)

Methods

showsPrec :: Int -> LabeledPoint l a -> ShowS

show :: LabeledPoint l a -> String

showList :: [LabeledPoint l a] -> ShowS

data Axis

Constructors

X

Y

Instances

Enum Axis

Methods

succ :: Axis -> Axis

pred :: Axis -> Axis

toEnum :: Int -> Axis

fromEnum :: Axis -> Int

enumFrom :: Axis -> [Axis]

enumFromThen :: Axis -> Axis -> [Axis]

enumFromTo :: Axis -> Axis -> [Axis]

enumFromThenTo :: Axis -> Axis -> Axis -> [Axis]

Eq Axis

Methods

(==) :: Axis -> Axis -> Bool

(/=) :: Axis -> Axis -> Bool

Show Axis

Methods

showsPrec :: Int -> Axis -> ShowS

show :: Axis -> String

showList :: [Axis] -> ShowS

mkFigureData :: Num a => Point a -> a -> a -> FigureData a

Create a FigureData structure from the top-left corner point and its side lengths

svgHeader :: FigureData Int -> Svg -> Svg

Create the SVG header from FigureData

Geometry

Vectors

data V2 a

V2 is a vector in R^2

Constructors

V2 a a

Instances

Eq a => Eq (V2 a)

Methods

(==) :: V2 a -> V2 a -> Bool

(/=) :: V2 a -> V2 a -> Bool

Show a => Show (V2 a)

Methods

showsPrec :: Int -> V2 a -> ShowS

show :: V2 a -> String

showList :: [V2 a] -> ShowS

Num a => Monoid (V2 a)

Vectors form a monoid w.r.t. vector addition

Methods

mempty :: V2 a

mappend :: V2 a -> V2 a -> V2 a

mconcat :: [V2 a] -> V2 a

Num a => Hermitian (V2 a)

Associated Types

type InnerProduct (V2 a) :: *

Methods

(<.>) :: V2 a -> V2 a -> InnerProduct (V2 a)

Num a => VectorSpace (V2 a)

Associated Types

type Scalar (V2 a) :: *

Methods

(.*) :: Scalar (V2 a) -> V2 a -> V2 a

Num a => AdditiveGroup (V2 a)

Vectors form an additive group

Methods

zero :: V2 a

(^+^) :: V2 a -> V2 a -> V2 a

(^-^) :: V2 a -> V2 a -> V2 a

Fractional a => MatrixGroup (DiagMat2 a) (V2 a)

Diagonal matrices can always be inverted

Methods

(<\>) :: DiagMat2 a -> V2 a -> V2 a

Num a => LinearMap (DiagMat2 a) (V2 a)

Methods

(#>) :: DiagMat2 a -> V2 a -> V2 a

Num a => LinearMap (Mat2 a) (V2 a)

Methods

(#>) :: Mat2 a -> V2 a -> V2 a

type InnerProduct (V2 a)

type InnerProduct (V2 a) = a

type Scalar (V2 a)

type Scalar (V2 a) = a

Matrices

data Mat2 a

A Mat2 can be seen as a linear operator that acts on points in the plane

Constructors

Mat2 a a a a

Instances

Eq a => Eq (Mat2 a)

Methods

(==) :: Mat2 a -> Mat2 a -> Bool

(/=) :: Mat2 a -> Mat2 a -> Bool

Show a => Show (Mat2 a)

Methods

showsPrec :: Int -> Mat2 a -> ShowS

show :: Mat2 a -> String

showList :: [Mat2 a] -> ShowS

Num a => MultiplicativeSemigroup (Mat2 a)

Methods

(##) :: Mat2 a -> Mat2 a -> Mat2 a

Num a => LinearMap (Mat2 a) (V2 a)

Methods

(#>) :: Mat2 a -> V2 a -> V2 a

data DiagMat2 a

Diagonal matrices in R2 behave as scaling transformations

Constructors

DMat2 a a

Instances

Eq a => Eq (DiagMat2 a)

Methods

(==) :: DiagMat2 a -> DiagMat2 a -> Bool

(/=) :: DiagMat2 a -> DiagMat2 a -> Bool

Show a => Show (DiagMat2 a)

Methods

showsPrec :: Int -> DiagMat2 a -> ShowS

show :: DiagMat2 a -> String

showList :: [DiagMat2 a] -> ShowS

Num a => MultiplicativeSemigroup (DiagMat2 a)

Methods

(##) :: DiagMat2 a -> DiagMat2 a -> DiagMat2 a

Fractional a => MatrixGroup (DiagMat2 a) (V2 a)

Diagonal matrices can always be inverted

Methods

(<\>) :: DiagMat2 a -> V2 a -> V2 a

Num a => LinearMap (DiagMat2 a) (V2 a)

Methods

(#>) :: DiagMat2 a -> V2 a -> V2 a

diagMat2 :: Num a => a -> a -> Mat2 a

Create a diagonal matrix

Primitive elements

origin :: Num a => Point a

The origin of the axes, point (0, 0)

e1 :: Num a => V2 a

X-aligned unit vector

e2 :: Num a => V2 a

Y-aligned unit vector

Vector operations

norm2 :: (Hermitian v, Floating n, n ~ InnerProduct v) => v -> n

Euclidean (L^2) norm

normalize2 :: (InnerProduct v ~ Scalar v, Floating (Scalar v), Hermitian v) => v -> v

Normalize a V2 w.r.t. its Euclidean norm

Vector construction

mkV2fromEndpoints :: Num a => Point a -> Point a -> V2 a

Create a V2 v from two endpoints p1, p2. That is v can be seen as pointing from p1 to p2

v2fromPoint :: Num a => Point a -> V2 a

Build a V2 from a Point p (i.e. assuming the V2 points from the origin (0,0) to p)

Operations on points

movePoint :: Num a => V2 a -> Point a -> Point a

Move a point along a vector

moveLabeledPointV2 :: Num a => V2 a -> LabeledPoint l a -> LabeledPoint l a

Move a LabeledPoint along a vector

fromUnitSquare :: Num a => Frame a -> Point a -> Point a

The vector translation from a Point p contained in the unit square onto a Frame

NB: we do not check that p is actually contained in [0,1] x [0,1], This has to be supplied correctly by the user

toUnitSquare :: (Fractional a, MatrixGroup (Mat2 a) (V2 a)) => Frame a -> Point a -> Point a

The vector translation from a Point contained in a Frame onto the unit square

NB: we do not check that p is actually contained within the frame. This has to be supplied correctly by the user

Typeclasses

class AdditiveGroup v where

Additive group :

v ^+^ zero == zero ^+^ v == v

v ^-^ v == zero

Minimal complete definition

zero, (^+^), (^-^)

Methods

zero :: v

Identity element

(^+^) :: v -> v -> v

Group action ("sum")

(^-^) :: v -> v -> v

Inverse group action ("subtraction")

Instances

Num a => AdditiveGroup (V2 a)

Vectors form an additive group

Methods

zero :: V2 a

(^+^) :: V2 a -> V2 a -> V2 a

(^-^) :: V2 a -> V2 a -> V2 a

class AdditiveGroup v => VectorSpace v where

Vector space : multiplication by a scalar quantity

Minimal complete definition

(.*)

Associated Types

type Scalar v :: *

Methods

(.*) :: Scalar v -> v -> v

Scalar multiplication

Instances

Num a => VectorSpace (V2 a)

Associated Types

type Scalar (V2 a) :: *

Methods

(.*) :: Scalar (V2 a) -> V2 a -> V2 a

class VectorSpace v => Hermitian v where

Hermitian space : inner product

Minimal complete definition

(<.>)

Associated Types

type InnerProduct v :: *

Methods

(<.>) :: v -> v -> InnerProduct v

Inner product

Instances

Num a => Hermitian (V2 a)

Associated Types

type InnerProduct (V2 a) :: *

Methods

(<.>) :: V2 a -> V2 a -> InnerProduct (V2 a)

class Hermitian v => LinearMap m v where

Linear maps, i.e. linear transformations of vectors

Minimal complete definition

(#>)

Methods

(#>) :: m -> v -> v

Matrix action, i.e. linear transformation of a vector

Instances

Num a => LinearMap (DiagMat2 a) (V2 a)

Methods

(#>) :: DiagMat2 a -> V2 a -> V2 a

Num a => LinearMap (Mat2 a) (V2 a)

Methods

(#>) :: Mat2 a -> V2 a -> V2 a

class MultiplicativeSemigroup m where

Multiplicative matrix semigroup ("multiplying" two matrices together)

Minimal complete definition

(##)

Methods

(##) :: m -> m -> m

Matrix product

Instances

Num a => MultiplicativeSemigroup (DiagMat2 a)

Methods

(##) :: DiagMat2 a -> DiagMat2 a -> DiagMat2 a

Num a => MultiplicativeSemigroup (Mat2 a)

Methods

(##) :: Mat2 a -> Mat2 a -> Mat2 a

class LinearMap m v => MatrixGroup m v where

The class of invertible linear transformations

Minimal complete definition

(<\>)

Methods

(<\>) :: m -> v -> v

Inverse matrix action on a vector

Instances

Fractional a => MatrixGroup (DiagMat2 a) (V2 a)

Diagonal matrices can always be inverted

Methods

(<\>) :: DiagMat2 a -> V2 a -> V2 a