Safe Haskell	Safe
Language	Haskell98

Data.NetCDF.Metadata

Description

NetCDF file metadata handling: when a NetCDF file is opened, metadata defining the dimensions, variables and attributes in the file are read all at once to create a value of type NcInfo.

Synopsis

type Name = String
data NcDim = NcDim {
- ncDimName :: Name
- ncDimLength :: Int
- ncDimUnlimited :: Bool
}
data NcAttr
- = NcAttrByte [Word8]
- | NcAttrChar [Char]
- | NcAttrShort [CShort]
- | NcAttrInt [CInt]
- | NcAttrFloat [CFloat]
- | NcAttrDouble [CDouble]
class ToNcAttr a where
- toAttr :: a -> NcAttr
class FromNcAttr a where
- fromAttr :: NcAttr -> Maybe a
data NcVar = NcVar {
- ncVarName :: Name
- ncVarType :: NcType
- ncVarDims :: [NcDim]
- ncVarAttrs :: Map Name NcAttr
}
data NcInfo a = NcInfo {
- ncName :: FilePath
- ncDims :: Map Name NcDim
- ncVars :: Map Name NcVar
- ncAttrs :: Map Name NcAttr
- ncId :: NcId
- ncVarIds :: Map Name NcId
}
data NcRead
data NcWrite
ncDim :: NcInfo a -> Name -> Maybe NcDim
ncAttr :: NcInfo a -> Name -> Maybe NcAttr
ncVar :: NcInfo a -> Name -> Maybe NcVar
ncVarAttr :: NcVar -> Name -> Maybe NcAttr
emptyNcInfo :: FilePath -> NcInfo NcWrite
addNcDim :: NcDim -> NcInfo NcWrite -> NcInfo NcWrite
addNcVar :: NcVar -> NcInfo NcWrite -> NcInfo NcWrite
addNcAttr :: Name -> NcAttr -> NcInfo NcWrite -> NcInfo NcWrite
addNcVarAttr :: Name -> NcAttr -> NcVar -> NcVar
(#) :: a -> (a -> b) -> b

Documentation

type Name = String Source #

Names for dimensions, variables, attributes.

data NcDim Source #

Information about a dimension: name, number of entries and whether unlimited.

Constructors

NcDim
Fields ncDimName :: Name ncDimLength :: Int ncDimUnlimited :: Bool

Instances

Show NcDim Source #
Instance details Defined in Data.NetCDF.Metadata Methods showsPrec :: Int -> NcDim -> ShowS # show :: NcDim -> String # showList :: [NcDim] -> ShowS #

data NcAttr Source #

Attribute value.

Constructors

NcAttrByte [Word8]
NcAttrChar [Char]
NcAttrShort [CShort]
NcAttrInt [CInt]
NcAttrFloat [CFloat]
NcAttrDouble [CDouble]

Instances

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

class ToNcAttr a where Source #

Methods

toAttr :: a -> NcAttr Source #

Instances

ToNcAttrHelp a => ToNcAttr a Source #
Instance details Defined in Data.NetCDF.Metadata Methods toAttr :: a -> NcAttr Source #
ToNcAttrHelp a => ToNcAttr [a] Source #
Instance details Defined in Data.NetCDF.Metadata Methods toAttr :: [a] -> NcAttr Source #

class FromNcAttr a where Source #

Conversion from attribute values to Haskell types.

Methods

fromAttr :: NcAttr -> Maybe a Source #

Instances

FromNcAttr Char Source #
Instance details Defined in Data.NetCDF.Metadata Methods fromAttr :: NcAttr -> Maybe Char Source #
FromNcAttr Word8 Source #
Instance details Defined in Data.NetCDF.Metadata Methods fromAttr :: NcAttr -> Maybe Word8 Source #
FromNcAttr CShort Source #
Instance details Defined in Data.NetCDF.Metadata Methods fromAttr :: NcAttr -> Maybe CShort Source #
FromNcAttr CInt Source #
Instance details Defined in Data.NetCDF.Metadata Methods fromAttr :: NcAttr -> Maybe CInt Source #
FromNcAttr CFloat Source #
Instance details Defined in Data.NetCDF.Metadata Methods fromAttr :: NcAttr -> Maybe CFloat Source #
FromNcAttr CDouble Source #
Instance details Defined in Data.NetCDF.Metadata Methods fromAttr :: NcAttr -> Maybe CDouble Source #
FromNcAttr [Char] Source #
Instance details Defined in Data.NetCDF.Metadata Methods fromAttr :: NcAttr -> Maybe [Char] Source #
FromNcAttr [Word8] Source #
Instance details Defined in Data.NetCDF.Metadata Methods fromAttr :: NcAttr -> Maybe [Word8] Source #
FromNcAttr [CShort] Source #
Instance details Defined in Data.NetCDF.Metadata Methods fromAttr :: NcAttr -> Maybe [CShort] Source #
FromNcAttr [CInt] Source #
Instance details Defined in Data.NetCDF.Metadata Methods fromAttr :: NcAttr -> Maybe [CInt] Source #
FromNcAttr [CFloat] Source #
Instance details Defined in Data.NetCDF.Metadata Methods fromAttr :: NcAttr -> Maybe [CFloat] Source #
FromNcAttr [CDouble] Source #
Instance details Defined in Data.NetCDF.Metadata Methods fromAttr :: NcAttr -> Maybe [CDouble] Source #

data NcVar Source #

Information about a variable: name, type, dimensions and attributes.

Constructors

NcVar
Fields ncVarName :: Name ncVarType :: NcType ncVarDims :: [NcDim] ncVarAttrs :: Map Name NcAttr

Instances

Show NcVar Source #
Instance details Defined in Data.NetCDF.Metadata Methods showsPrec :: Int -> NcVar -> ShowS # show :: NcVar -> String # showList :: [NcVar] -> ShowS #

data NcInfo a Source #

Metadata information for a whole NetCDF file.

Constructors

NcInfo
Fields ncName :: FilePath File name. ncDims :: Map Name NcDim Dimensions defined in file. ncVars :: Map Name NcVar Variables defined in file. ncAttrs :: Map Name NcAttr Global attributes defined in file. ncId :: NcId Low-level file access ID. ncVarIds :: Map Name NcId Low-level IDs for variables.

Instances

Show (NcInfo a) Source #
Instance details Defined in Data.NetCDF.Metadata Methods showsPrec :: Int -> NcInfo a -> ShowS # show :: NcInfo a -> String # showList :: [NcInfo a] -> ShowS #