Numeric.GSL.Histogram2D

GSL 2D histogram functions

http://www.gnu.org/software/gsl/manual/

Creation

data Histogram2D

A histogram structure

Instances

Eq Histogram2D

Binary Histogram2D

emptyRanges

Arguments

:: Vector Double

the x ranges

-> Vector Double

the y ranges

-> Histogram2D

result

create a histogram with n bins from ranges (x0->x1),(x1->x2)..(xn->xn+1)

emptyLimits

Arguments

:: Int

-> Int

bins

-> (Double, Double)

lower and upper limits x

-> (Double, Double)

lower and upper limits y

-> Histogram2D

result

create a histogram with n bins and lower and upper limits

fromRanges

Arguments

:: Vector Double

the x ranges

-> Vector Double

the y ranges

-> [(Double, Double)]

the data

-> Histogram2D

result

create a histogram with n bins from ranges (x0->x1),(x1->x2)..(xn->xn+1) and increment from a vector

fromLimits

Arguments

:: Int

-> Int

bins

-> (Double, Double)

x lower and upper limits

-> (Double, Double)

y lower and upper limits

-> [(Double, Double)]

the data

-> Histogram2D

result

create a histogram with n bins and lower and upper limits and increment from a vector

Loading

addList :: Histogram2D -> [(Double, Double)] -> Histogram2D

add 1.0 to the correct bin for each element of the list, fails silently if the value is outside the range

addVector :: Histogram2D -> Vector Double -> Vector Double -> Histogram2D

add 1.0 to the correct bin for each element of the vector pair, fails silently if the value is outside the range

addListWeighted :: Histogram2D -> [(Double, Double, Double)] -> Histogram2D

addVectorWeighted :: Histogram2D -> Vector Double -> Vector Double -> Vector Double -> Histogram2D

Marshalling

toMatrix

Arguments

:: Histogram2D

-> (Vector Double, Vector Double, Matrix Double)

(ranges,bins)

extract the ranges and bins

fromMatrix

Arguments

:: Vector Double

x ranges

-> Vector Double

y ranges

-> Matrix Double

bins (row major)

-> Histogram2D

result

create from ranges and bins

Information

getBin :: Histogram2D -> (Int, Int) -> Double

returns the contents of the i-th bin

getXRange :: Histogram2D -> Int -> (Double, Double)

returns the upper and lower limits in the first dimension of the i-th bin

getYRange :: Histogram2D -> Int -> (Double, Double)

returns the upper and lower limits in the second dimension of the i-th bin

getXMax :: Histogram2D -> Double

the maximum upper range limit in the first dimension

getYMax :: Histogram2D -> Double

the maximum upper range limit in the first dimension

getXMin :: Histogram2D -> Double

the minimum lower range limit in the first dimension

getYMin :: Histogram2D -> Double

the minimum lower range limit in the first dimension

getXBins :: Histogram2D -> Int

the number of binsin the first dimension

getYBins :: Histogram2D -> Int

the number of binsin the first dimension

reset :: Histogram2D -> IO ()

reset all the bins to zero

Querying

find :: Histogram2D -> (Double, Double) -> Maybe (Int, Int)

find the bin corresponding to the value

count :: Histogram2D -> (Vector Double, Vector Double) -> Vector Double

find the number of occurences for each element of the input vector

prob :: Histogram2D -> (Vector Double, Vector Double) -> Vector Double

find the joint probability of occuring for each element of the input vector pair

probPaired :: Histogram2D -> Vector (Double, Double) -> Vector Double

find the joint probability of occuring for each element of the input vector pair

countPaired :: Histogram2D -> Vector (Double, Double) -> Vector Double

find the number of occurences for each element of the input vector

countInstance :: Histogram2D -> (Double, Double) -> Double

find the number of occurences for the input

probability :: Histogram2D -> (Double, Double) -> Double

find the probability of the input

maxVal :: Histogram2D -> Double

the maximum value contained in the bins

maxBin :: Histogram2D -> (Int, Int)

the index of the bin containing the maximum value

minVal :: Histogram2D -> Double

the minimum value contained in the bins

minBin :: Histogram2D -> (Int, Int)

the index of the bin containing the minimum value

Statistics

xmean :: Histogram2D -> Double

the mean of the values in the first dimension, accuracy limited by bin width

ymean :: Histogram2D -> Double

the mean of the values in the second dimension, accuracy limited by bin width

xstddev :: Histogram2D -> Double

the standard deviation of the values in thee first dimension, accuracy limited by bin width

ystddev :: Histogram2D -> Double

the standard deviation of the values in thee first dimension, accuracy limited by bin width

covariance :: Histogram2D -> Double

the covariance of the first and second dimensions

sum :: Histogram2D -> Double

the sum of the values, accuracy limited by bin width

equalBins :: Histogram2D -> Histogram2D -> Bool

returns True of all the individual bin ranges of the two histograms are identical

Mathematics

add :: Histogram2D -> Histogram2D -> Histogram2D

adds the contents of the bins of the second histogram to the first

subtract :: Histogram2D -> Histogram2D -> Histogram2D

subtracts the contents of the bins of the second histogram from the first

multiply :: Histogram2D -> Histogram2D -> Histogram2D

multiplies the contents of the bins of the second histogram by the first

divide :: Histogram2D -> Histogram2D -> Histogram2D

divides the contents of the bins of the first histogram by the second

shift :: Histogram2D -> Double -> Histogram2D

adds a constant to the contents of the bins

scale :: Histogram2D -> Double -> Histogram2D

multiplies the contents of the bins by a constant

Files

fwriteHistogram2D :: FilePath -> Histogram2D -> IO ()

write a histogram in the native binary format (may not be portable)

freadHistogram2D :: FilePath -> Int -> Int -> IO Histogram2D

read a histogram in the native binary format, number of bins must be known

fprintfHistogram2D :: FilePath -> String -> String -> Histogram2D -> IO ()

saves the histogram with the given formats (%f,%e,%g) for ranges and bins each line comprises: xrange[i] xrange[i+1] xrange[j] xrange[j+1] bin(i,j)

fscanfHistogram2D :: FilePath -> Int -> Int -> IO Histogram2D

reads formatted data as written by fprintf, the number of bins must be known in advance

PDF

data Histogram2DPDF

A histogram-derived cumulative distribution function (CDF)

fromHistogram2D :: Histogram2D -> Histogram2DPDF

create a histogram PDF from a histogram

sample :: Histogram2DPDF -> Double -> Double

given a randomm from the uniform distribution [0,1], draw a random sample from the PDF