cfdm.NetCDFArray

---

class cfdm.NetCDFArray(filename=None, ncvar=None, varid=None, group=None, dtype=None, ndim=None, shape=None, size=None, mask=True, units=False, calendar=False, missing_values=None, source=None, copy=True)

Bases: cfdm.data.abstract.array.Array

An underlying array stored in a netCDF file.

New in version (cfdm): 1.7.0

Initialisation

Parameters

filename: str

The name of the netCDF file containing the array.

ncvar: str, optional

The name of the netCDF variable containing the array. Required unless varid is set.

varid: int, optional

The UNIDATA netCDF interface ID of the variable containing the array. Required if ncvar is not set, ignored if ncvar is set.

group: None or sequence of str, optional

Specify the netCDF4 group to which the netCDF variable belongs. By default, or if group is None or an empty sequence, it assumed to be in the root group. The last element in the sequence is the name of the group in which the variable lies, with other elements naming any parent groups (excluding the root group).

Parameter example:

To specify that a variable is in the root group: group=() or group=None

Parameter example:

To specify that a variable is in the group ‘/forecasts’: group=['forecasts']

Parameter example:

To specify that a variable is in the group ‘/forecasts/model2’: group=['forecasts', 'model2']

New in version (cfdm): 1.8.6.0

dtype: numpy.dtype

The data type of the array in the netCDF file. May be None if the numpy data-type is not known (which can be the case for netCDF string types, for example).

shape: tuple

The array dimension sizes in the netCDF file.

size: int

Number of elements in the array in the netCDF file.

ndim: int

The number of array dimensions in the netCDF file.

mask: bool

If True (the default) then mask by convention when reading data from disk.

A netCDF array is masked depending on the values of any of the netCDF variable attributes valid_min, valid_max, valid_range, _FillValue and missing_value.

New in version (cfdm): 1.8.2

units: str or None, optional

The units of the netCDF variable. Set to None to indicate that there are no units. If unset then the units will be set during the first __getitem__ call.

New in version (cfdm): 1.10.0.1

calendar: str or None, optional

The calendar of the netCDF variable. By default, or if set to None, then the CF default calendar is assumed, if applicable. If unset then the calendar will be set during the first __getitem__ call.

New in version (cfdm): 1.10.0.1

missing_values: dict, optional

The missing value indicators defined by the netCDF variable attributes. See get_missing_values for details.

New in version (cfdm): 1.10.0.3

source: optional

Convert source, which can be any type of object, to a NetCDFArray instance.

All other parameters, apart from copy, are ignored and their values are instead inferred from source by assuming that it has the NetCDFArray API. Any parameters that can not be retrieved from source in this way are assumed to have their default value.

Note that if x is also a NetCDFArray instance then cfdm.NetCDFArray(source=x) is equivalent to x.copy().

New in version (cfdm): 1.10.0.0

copy: bool, optional

If True (the default) then deep copy the input parameters prior to initialisation. By default the parameters are not deep copied.

New in version (cfdm): 1.10.0.0

Inspection

Methods

get_ncvar	The name of the netCDF variable containing the array.
get_varid	The UNIDATA netCDF interface ID of the array’s variable.
get_compression_type	Returns the array’s compression type.
get_subspace	Return a subspace, defined by indices, of a numpy array.
get_missing_values	The missing value indicators from the netCDF variable.

Attributes

array	Return an independent numpy array containing the data.
dtype	Data-type of the data elements.
ndim	Number of array dimensions.
shape	Tuple of array dimension sizes.
size	Number of elements in the array.

Units

Methods

get_calendar	The calendar of the array.
get_units	The units of the array.

File

Methods

close	Close the dataset containing the data.
open	Returns an open dataset containing the data array.
get_filename	The name of the file containing the array.
get_filenames	Return the names of any files containing the data array.
get_group	The netCDF4 group structure of the netCDF variable.
get_mask	Whether or not to automatically mask the data.
file_address	The file name and address.
get_address	The address in the file of the variable.

Miscellaneous

copy	Return a deep copy of the array.
to_memory	Bring data on disk into memory.

Special

__getitem__

Returns a subspace of the array as a numpy array.

Docstring substitutions

Methods

_docstring_special_substitutions	Return the special docstring substitutions.
_docstring_substitutions	Returns the substitutions that apply to methods of the class.
_docstring_package_depth	Returns the class {{package}} substitutions package depth.
_docstring_method_exclusions	Returns method names excluded in the class substitutions.