Safe Haskell	Safe-Inferred
Language	GHC2021

Telescope.Fits.Header.Header

Synopsis

newtype Header = Header {
- records :: [HeaderRecord]
}
data HeaderRecord
- = Keyword KeywordRecord
- | Comment Text
- | History Text
- | BlankLine
lookupKeyword :: Text -> Header -> Maybe Value
findKeyword :: (KeywordRecord -> Bool) -> Header -> Maybe Value
keywords :: Header -> [KeywordRecord]
keyword :: Text -> Value -> Maybe Text -> HeaderRecord

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 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 #

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

Manually look up a keyword from the header

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

keywords :: Header -> [KeywordRecord] Source #

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

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

Construct a keyword HeaderRecord

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 #