Safe Haskell	Safe-Inferred
Language	GHC2021

Telescope.Fits.Types

Synopsis

data Fits = Fits {
- primaryHDU :: PrimaryHDU
- extensions :: [Extension]
}
data PrimaryHDU = PrimaryHDU {
- header :: Header
- dataArray :: DataArray
}
data ImageHDU = ImageHDU {
- header :: Header
- dataArray :: DataArray
}
data BinTableHDU = BinTableHDU {
- header :: Header
- pCount :: Int
- heap :: ByteString
- dataArray :: DataArray
}
data DataArray = DataArray {
- bitpix :: BitPix
- axes :: Axes Column
- rawData :: ByteString
}
data Extension
- = Image ImageHDU
- | BinTable BinTableHDU
type Axis = Int
newtype Axes a = Axes {
- axes :: [Axis]
}
data Row
data Column
rowMajor :: Axes Column -> Axes Row
columnMajor :: Axes Row -> Axes Column
data BitPix
- = BPInt8
- | BPInt16
- | BPInt32
- | BPInt64
- | BPFloat
- | BPDouble
bitPixBits :: BitPix -> Int
newtype Header = Header {
- _records :: [HeaderRecord]
}
getKeywords :: Header -> [KeywordRecord]
data HeaderRecord
- = Keyword KeywordRecord
- | Comment Text
- | BlankLine
data KeywordRecord = KeywordRecord {
- _keyword :: Text
- _value :: Value
- _comment :: Maybe Text
}
data Value
- = Integer Int
- | Float Float
- | String Text
- | Logic LogicalConstant
data LogicalConstant
- = T
- | F
hduBlockSize :: Int
emptyDataArray :: DataArray

Documentation

data Fits Source #

Constructors

Fits
Fields primaryHDU :: PrimaryHDU extensions :: [Extension]

data PrimaryHDU Source #

Constructors

PrimaryHDU
Fields header :: Header dataArray :: DataArray

data ImageHDU Source #

Constructors

ImageHDU
Fields header :: Header dataArray :: DataArray

data BinTableHDU Source #

Constructors

BinTableHDU
Fields header :: Header pCount :: Int heap :: ByteString dataArray :: DataArray

data DataArray Source #

Constructors

DataArray
Fields bitpix :: BitPix axes :: Axes Column rawData :: ByteString

Instances

Instances details

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

data Extension Source #

Constructors

Image ImageHDU
BinTable BinTableHDU

type Axis = Int Source #

newtype Axes a Source #

Constructors

Axes
Fields axes :: [Axis]

Instances

Instances details

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

data Row Source #

data Column Source #

rowMajor :: Axes Column -> Axes Row Source #

columnMajor :: Axes Row -> Axes Column Source #

data BitPix Source #

Constructors

BPInt8
BPInt16
BPInt32
BPInt64
BPFloat
BPDouble

Instances

Instances details

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

bitPixBits :: BitPix -> Int Source #

newtype Header #

The header part of the HDU is vital carrying not only authorship metadata, but also specifying how to make sense of the binary payload that starts 2,880 bytes after the start of the HeaderData.

Constructors

Header
Fields _records :: [HeaderRecord]

Instances

Instances details

Monoid Header
Instance details Defined in Data.Fits Methods mempty :: Header # mappend :: Header -> Header -> Header # mconcat :: [Header] -> Header #
Semigroup Header
Instance details Defined in Data.Fits Methods (<>) :: Header -> Header -> Header # sconcat :: NonEmpty Header -> Header # stimes :: Integral b => b -> Header -> Header #
Show Header
Instance details Defined in Data.Fits Methods showsPrec :: Int -> Header -> ShowS # show :: Header -> String # showList :: [Header] -> ShowS #
Eq Header
Instance details Defined in Data.Fits Methods (==) :: Header -> Header -> Bool # (/=) :: Header -> Header -> Bool #

getKeywords :: Header -> [KeywordRecord] #

Return all KeywordRecords from the header, filtering out full-line comments and blanks

data HeaderRecord #

Constructors

Keyword KeywordRecord
Comment Text
BlankLine

Instances

Instances details

Show HeaderRecord
Instance details Defined in Data.Fits Methods showsPrec :: Int -> HeaderRecord -> ShowS # show :: HeaderRecord -> String # showList :: [HeaderRecord] -> ShowS #
Eq HeaderRecord
Instance details Defined in Data.Fits Methods (==) :: HeaderRecord -> HeaderRecord -> Bool # (/=) :: HeaderRecord -> HeaderRecord -> Bool #

data KeywordRecord #

Constructors

KeywordRecord
Fields _keyword :: Text _value :: Value _comment :: Maybe Text

Instances

Instances details

Show KeywordRecord
Instance details Defined in Data.Fits Methods showsPrec :: Int -> KeywordRecord -> ShowS # show :: KeywordRecord -> String # showList :: [KeywordRecord] -> ShowS #
Eq KeywordRecord
Instance details Defined in Data.Fits Methods (==) :: KeywordRecord -> KeywordRecord -> Bool # (/=) :: KeywordRecord -> KeywordRecord -> Bool #

data Value #

Value datatype for discriminating valid FITS KEYWORD=VALUE types in an HDU.

Constructors

Integer Int
Float Float
String Text
Logic LogicalConstant

Instances

Instances details

Show Value
Instance details Defined in Data.Fits Methods showsPrec :: Int -> Value -> ShowS # show :: Value -> String # showList :: [Value] -> ShowS #
Eq Value
Instance details Defined in Data.Fits Methods (==) :: Value -> Value -> Bool # (/=) :: Value -> Value -> Bool #

data LogicalConstant #

Direct encoding of a Bool for parsing Value

Constructors

T
F

Instances

Instances details

Show LogicalConstant
Instance details Defined in Data.Fits Methods showsPrec :: Int -> LogicalConstant -> ShowS # show :: LogicalConstant -> String # showList :: [LogicalConstant] -> ShowS #
Eq LogicalConstant
Instance details Defined in Data.Fits Methods (==) :: LogicalConstant -> LogicalConstant -> Bool # (/=) :: LogicalConstant -> LogicalConstant -> Bool #

hduBlockSize :: Int #

The size of an HDU block is fixed at thirty-six eighty byte words. In other words 2,880 bytes. These blocks are padded with zeros to this boundary.

emptyDataArray :: DataArray Source #