Safe Haskell	Safe-Inferred
Language	GHC2021

Telescope.Fits.Header

Contents

Parsing Headers
Creating Headers
Keyword Lookup
Re-exports

Synopsis

newtype Header = Header {
- records :: [HeaderRecord]
}
data Value
- = Integer Int
- | Float Double
- | String Text
- | Logic LogicalConstant
keyword :: Text -> Value -> Maybe Text -> HeaderRecord
addComment :: Text -> KeywordRecord -> KeywordRecord
class FromHeader a where
- parseHeader :: Parser :> es => Header -> Eff es a
class FromKeyword a where
- parseKeywordValue :: Parser :> es => Value -> Eff es a
class ToHeader a where
- toHeader :: a -> Header
class ToKeyword a where
- toKeywordValue :: a -> Value
- toKeywordRecord :: Text -> a -> KeywordRecord
parseKeyword :: (FromKeyword a, Parser :> es) => Text -> Header -> Eff es a
lookupKeyword :: Text -> Header -> Maybe Value
findKeyword :: (KeywordRecord -> Bool) -> Header -> Maybe Value
isKeyword :: Text -> KeywordRecord -> Bool
keywords :: Header -> [KeywordRecord]
newtype HeaderFor a = HeaderFor a
data LogicalConstant
- = T
- | F
data HeaderRecord
- = Keyword KeywordRecord
- | Comment Text
- | History Text
- | BlankLine
data KeywordRecord = KeywordRecord {
- keyword :: Text
- value :: Value
- comment :: Maybe Text
}

Documentation

newtype Header Source #

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

data Value Source #

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

Constructors

Integer Int
Float Double
String Text
Logic LogicalConstant

Instances

Instances details

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

keyword :: Text -> Value -> Maybe Text -> HeaderRecord Source #

Construct a keyword HeaderRecord

addComment :: Text -> KeywordRecord -> KeywordRecord Source #

Set the comment of a KeywordRecrod

Parsing Headers

class FromHeader a where Source #

Minimal complete definition

Nothing

Methods

parseHeader :: Parser :> es => Header -> Eff es a Source #

default parseHeader :: (Generic a, GFromHeader (Rep a), Parser :> es) => Header -> Eff es a Source #

Instances

Instances details

FromHeader Header Source #
Instance details Defined in Telescope.Fits.Header.Class Methods parseHeader :: forall (es :: [Effect]). Parser :> es => Header -> Eff es Header Source #
FromHeader [HeaderRecord] Source #
Instance details Defined in Telescope.Fits.Header.Class Methods parseHeader :: forall (es :: [Effect]). Parser :> es => Header -> Eff es [HeaderRecord] Source #
(AxisOrder ax, KnownText alt) => FromHeader (WCSAxis alt ax) Source #
Instance details Defined in Telescope.Fits.Header.Class Methods parseHeader :: forall (es :: [Effect]). Parser :> es => Header -> Eff es (WCSAxis alt ax) Source #

class FromKeyword a where Source #

Methods

parseKeywordValue :: Parser :> es => Value -> Eff es a Source #

Instances

Instances details

FromKeyword CType Source #
Instance details Defined in Telescope.Fits.Header.Class Methods parseKeywordValue :: forall (es :: [Effect]). Parser :> es => Value -> Eff es CType Source #
FromKeyword CUnit Source #
Instance details Defined in Telescope.Fits.Header.Class Methods parseKeywordValue :: forall (es :: [Effect]). Parser :> es => Value -> Eff es CUnit Source #
FromKeyword Text Source #
Instance details Defined in Telescope.Fits.Header.Class Methods parseKeywordValue :: forall (es :: [Effect]). Parser :> es => Value -> Eff es Text Source #
FromKeyword UTCTime Source #
Instance details Defined in Telescope.Fits.Header.Class Methods parseKeywordValue :: forall (es :: [Effect]). Parser :> es => Value -> Eff es UTCTime Source #
FromKeyword Bool Source #
Instance details Defined in Telescope.Fits.Header.Class Methods parseKeywordValue :: forall (es :: [Effect]). Parser :> es => Value -> Eff es Bool Source #
FromKeyword Double Source #
Instance details Defined in Telescope.Fits.Header.Class Methods parseKeywordValue :: forall (es :: [Effect]). Parser :> es => Value -> Eff es Double Source #
FromKeyword Float Source #
Instance details Defined in Telescope.Fits.Header.Class Methods parseKeywordValue :: forall (es :: [Effect]). Parser :> es => Value -> Eff es Float Source #
FromKeyword Int Source #
Instance details Defined in Telescope.Fits.Header.Class Methods parseKeywordValue :: forall (es :: [Effect]). Parser :> es => Value -> Eff es Int Source #

Creating Headers

class ToHeader a where Source #

Minimal complete definition

Nothing

Methods

toHeader :: a -> Header Source #

default toHeader :: (Generic a, GToHeader (Rep a)) => a -> Header Source #

Instances

Instances details

ToHeader Header Source #
Instance details Defined in Telescope.Fits.Header.Class Methods toHeader :: Header -> Header Source #
ToHeader HeaderRecord Source #
Instance details Defined in Telescope.Fits.Header.Class Methods toHeader :: HeaderRecord -> Header Source #
ToHeader a => ToHeader (Maybe a) Source #
Instance details Defined in Telescope.Fits.Header.Class Methods toHeader :: Maybe a -> Header Source #
ToHeader a => ToHeader [a] Source #
Instance details Defined in Telescope.Fits.Header.Class Methods toHeader :: [a] -> Header Source #
(AxisOrder ax, KnownText alt) => ToHeader (WCSAxis alt ax) Source #
Instance details Defined in Telescope.Fits.Header.Class Methods toHeader :: WCSAxis alt ax -> Header Source #

class ToKeyword a where Source #

Minimal complete definition

toKeywordValue

Methods

toKeywordValue :: a -> Value Source #

toKeywordRecord :: Text -> a -> KeywordRecord Source #

default toKeywordRecord :: Text -> a -> KeywordRecord Source #

Instances

Instances details

ToKeyword CType Source #
Instance details Defined in Telescope.Fits.Header.Class Methods toKeywordValue :: CType -> Value Source # toKeywordRecord :: Text -> CType -> KeywordRecord Source #
ToKeyword CUnit Source #
Instance details Defined in Telescope.Fits.Header.Class Methods toKeywordValue :: CUnit -> Value Source # toKeywordRecord :: Text -> CUnit -> KeywordRecord Source #
ToKeyword Text Source #
Instance details Defined in Telescope.Fits.Header.Class Methods toKeywordValue :: Text -> Value Source # toKeywordRecord :: Text -> Text -> KeywordRecord Source #
ToKeyword UTCTime Source #
Instance details Defined in Telescope.Fits.Header.Class Methods toKeywordValue :: UTCTime -> Value Source # toKeywordRecord :: Text -> UTCTime -> KeywordRecord Source #
ToKeyword Bool Source #
Instance details Defined in Telescope.Fits.Header.Class Methods toKeywordValue :: Bool -> Value Source # toKeywordRecord :: Text -> Bool -> KeywordRecord Source #
ToKeyword Double Source #
Instance details Defined in Telescope.Fits.Header.Class Methods toKeywordValue :: Double -> Value Source # toKeywordRecord :: Text -> Double -> KeywordRecord Source #
ToKeyword Float Source #
Instance details Defined in Telescope.Fits.Header.Class Methods toKeywordValue :: Float -> Value Source # toKeywordRecord :: Text -> Float -> KeywordRecord Source #
ToKeyword Int Source #
Instance details Defined in Telescope.Fits.Header.Class Methods toKeywordValue :: Int -> Value Source # toKeywordRecord :: Text -> Int -> KeywordRecord Source #

parseKeyword :: (FromKeyword a, Parser :> es) => Text -> Header -> Eff es a Source #

Keyword Lookup

lookupKeyword :: Text -> Header -> Maybe Value Source #

Manually look up a keyword from the header

findKeyword :: (KeywordRecord -> Bool) -> Header -> Maybe Value Source #

isKeyword :: Text -> KeywordRecord -> Bool Source #

keywords :: Header -> [KeywordRecord] Source #

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

newtype HeaderFor a Source #

Constructors

HeaderFor a

Instances

Instances details

(ToHeader a, Selector s) => GToHeader (M1 S s (K1 R (HeaderFor a) :: k -> Type) :: k -> Type) Source #
Instance details Defined in Telescope.Fits.Header.Class Methods gToHeader :: forall (p :: k0). M1 S s (K1 R (HeaderFor a)) p -> Header Source #

Re-exports

data LogicalConstant Source #

Direct encoding of a Bool for parsing Value

Constructors

T
F

Instances

Instances details

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

data HeaderRecord Source #

Headers contain lines that are any of the following

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

Constructors

Keyword KeywordRecord
Comment Text
History Text
BlankLine

Instances

Instances details

Show HeaderRecord Source #
Instance details Defined in Telescope.Fits.Header.Header Methods showsPrec :: Int -> HeaderRecord -> ShowS # show :: HeaderRecord -> String # showList :: [HeaderRecord] -> ShowS #
Eq HeaderRecord Source #
Instance details Defined in Telescope.Fits.Header.Header Methods (==) :: HeaderRecord -> HeaderRecord -> Bool # (/=) :: HeaderRecord -> HeaderRecord -> Bool #
ToHeader HeaderRecord Source #
Instance details Defined in Telescope.Fits.Header.Class Methods toHeader :: HeaderRecord -> Header Source #
FromHeader [HeaderRecord] Source #
Instance details Defined in Telescope.Fits.Header.Class Methods parseHeader :: forall (es :: [Effect]). Parser :> es => Header -> Eff es [HeaderRecord] Source #

data KeywordRecord Source #

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 Source #
Instance details Defined in Telescope.Fits.Header.Keyword Methods showsPrec :: Int -> KeywordRecord -> ShowS # show :: KeywordRecord -> String # showList :: [KeywordRecord] -> ShowS #
Eq KeywordRecord Source #
Instance details Defined in Telescope.Fits.Header.Keyword Methods (==) :: KeywordRecord -> KeywordRecord -> Bool # (/=) :: KeywordRecord -> KeywordRecord -> Bool #

Monoid Header Source #
Instance details Defined in Telescope.Fits.Header.Header Methods mempty :: Header # mappend :: Header -> Header -> Header # mconcat :: [Header] -> Header #
Semigroup Header Source #
Instance details Defined in Telescope.Fits.Header.Header Methods (<>) :: Header -> Header -> Header # sconcat :: NonEmpty Header -> Header # stimes :: Integral b => b -> Header -> Header #
Show Header Source #
Instance details Defined in Telescope.Fits.Encoding.Render Methods showsPrec :: Int -> Header -> ShowS # show :: Header -> String # showList :: [Header] -> ShowS #
Eq Header Source #
Instance details Defined in Telescope.Fits.Header.Header Methods (==) :: Header -> Header -> Bool # (/=) :: Header -> Header -> Bool #
FromHeader Header Source #
Instance details Defined in Telescope.Fits.Header.Class Methods parseHeader :: forall (es :: [Effect]). Parser :> es => Header -> Eff es Header Source #
ToHeader Header Source #
Instance details Defined in Telescope.Fits.Header.Class Methods toHeader :: Header -> Header Source #