cfdm.Data¶
-
class
cfdm.
Data
(array=None, units=None, calendar=None, fill_value=None, source=None, copy=True, dtype=None, mask=None, _use_array=True, **kwargs)[source]¶ Bases:
cfdm.mixin.container.Container
,cfdm.mixin.netcdf.NetCDFHDF5
,cfdm.core.data.data.Data
An orthogonal multidimensional array with masked values and units.
New in version 1.7.0.
Initialization
- Parameters
- array: numpy array-like or subclass of
Array
, optional The array of values. Ignored if the source parameter is set.
- Parameter example:
array=[34.6]
- Parameter example:
array=[[1, 2], [3, 4]]
- Parameter example:
array=numpy.ma.arange(10).reshape(2, 1, 5)
- 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
, thenumpy
fill value appropriate to the array’s data type will be used (seenumpy.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.
- dtype: data-type, optional
The desired data-type for the data. By default the data-type will be inferred form the array parameter.
The data-type may also be set after initialisation with the
dtype
attribute.- Parameter example:
dtype=float
- Parameter example:
dtype='float32'
- Parameter example:
dtype=numpy.dtype('i2')
- mask: optional
Apply this mask to the data given by the array parameter. By default, or if mask is
None
, no mask is applied. May be any scalar or array-like object (such as anumpy
array orData
instance) that is scalar or has the same shape as array. Masking will be carried out where mask elements evaluate toTrue
.This mask will applied in addition to any mask already defined by the array parameter.
- source: optional
Initialize the array, units, calendar and fill value from those of source.
- copy:
bool
, optional If False then do not deep copy input parameters prior to initialization. By default arguments are deep copied.
- kwargs: ignored
Not used. Present to facilitate subclassing.
- array: numpy array-like or subclass of
Inspection¶
Attributes
Return an independent numpy array containing the data. |
|
Data-type of the data elements. |
|
Number of data dimensions. |
|
Tuple of data dimension sizes. |
|
Number of elements in the data. |
Units¶
Delete the units. |
|
Return the units. |
|
Whether units have been set. |
|
Set the units. |
|
Delete the calendar. |
|
Return the calendar. |
|
Whether a calendar has been set. |
|
Set the calendar. |
Data creation routines¶
Data manipulation routines¶
Changing number of dimensions¶
Expand the shape of the data array. |
|
Remove size 1 axes from the data. |
Date-time support¶
Delete the calendar. |
|
Return the calendar. |
|
Whether a calendar has been set. |
|
Set the calendar. |
Attributes
Return an independent numpy array containing the date-time objects corresponding to times since a reference date. |
|
Return an independent numpy array containing string representations of times since a reference date. |
Indexing routines¶
Single value selection¶
Return the first element of the data as a scalar. |
|
Return the second element of the data as a scalar. |
|
Return the last element of the data as a scalar. |
Logic functions¶
Mask support¶
Apply masking. |
|
Delete the fill value. |
|
Return the missing data value. |
|
Whether a fill value has been set. |
|
Set the missing data value. |
Attributes
The boolean missing data mask of the data array. |
Mathematical functions¶
Sorting, searching, and counting¶
Statistics¶
Order statistics¶
Return the maximum of an array or the maximum along axes. |
|
Return the minimum of an array or minimum along axes. |
Compression by convention¶
Return the dimensions that have compressed in the underlying array. |
|
Return the position of the compressed dimension in the compressed array. |
|
Return the type of compression applied to the underlying array. |
|
Return the count variable for a compressed array. |
|
Return the index variable for a compressed array. |
|
Return the list variable for a compressed array. |
|
Uncompress the underlying array. |
Attributes
Return an independent numpy array containing the compressed data. |
Performance¶
TODO |
|
TODO |
|
TODO |
|
Special¶
The numpy array interface. |
|
Called by the |
|
Return a subspace of the data defined by indices |
|
Called by the |
|
Called when an iterator is required. |
|
Called by the |
|
Assign to data elements defined by indices. |
|
Called by the |