View Source NetCDF.Variable (NetCDF v0.1.0)

Variable access functions

Link to this section Summary

Functions

Returns a __MODULE__ struct with the variable's values and associated metadata.

Link to this section Types

@type attribute_value() :: atom() | number() | String.t() | [number()] | [String.t()]
@type t() :: %NetCDF.Variable{
  attributes: %{optional(String.t()) => attribute_value()},
  name: String.t(),
  type: variable_type(),
  value: term()
}
@type variable_type() ::
  :i8
  | :i16
  | :i32
  | :i64
  | :u8
  | :u16
  | :u32
  | :u64
  | :f32
  | :f64
  | :non_numeric

Link to this section Functions

Link to this function

load(file, variable_name)

View Source
@spec load(file :: NetCDF.File.t(), variable_name :: String.t()) ::
  {:ok, t()} | {:error, any()}

Returns a __MODULE__ struct with the variable's values and associated metadata.