theophilusx.netcdf.variables
Functions for manipulating Variable
objects.
-variable->map
(-variable->map v)
A map
which describes a NetCDF variable. Available keys are
key | Description |
---|---|
:description |
A description of the variable |
:name |
The DAP name of the variable |
:type |
The data type of the variable as a keyword |
:attributes |
A vector of attribute maps describing attributes |
associated with the variable. | |
:dimensions |
A vector of dimension maps describing the |
dimensions of the variable. | |
:element-size |
The byte size for elements in this variable. |
:ranges |
A vector of range maps describing the ranges |
for each dimension of this variable. | |
:rank |
The number of dimensions for this variable. |
:shape |
A vector containing the length for each dimension |
in this variable. | |
:size |
Total number of elements in this variable. |
:is-coordinate? |
True if this variable is a coordinate variable. |
:is-metadata? |
True if this variable is metadata |
:is-scalar? |
True if this variable is a scalar variable. |
:is-unlimited? |
True if this variable has an unlimited size |
dimension. | |
:is-variable-length |
True if this variable has a variable length |
dimension. | |
:obj |
The low level raw Java Variable object |
-variable-attributes
(-variable-attributes v)
Extract a vector of attribute map data from a variable. See theophilusx.netcdf.attributes
for description of available map keys.
-variable-coordinate?
(-variable-coordinate? v)
True if the variable is a coordinate variable, false otherwise.
-variable-dap-name
(-variable-dap-name v)
Return string name of variable.
-variable-description
(-variable-description v)
Return a string describing the variable.
-variable-dimensions
(-variable-dimensions v)
Returns a map
representing the dimensions for a variable. See theophilusx.netcdf.dimensions
for a description of the map keys.
-variable-element-size
(-variable-element-size v)
Returns the size of variable elements in bytes.
-variable-metadata?
(-variable-metadata? v)
True if the variable is a metadata variable.
-variable-ranges
(-variable-ranges v)
Return a vector of range maps describing the variable ranges. See theophilusx.netcdf.ranges
for a description of available map keys.
-variable-rank
(-variable-rank v)
Return the number of dimensions (rank) for a variable.
-variable-scalar?
(-variable-scalar? v)
True if this is a scalar variable.
-variable-shape
(-variable-shape v)
Return a vector containing the length of each dimension in the variable.
-variable-size
(-variable-size v)
Return the total number of elements in the variable.
-variable-type
(-variable-type v)
Return symbol representing the variable data type
-variable-unlimited?
(-variable-unlimited? v)
True if this variable has an unlimited dimension.
-variable-variable-length?
(-variable-variable-length? v)
True if this variable has a variable length dimension.
-variables->vector
(-variables->vector var-list)
Returns a vector of variable maps. The var-list
is a collection of Java Variable
objects.
variable
(variable nc var-name)
(variable nc group var-name)
Find a variable by either full name or by supplying group and short name. Returns a variable map.
variable->string
(variable->string v-map)
(variable->string v-map indent)
Return a string representation of the variable details extracted from a variable map
.
variables
(variables nc)
Returns a vector of variable maps representing all the variables defined in a NetCEF file.