Plots.Types.Histogram

Histogram plot

data HistogramPlot n

Simple histogram type supporting uniform bins.

Instances

OrderedField n => Enveloped (HistogramPlot n)

Defined in Plots.Types.Histogram

Methods

getEnvelope :: HistogramPlot n -> Envelope (V (HistogramPlot n)) (N (HistogramPlot n))

HasOrientation (HistogramPlot n)

Defined in Plots.Types.Histogram

Methods

orientation :: Lens' (HistogramPlot n) Orientation

(TypeableFloat n, Renderable (Path V2 n) b) => Plotable (HistogramPlot n) b

Defined in Plots.Types.Histogram

Methods

renderPlotable :: forall (v :: Type -> Type) n0. InSpace v n0 (HistogramPlot n) => AxisSpec v n0 -> PlotStyle b v n0 -> HistogramPlot n -> QDiagram b v n0 Any

defLegendPic :: forall (v :: Type -> Type) n0. InSpace v n0 (HistogramPlot n) => PlotStyle b v n0 -> HistogramPlot n -> QDiagram b v n0 Any

type N (HistogramPlot n)

Defined in Plots.Types.Histogram

type N (HistogramPlot n) = n

type V (HistogramPlot n)

Defined in Plots.Types.Histogram

type V (HistogramPlot n) = V2

Already computed histograms

computedHistogram

Arguments

:: (MonadState (Axis b V2 n) m, Plotable (HistogramPlot n) b, Foldable f)

=> n

start of first bin

-> n

width of each bin

-> f n

heights of the bins

-> State (Plot (HistogramPlot n) b) ()

-> m ()

Plot an already computed histogram with equally sized bins.

Histogram options

data HistogramOptions n

Options for binning histogram data. For now only very basic histograms building is supported.

Instances

Default (HistogramOptions n)

Defined in Plots.Types.Histogram

Methods

def :: HistogramOptions n

HasOrientation (HistogramOptions n)

Defined in Plots.Types.Histogram

Methods

orientation :: Lens' (HistogramOptions n) Orientation

HasHistogramOptions (HistogramOptions n)

Defined in Plots.Types.Histogram

Methods

histogramOptions :: Lens' (HistogramOptions n) (HistogramOptions (N (HistogramOptions n)))

numBins :: Lens' (HistogramOptions n) Int

binRange :: Lens' (HistogramOptions n) (Maybe (N (HistogramOptions n), N (HistogramOptions n)))

normaliseSample :: Lens' (HistogramOptions n) NormalisationMethod

type N (HistogramOptions n)

Defined in Plots.Types.Histogram

type N (HistogramOptions n) = n

type V (HistogramOptions n)

Defined in Plots.Types.Histogram

type V (HistogramOptions n) = V2

class HasOrientation a => HasHistogramOptions a where

Minimal complete definition

histogramOptions

Methods

histogramOptions :: Lens' a (HistogramOptions (N a))

Options for building the histogram from data.

numBins :: Lens' a Int

The number of bins (bars) to use for the histogram. Must be positive.

Default is 10.

binRange :: Lens' a (Maybe (N a, N a))

The range of data to consider when building the histogram. Any data outside the range is ignored.

Default is Nothing.

normaliseSample :: Lens' a NormalisationMethod

Should the resulting histogram be normalised so the total area is 1.

Default is False.

Instances

HasHistogramOptions (HistogramOptions n)

Defined in Plots.Types.Histogram

Methods

histogramOptions :: Lens' (HistogramOptions n) (HistogramOptions (N (HistogramOptions n)))

numBins :: Lens' (HistogramOptions n) Int

binRange :: Lens' (HistogramOptions n) (Maybe (N (HistogramOptions n), N (HistogramOptions n)))

normaliseSample :: Lens' (HistogramOptions n) NormalisationMethod

HasHistogramOptions a => HasHistogramOptions (Plot a b)

Defined in Plots.Types.Histogram

Methods

histogramOptions :: Lens' (Plot a b) (HistogramOptions (N (Plot a b)))

numBins :: Lens' (Plot a b) Int

binRange :: Lens' (Plot a b) (Maybe (N (Plot a b), N (Plot a b)))

normaliseSample :: Lens' (Plot a b) NormalisationMethod

Normalisation

data NormalisationMethod

The way to normalise the data from a histogram. The default method is count.

Instances

Default NormalisationMethod

Defined in Plots.Types.Histogram

Methods

def :: NormalisationMethod

count :: NormalisationMethod

The height of each bar is the number of observations. This is the Default method.

Example

probability :: NormalisationMethod

The sum of the heights of the bars is equal to 1.

Example

countDensity :: NormalisationMethod

The height of each bar is n / w where n is the number of observations and w is the total width.

Example

pdf :: NormalisationMethod

The total area of the bars is 1. This gives a probability density function estimate.

Example

cumilative :: NormalisationMethod

The height of each bar is the cumulative number of observations in each bin and all previous bins. The height of the last bar is the total number of observations.

Example

cdf :: NormalisationMethod

Cumulative density function estimate. The height of each bar is equal to the cumulative relative number of observations in the bin and all previous bins. The height of the last bar is 1.

Example

Plotting histograms

histogramPlot

Arguments

:: (MonadState (Axis b V2 n) m, Plotable (HistogramPlot n) b, Foldable f, RealFrac n)

=> f n

data

-> State (Plot (HistogramOptions n) b) ()

changes to plot options

-> m ()

add plot to axis

Add a HistogramPlot to the AxisState from a data set.

Example

import Plots
histogramAxis :: Axis B V2 Double
histogramAxis = r2Axis &~ do
  histogramPlot sampleData $ do
    key "histogram"
    plotColor .= blue
    areaStyle . _opacity .= 0.5

histogramExample = renderAxis histogramAxis

histogramPlot'

Arguments

:: (MonadState (Axis b V2 n) m, Plotable (HistogramPlot n) b, Foldable f, RealFrac n)

=> f n

data

-> m ()

add plot to axis

Make a HistogramPlot without changes to the plot options.

histogramPlotOf

Arguments

:: (MonadState (Axis b V2 n) m, Plotable (HistogramPlot n) b, RealFrac n)

=> Fold s n

fold over the data

-> s

data to fold

-> State (Plot (HistogramOptions n) b) ()

change to the plot

-> m ()

add plot to the Axis

Add a HistogramPlot using a fold over the data.

histogramPlotOf' :: (MonadState (Axis b V2 n) m, Plotable (HistogramPlot n) b, RealFrac n) => Fold s n -> s -> m ()

Same as histogramPlotOf without any changes to the plot.

Low level constructors

mkComputedHistogram

Arguments

:: Foldable f

=> n

start of first bin

-> n

width of each bin

-> f n

heights of the bins

-> HistogramPlot n

Construct a HistogramPlot from raw histogram data.

mkHistogramPlot :: (Foldable f, RealFrac n) => HistogramOptions n -> f n -> HistogramPlot n

Create a histogram by binning the data using the HistogramOptions.