Safe Haskell	Safe-Inferred
Language	Haskell2010

Currycarbon.Types

Contents

Data types

Synopsis

data CalibrationMethod
- = MatrixMultiplication
- | Bchron {
  - distribution :: CalibrationDistribution
  }
data CalibrationDistribution
- = NormalDist
- | StudentTDist {
  - ndf :: Double
  }
type YearBP = Word
type YearBCAD = Int
type YearRange = Word
data UncalC14 = UncalC14 {
- _uncalC14Id :: String
- _uncalC14UnCal :: YearBP
- _uncalC14Sigma :: YearRange
}
data UncalPDF = UncalPDF {
- _uncalPDFid :: String
- _uncalPDFUnCals :: Vector YearBP
- _uncalPDFDens :: Vector Float
}
data CalCurveBP = CalCurveBP {
- _calCurveBPCals :: Vector YearBP
- _calCurveBPUnCals :: Vector YearBP
- _calCurveBPSigmas :: Vector YearRange
}
data CalCurveBCAD = CalCurveBCAD {
}
data CalCurveMatrix = CalCurveMatrix {
- _calCurveMatrixUnCals :: Vector YearBCAD
- _calCurveMatrixCals :: Vector YearBCAD
- _calCurveMatrixDens :: Vector (Vector Float)
}
data CalPDF = CalPDF {
- _calPDFid :: String
- _calPDFCals :: Vector YearBCAD
- _calPDFDens :: Vector Float
}
data NamedCalExpr = NamedCalExpr {
- _exprID :: String
- _expr :: CalExpr
}
data CalExpr
- = UnCalDate UncalC14
- | WindowBP TimeWindowBP
- | WindowBCAD TimeWindowBCAD
- | CalDate CalPDF
- | SumCal CalExpr CalExpr
- | ProductCal CalExpr CalExpr
data TimeWindowBP = TimeWindowBP String YearBP YearBP
data TimeWindowBCAD = TimeWindowBCAD String YearBCAD YearBCAD
data CalC14 = CalC14 {
- _calC14id :: String
- _calC14RangeSummary :: CalRangeSummary
- _calC14HDROneSigma :: [HDR]
- _calC14HDRTwoSigma :: [HDR]
}
data CalRangeSummary = CalRangeSummary {
}
data HDR = HDR {
- _hdrstart :: YearBCAD
- _hdrstop :: YearBCAD
}
data RandomAgeSample = RandomAgeSample {
- _rasId :: String
- _rasSamples :: Vector YearBCAD
}

Data types

This module defines the relevant data types for handling radiocarbon dates

data CalibrationMethod Source #

Different calibration algorithms implemented in currycarbon. Currently two distinct implementations are available, although both of them are similar Intercept calibration algorithms. Maybe more algorithms will be added in the future

Constructors

MatrixMultiplication	A matrix multiplication method generally following this blog post by Martin Hinz. This method is slower and the underlying code more verbose than `Bchron`, but it has some advantages regarding didactics and the inspection of intermediate data products for debugging. Using this method is thus generally not advisable, except for specific applications, where a more technical insight into C14 calibration is needed
Bchron	A fast and reliable calibration algorithm very similar to the implementation in the R package Bchron by Andrew Parnell. This algorithm can be run with a simple normal distribution (`NormalDist`) or Student's t-distribution (`StudentTDist`), which is recommended
Fields distribution :: CalibrationDistribution

Instances

Instances details

Show CalibrationMethod Source #
Instance details Defined in Currycarbon.Types Methods showsPrec :: Int -> CalibrationMethod -> ShowS # show :: CalibrationMethod -> String # showList :: [CalibrationMethod] -> ShowS #
Eq CalibrationMethod Source #
Instance details Defined in Currycarbon.Types Methods (==) :: CalibrationMethod -> CalibrationMethod -> Bool # (/=) :: CalibrationMethod -> CalibrationMethod -> Bool #

data CalibrationDistribution Source #

Statistical distributions to be used with the CalibrationMethod Bchron

Constructors

NormalDist	Normal distribution
StudentTDist	Student's t-distribution.
Fields ndf :: Double number of degrees of freedom

Instances

Instances details

Show CalibrationDistribution Source #
Instance details Defined in Currycarbon.Types Methods showsPrec :: Int -> CalibrationDistribution -> ShowS # show :: CalibrationDistribution -> String # showList :: [CalibrationDistribution] -> ShowS #
Eq CalibrationDistribution Source #
Instance details Defined in Currycarbon.Types Methods (==) :: CalibrationDistribution -> CalibrationDistribution -> Bool # (/=) :: CalibrationDistribution -> CalibrationDistribution -> Bool #

type YearBP = Word Source #

A type to represent years BP. All numbers are positive and describe the distance in years to 1950AD: 3000 = 3000BP = 1050BC

type YearBCAD = Int Source #

A type to represent years BC or AD. Negative values describe years BC, positive values years AD: -5000 = 5000BC and 1300 = 1300AD

type YearRange = Word Source #

A type to represent a range of years

data UncalC14 Source #

A data type to represent an uncalibrated radiocarbon date

Constructors

UncalC14
Fields _uncalC14Id :: String Sample identifier, e.g. a lab number _uncalC14UnCal :: YearBP C14 age in years BP _uncalC14Sigma :: YearRange C14 standard deviation (one sigma in years)

Instances

Instances details

Show UncalC14 Source #
Instance details Defined in Currycarbon.Types Methods showsPrec :: Int -> UncalC14 -> ShowS # show :: UncalC14 -> String # showList :: [UncalC14] -> ShowS #
Eq UncalC14 Source #
Instance details Defined in Currycarbon.Types Methods (==) :: UncalC14 -> UncalC14 -> Bool # (/=) :: UncalC14 -> UncalC14 -> Bool #

data UncalPDF Source #

A data type to represent a year-wise probability density for uncalibrated dates Although technically not correct, we still call this a probability density function (PDF)

Constructors

UncalPDF
Fields _uncalPDFid :: String Sample identifier, e.g. a lab number _uncalPDFUnCals :: Vector YearBP Years BP _uncalPDFDens :: Vector Float Probability densities

Instances

Instances details

Show UncalPDF Source #
Instance details Defined in Currycarbon.Types Methods showsPrec :: Int -> UncalPDF -> ShowS # show :: UncalPDF -> String # showList :: [UncalPDF] -> ShowS #

data CalCurveBP Source #

A data type to represent a calibration curve with YearBP

Constructors

CalCurveBP
Fields _calCurveBPCals :: Vector YearBP Years calBP _calCurveBPUnCals :: Vector YearBP Years BP _calCurveBPSigmas :: Vector YearRange Standard deviation (one sigma in years)

Instances

Instances details

Show CalCurveBP Source #
Instance details Defined in Currycarbon.Types Methods showsPrec :: Int -> CalCurveBP -> ShowS # show :: CalCurveBP -> String # showList :: [CalCurveBP] -> ShowS #

data CalCurveBCAD Source #

A second data type to represent a calibration curve, here now with YearBCAD

Constructors

CalCurveBCAD
Fields _calCurveBCADCals :: Vector YearBCAD Years calBCAD _calCurveBCADUnCals :: Vector YearBCAD Years BCAD _calCurveBCADSigmas :: Vector YearRange Standard deviation (one sigma in years)

Instances

Instances details

Show CalCurveBCAD Source #
Instance details Defined in Currycarbon.Types Methods showsPrec :: Int -> CalCurveBCAD -> ShowS # show :: CalCurveBCAD -> String # showList :: [CalCurveBCAD] -> ShowS #

data CalCurveMatrix Source #

A data type to represent a calibration curve in a wide matrix form

Constructors

CalCurveMatrix
Fields _calCurveMatrixUnCals :: Vector YearBCAD Row names of the calibration curve matrix: Years BCAD _calCurveMatrixCals :: Vector YearBCAD Column names of the calibration curve matrix: Years calBCAD _calCurveMatrixDens :: Vector (Vector Float) Matrix (as a list of columns) with the probability densities

Instances

Instances details

Show CalCurveMatrix Source #
Instance details Defined in Currycarbon.Types Methods showsPrec :: Int -> CalCurveMatrix -> ShowS # show :: CalCurveMatrix -> String # showList :: [CalCurveMatrix] -> ShowS #

data CalPDF Source #

A data type to represent a year-wise probability density for calibrated dates. Although technically not correct, we still call this a probability density function (PDF)

Constructors

CalPDF
Fields _calPDFid :: String Sample identifier, e.g. a lab number _calPDFCals :: Vector YearBCAD Years calBCAD _calPDFDens :: Vector Float Probability densities for each year in `_calPDFCals`

Instances

Instances details

Show CalPDF Source #
Instance details Defined in Currycarbon.Types Methods showsPrec :: Int -> CalPDF -> ShowS # show :: CalPDF -> String # showList :: [CalPDF] -> ShowS #
Eq CalPDF Source #
Instance details Defined in Currycarbon.Types Methods (==) :: CalPDF -> CalPDF -> Bool # (/=) :: CalPDF -> CalPDF -> Bool #

data NamedCalExpr Source #

A data type for named calibration expressions

Constructors

NamedCalExpr
Fields _exprID :: String Expression identifier _expr :: CalExpr Expression

Instances

Instances details

Show NamedCalExpr Source #
Instance details Defined in Currycarbon.Types Methods showsPrec :: Int -> NamedCalExpr -> ShowS # show :: NamedCalExpr -> String # showList :: [NamedCalExpr] -> ShowS #
Eq NamedCalExpr Source #
Instance details Defined in Currycarbon.Types Methods (==) :: NamedCalExpr -> NamedCalExpr -> Bool # (/=) :: NamedCalExpr -> NamedCalExpr -> Bool #

data CalExpr Source #

A data type to represent an expression for sum- or product calibration

Constructors

UnCalDate UncalC14
WindowBP TimeWindowBP
WindowBCAD TimeWindowBCAD
CalDate CalPDF
SumCal CalExpr CalExpr
ProductCal CalExpr CalExpr

Instances

Instances details

Show CalExpr Source #
Instance details Defined in Currycarbon.Types Methods showsPrec :: Int -> CalExpr -> ShowS # show :: CalExpr -> String # showList :: [CalExpr] -> ShowS #
Eq CalExpr Source #
Instance details Defined in Currycarbon.Types Methods (==) :: CalExpr -> CalExpr -> Bool # (/=) :: CalExpr -> CalExpr -> Bool #

data TimeWindowBP Source #

Constructors

TimeWindowBP String YearBP YearBP

Instances

Instances details

Show TimeWindowBP Source #
Instance details Defined in Currycarbon.Types Methods showsPrec :: Int -> TimeWindowBP -> ShowS # show :: TimeWindowBP -> String # showList :: [TimeWindowBP] -> ShowS #
Eq TimeWindowBP Source #
Instance details Defined in Currycarbon.Types Methods (==) :: TimeWindowBP -> TimeWindowBP -> Bool # (/=) :: TimeWindowBP -> TimeWindowBP -> Bool #

data TimeWindowBCAD Source #

Constructors

TimeWindowBCAD String YearBCAD YearBCAD

Instances

Instances details

Show TimeWindowBCAD Source #
Instance details Defined in Currycarbon.Types Methods showsPrec :: Int -> TimeWindowBCAD -> ShowS # show :: TimeWindowBCAD -> String # showList :: [TimeWindowBCAD] -> ShowS #
Eq TimeWindowBCAD Source #
Instance details Defined in Currycarbon.Types Methods (==) :: TimeWindowBCAD -> TimeWindowBCAD -> Bool # (/=) :: TimeWindowBCAD -> TimeWindowBCAD -> Bool #

data CalC14 Source #

A data type to represent a human readable summary of a calibrated radiocarbon date

Constructors

CalC14
Fields _calC14id :: String Identifier, e.g. a lab number _calC14RangeSummary :: CalRangeSummary Summary of the range of the calibrated date _calC14HDROneSigma :: [HDR] One-sigma high density regions _calC14HDRTwoSigma :: [HDR] Two-sigma high density regions

Instances

Instances details

Show CalC14 Source #
Instance details Defined in Currycarbon.Types Methods showsPrec :: Int -> CalC14 -> ShowS # show :: CalC14 -> String # showList :: [CalC14] -> ShowS #

data CalRangeSummary Source #

A data type to store a simple range summary of the calibrated date, including the median age

Constructors

CalRangeSummary
Fields _calRangeStartTwoSigma :: YearBCAD Start of the two-sigma age range _calRangeStartOneSigma :: YearBCAD Start of the one-sigma age range _calRangeMedian :: YearBCAD Median age _calRangeStopOneSigma :: YearBCAD End of the one-sigma age range _calRangeStopTwoSigma :: YearBCAD End of the two-sigma age range

Instances

Instances details

Show CalRangeSummary Source #
Instance details Defined in Currycarbon.Types Methods showsPrec :: Int -> CalRangeSummary -> ShowS # show :: CalRangeSummary -> String # showList :: [CalRangeSummary] -> ShowS #

data HDR Source #

A data type to represent a high density region of a probability distribution. A high density region is here defined as an age range, within which the respective cumulative probability (e.g. of an calibrated radiocarbon date density curve) is above a certain threshold

Constructors

HDR
Fields _hdrstart :: YearBCAD Start of the high density region in years calBCAD _hdrstop :: YearBCAD End of the high density region in years calBCAD

Instances

Instances details

Show HDR Source #
Instance details Defined in Currycarbon.Types Methods showsPrec :: Int -> HDR -> ShowS # show :: HDR -> String # showList :: [HDR] -> ShowS #
Eq HDR Source #
Instance details Defined in Currycarbon.Types Methods (==) :: HDR -> HDR -> Bool # (/=) :: HDR -> HDR -> Bool #

data RandomAgeSample Source #

A data type to store random samples drawn from a calPDF

Constructors

RandomAgeSample
Fields _rasId :: String Identifier _rasSamples :: Vector YearBCAD Random samples

Instances

Instances details

Show RandomAgeSample Source #
Instance details Defined in Currycarbon.Types Methods showsPrec :: Int -> RandomAgeSample -> ShowS # show :: RandomAgeSample -> String # showList :: [RandomAgeSample] -> ShowS #