Variable¶

class metpy.io.cdm.Variable(group, name, datatype, dimensions, fill_value, wrap_array)[source]¶

Holds typed data (using a numpy.ndarray), as well as attributes (e.g. units).

In addition to its various attributes, the Variable supports getting and setting data using the [] operator and indices or slices. Getting data returns numpy.ndarray instances.

Initialize a Variable.

Instead of constructing a Variable directly, you should use Group.createVariable().

Parameters:

group (Group) – The parent Group that owns this Variable.
name (str) – The name of this Variable.
datatype (str or numpy.dtype) – A valid Numpy dtype that describes the layout of each element of the data
dimensions (tuple[str], optional) – The dimensions of this Variable. Defaults to empty, which implies a scalar variable.
fill_value (scalar, optional) – A scalar value that is used to fill the created storage. Defaults to None, which performs no filling, leaving the storage uninitialized.
wrap_array (numpy.ndarray, optional) – Instead of creating an array, the Variable instance will assume ownership of the passed in array as its data storage. This is a performance optimization to avoid copying large data blocks. Defaults to None, which means a new array will be created.

See also

Group.createVariable

Attributes Summary

`datatype`	numpy.dtype – Describes the layout of each element of the data.
`dimensions`	tuple[str] – all the names of `Dimension` used by this `Variable`.
`dtype`	numpy.dtype – Describes the layout of each element of the data.
`name`	str – the name of the variable.
`ndim`	int – the number of dimensions used by this variable.
`shape`	tuple[int] – Describes the size of the Variable along each of its dimensions.
`size`	int – the total number of elements.

Methods Summary

`__init__`(group, name, datatype, dimensions, ...)	Initialize a Variable.
`group`()	Get the Group that owns this Variable.
`ncattrs`()	Get a list of the names of the netCDF attributes.

Attributes Documentation

datatype¶: numpy.dtype – Describes the layout of each element of the data.

dimensions¶: tuple[str] – all the names of Dimension used by this Variable.

dtype¶: numpy.dtype – Describes the layout of each element of the data.

name¶: str – the name of the variable.

ndim¶: int – the number of dimensions used by this variable.

shape¶: tuple[int] – Describes the size of the Variable along each of its dimensions.

size¶: int – the total number of elements.

Methods Documentation

__init__(group, name, datatype, dimensions, fill_value, wrap_array)[source]¶

Initialize a Variable.

Instead of constructing a Variable directly, you should use Group.createVariable().

Parameters:

group (Group) – The parent Group that owns this Variable.
name (str) – The name of this Variable.
datatype (str or numpy.dtype) – A valid Numpy dtype that describes the layout of each element of the data
dimensions (tuple[str], optional) – The dimensions of this Variable. Defaults to empty, which implies a scalar variable.
fill_value (scalar, optional) – A scalar value that is used to fill the created storage. Defaults to None, which performs no filling, leaving the storage uninitialized.
wrap_array (numpy.ndarray, optional) – Instead of creating an array, the Variable instance will assume ownership of the passed in array as its data storage. This is a performance optimization to avoid copying large data blocks. Defaults to None, which means a new array will be created.