cfdm.NumpyArray

---

class cfdm.NumpyArray(array=None, source=None, copy=True)

Bases: cfdm.data.mixin.arraymixin.ArrayMixin, cfdm.core.data.numpyarray.NumpyArray

An underlying numpy array.

New in version (cfdm): 1.7.0

Initialisation

Parameters

array: numpy.ndarray

The numpy array.

source: optional

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

All other parameters, apart from copy, are ignored and their values are instead inferred from source by assuming that it has the NumpyArray 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 NumpyArray instance then cfdm.NumpyArray(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_subspace	Return a subspace, defined by indices, of a numpy array.

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.

Miscellaneous

copy	Return a deep copy of the array.
to_memory	Bring data on disk into memory.
get_filename	The name of the file containing the array.
get_filenames	Return the names of any files containing the data array.

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.