cfdm.Array

---

class cfdm.Array(source=None, copy=True)

Bases: cfdm.data.mixin.arraymixin.ArrayMixin, cfdm.mixin.container.Container, cfdm.core.data.abstract.array.Array

Abstract base class for a container of an underlying array.

The form of the array is defined by the initialisation parameters of a subclass.

New in version (cfdm): 1.7.0

Initialisation

Parameters

source: optional

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

All other parameters, apart from copy, are ignored and their values are instead inferred from source by assuming that it has the Array 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 Array instance then cfdm.Array(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

Attributes

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

Units

Methods

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

Compression

Methods

get_compression_type

Returns the array’s compression type.

Miscellaneous

Methods

copy	Return a deep copy of the array.
get_subspace	Return a subspace, defined by indices, of a numpy array.
get_filename	The name of the file containing the array.
get_filenames	Return the names of any files containing the data array.

Special

Methods

__array__	The numpy array interface.
__deepcopy__	Called by the copy.deepcopy function.
__getitem__	Return a subspace of the uncompressed subarray.
__repr__	Called by the repr built-in function.
__str__	Called by the str built-in function.

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.