cf.FullArray

---

class cf.FullArray(fill_value=None, dtype=None, shape=None, attributes=None, source=None, copy=True)

A array filled with a given value.

The array may be empty or all missing values.

Added in version 3.14.0.

Initialisation

Parameters:

fill_valuescalar, optional

The fill value for the array. May be set to cf.masked or np.ma.masked.

dtype: numpy.dtype

The data type of the array.

shape: tuple

The array dimension sizes.

attributes: dict or None, optional

Provide netCDF attributes for the data as a dictionary of key/value pairs.

source: optional

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

All other parameters, apart from copy, are ignored and their values are instead inferred from source by assuming that it has the FullArray 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 FullArray instance then cf.FullArray(source=x) is equivalent to x.copy().

copy: bool, optional

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

Inspection

Methods

get_compression_type	Returns the array's compression type.
get_attributes	The attributes of the array.
index	The index to be applied when converting to a numpy array.
is_subspace	True if the index represents a subspace of the data.

Attributes

array	Return an independent numpy array containing the data.
astype	Cast the data to a specified type.
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.
original_shape	The shape of the data in the file.
reference_shape	The shape of the data in the file with added dimensions.

Full value

Methods

get_full_value	Return the data array fill value.
set_full_value	Set the data array fill value.

Units

Methods

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

Attributes

Units

The Units object containing the units of the array.

Miscellaneous

copy	Return a deep copy of the array.

Special

__getitem__

Returns a subspace of the data as a new FullArray.

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.