cfdm.Array


class cfdm.Array(**kwargs)[source]

Bases: cfdm.data.mixin.arraymixin.ArrayMixin, 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
kwargs: optional

Named parameters and their values that define the array.

Inspection

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.

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.

Special

Methods

__array__

The numpy array interface.

__deepcopy__

Called by the copy.deepcopy function.

__getitem__

Return a subspace as an independent numpy array.

__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.