Safe Haskell | None |
---|---|
Language | GHC2021 |
Telescope.Fits.Header
Synopsis
- newtype Header = Header {
- _records :: [HeaderRecord]
- data Value
- keyword :: Text -> Value -> Maybe Text -> HeaderRecord
- addComment :: Text -> KeywordRecord -> KeywordRecord
- class FromHeader a where
- class FromKeyword a where
- class ToHeader a where
- class ToKeyword a where
- toKeywordValue :: a -> Value
- toKeywordRecord :: Text -> a -> KeywordRecord
- parseKeyword :: forall a (es :: [Effect]). (FromKeyword a, Parser :> es) => Text -> Header -> Eff es a
- lookupKeyword :: Text -> Header -> Maybe Value
- findKeyword :: (KeywordRecord -> Bool) -> Header -> Maybe Value
- isKeyword :: Text -> KeywordRecord -> Bool
- newtype HeaderFor a = HeaderFor a
- data LogicalConstant
- getKeywords :: Header -> [KeywordRecord]
- data HeaderRecord
- data KeywordRecord = KeywordRecord {}
Documentation
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
|
Value
datatype for discriminating valid FITS KEYWORD=VALUE types in an HDU.
addComment :: Text -> KeywordRecord -> KeywordRecord Source #
Set the comment of a KeywordRecrod
Parsing Headers
class FromHeader a where Source #
Minimal complete definition
Nothing
class FromKeyword a where Source #
Instances
FromKeyword CType Source # | |
Defined in Telescope.Fits.Header.Class | |
FromKeyword CUnit Source # | |
Defined in Telescope.Fits.Header.Class | |
FromKeyword Text Source # | |
Defined in Telescope.Fits.Header.Class | |
FromKeyword Bool Source # | |
Defined in Telescope.Fits.Header.Class | |
FromKeyword Float Source # | |
Defined in Telescope.Fits.Header.Class | |
FromKeyword Int Source # | |
Defined in Telescope.Fits.Header.Class |
Creating Headers
class ToHeader a where Source #
Minimal complete definition
Nothing
Methods
class ToKeyword a where Source #
Minimal complete definition
Methods
toKeywordValue :: a -> Value Source #
toKeywordRecord :: Text -> a -> KeywordRecord Source #
default toKeywordRecord :: Text -> a -> KeywordRecord Source #
Instances
parseKeyword :: forall a (es :: [Effect]). (FromKeyword a, Parser :> es) => Text -> Header -> Eff es a Source #
Keyword Lookup
findKeyword :: (KeywordRecord -> Bool) -> Header -> Maybe Value Source #
Constructors
HeaderFor a |
Re-exports
data LogicalConstant #
Instances
Show LogicalConstant | |
Defined in Data.Fits Methods showsPrec :: Int -> LogicalConstant -> ShowS # show :: LogicalConstant -> String # showList :: [LogicalConstant] -> ShowS # | |
Eq LogicalConstant | |
Defined in Data.Fits Methods (==) :: LogicalConstant -> LogicalConstant -> Bool # (/=) :: LogicalConstant -> LogicalConstant -> Bool # |
getKeywords :: Header -> [KeywordRecord] #
Return all KeywordRecord
s 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
Show HeaderRecord | |
Defined in Data.Fits Methods showsPrec :: Int -> HeaderRecord -> ShowS # show :: HeaderRecord -> String # showList :: [HeaderRecord] -> ShowS # | |
Eq HeaderRecord | |
Defined in Data.Fits |
data KeywordRecord #
A single 80 character header keyword line of the form: KEYWORD = VALUE / comment KEYWORD=VALUE
Instances
Show KeywordRecord | |
Defined in Data.Fits Methods showsPrec :: Int -> KeywordRecord -> ShowS # show :: KeywordRecord -> String # showList :: [KeywordRecord] -> ShowS # | |
Eq KeywordRecord | |
Defined in Data.Fits Methods (==) :: KeywordRecord -> KeywordRecord -> Bool # (/=) :: KeywordRecord -> KeywordRecord -> Bool # |