Safe Haskell	None
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 :: Major) = Axes {
- axes :: [Axis]
}
data Major
- = Row
- | 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
class IsBitPix (a :: k) where
- bitPix :: BitPix

Documentation

data Fits Source #

Constructors

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

Instances

Instances details

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

data PrimaryHDU Source #

Constructors

PrimaryHDU
Fields header :: Header dataArray :: DataArray

Instances

Instances details

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

data ImageHDU Source #

Constructors

ImageHDU
Fields header :: Header dataArray :: DataArray

Instances

Instances details

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

data BinTableHDU Source #

Constructors

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

Instances

Instances details

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

data DataArray Source #

Raw HDU Data. See DataArray

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

Instances

Instances details

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

type Axis = Int Source #

newtype Axes (a :: Major) Source #

Constructors

Axes
Fields axes :: [Axis]

Instances

Instances details

IsList (Axes 'Row) Source #

Instance details

Defined in Telescope.Data.Axes

Associated Types

type Item (Axes 'Row)
Instance details Defined in Telescope.Data.Axes type Item (Axes 'Row) = Axis

Methods

fromList :: [Item (Axes 'Row)] -> Axes 'Row #

fromListN :: Int -> [Item (Axes 'Row)] -> Axes 'Row #

toList :: Axes 'Row -> [Item (Axes 'Row)] #

Show (Axes a) Source #

Instance details

Defined in Telescope.Data.Axes

Methods

showsPrec :: Int -> Axes a -> ShowS #

show :: Axes a -> String #

showList :: [Axes a] -> ShowS #

Eq (Axes a) Source #

Instance details

Defined in Telescope.Data.Axes

Methods

(==) :: Axes a -> Axes a -> Bool #

(/=) :: Axes a -> Axes a -> Bool #

ToAsdf (Axes 'Row) Source #

Instance details

Defined in Telescope.Asdf.Class

Methods

toValue :: Axes 'Row -> Value Source #

schema :: Axes 'Row -> SchemaTag Source #

anchor :: Axes 'Row -> Maybe Anchor Source #

toNode :: Axes 'Row -> Node Source #

type Item (Axes 'Row) Source #

Instance details

Defined in Telescope.Data.Axes

type Item (Axes 'Row) = Axis

data Major Source #

Constructors

Row
Column

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 #

Headers contain lines that are any of the following

KEYWORD = VALUE / inline comment
COMMENT full line comment
(blank)

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 #

A single 80 character header keyword line of the form: KEYWORD = VALUE / comment KEYWORD=VALUE

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 #

class IsBitPix (a :: k) where Source #

Methods

bitPix :: BitPix Source #

Instances

Instances details

IsBitPix Int16 Source #
Instance details Defined in Telescope.Fits.Types Methods bitPix :: BitPix Source #
IsBitPix Int32 Source #
Instance details Defined in Telescope.Fits.Types Methods bitPix :: BitPix Source #
IsBitPix Int64 Source #
Instance details Defined in Telescope.Fits.Types Methods bitPix :: BitPix Source #
IsBitPix Int8 Source #
Instance details Defined in Telescope.Fits.Types Methods bitPix :: BitPix Source #
IsBitPix Double Source #
Instance details Defined in Telescope.Fits.Types Methods bitPix :: BitPix Source #
IsBitPix Float Source #
Instance details Defined in Telescope.Fits.Types Methods bitPix :: BitPix Source #