cfdm.core.Data

class cfdm.core.Data(array=None, units=None, calendar=None, fill_value=None, source=None, copy=True, _use_array=True, _custom_deep_copy=False)[source]

Bases: cfdm.core.abstract.container.Container

An orthogonal multidimensional array with masking and units.

New in version (cfdm): 1.7.0

Initialisation

Parameters
array: data_like, optional

The array of values.

A data_like object is any object that can be converted to a Data object, i.e. numpy array_like objects, Data objects, and cfdm.core instances that contain Data objects.

Note that for Data objects and cfdm.core objects that contain Data objects, cfdm.core.Data(array) is equivalent to cfdm.core.Data(source=array.__data__()).

Ignored if the source parameter is set.

array: numpy array_like, optional

The array of values.

Note that if array is another Data instance then cfdm.core.Data(array) is equivalent to cfdm.core.Data(source=array).

Ignored if the source parameter is set.

units: str, optional

The physical units of the data. Ignored if the source parameter is set.

The units may also be set after initialisation with the set_units method.

Parameter example:

units='km hr-1'

Parameter example:

units='days since 2018-12-01'

calendar: str, optional

The calendar for reference time units. Ignored if the source parameter is set.

The calendar may also be set after initialisation with the set_calendar method.

Parameter example:

calendar='360_day'

fill_value: optional

The fill value of the data. By default, or if set to None, the numpy fill value appropriate to the array’s data type will be used (see numpy.ma.default_fill_value). Ignored if the source parameter is set.

The fill value may also be set after initialisation with the set_fill_value method.

Parameter example:

fill_value=-999.

source: optional

Initialise the data, units, calendar and fill value from those of source.

copy: bool, optional

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

Inspection

Attributes

array

Return an independent numpy array containing the data.

dtype

Data-type of the data elements.

ndim

Number of data dimensions.

shape

Tuple of data dimension sizes.

size

Number of elements in the data.

Units

del_units

Delete the units.

get_units

Return the units.

has_units

Whether units have been set.

set_units

Set the units.

del_calendar

Delete the calendar.

get_calendar

Return the calendar.

has_calendar

Whether a calendar has been set.

set_calendar

Set the calendar.

Data creation routines

From existing data

copy

Return a deep copy of the data.

Date-time support

del_calendar

Delete the calendar.

get_calendar

Return the calendar.

has_calendar

Whether a calendar has been set.

set_calendar

Set the calendar.

Mask support

del_fill_value

Delete the fill value.

get_fill_value

Return the missing data value.

has_fill_value

Whether a fill value has been set.

set_fill_value

Set the missing data value.

Miscellaneous

source

Return the underlying array object.

Special

__deepcopy__

Called by the copy.deepcopy function.

__repr__

Return repr(self).

__str__

Return str(self).

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.