xray.DataArray

class xray.DataArray(data, coords=None, dims=None, name=None, attrs=None, encoding=None)

N-dimensional array with labeled coordinates and dimensions.

DataArray provides a wrapper around numpy ndarrays that uses labeled dimensions and coordinates to support metadata aware operations. The API is similar to that for the pandas Series or DataFrame, but DataArray objects can have any number of dimensions, and their contents have fixed data types.

Additional features over raw numpy arrays:

  • Apply operations over dimensions by name: x.sum('time').
  • Select or assign values by integer location (like numpy): x[:10] or by label (like pandas): x.loc['2014-01-01'] or x.sel(time='2014-01-01').
  • Mathematical operations (e.g., x - y) vectorize across multiple dimensions (known in numpy as “broadcasting”) based on dimension names, regardless of their original order.
  • Keep track of arbitrary metadata in the form of a Python dictionary: x.attrs
  • Convert to a pandas Series: x.to_series().

Getting items from or doing mathematical operations with a DataArray always returns another DataArray.

Attributes

dims Dimension names associated with this array.
values The array’s data as a numpy.ndarray
coords Dictionary-like container of coordinate arrays.
name The name of this array.
attrs Dictionary storing arbitrary metadata with this array.
__init__(data, coords=None, dims=None, name=None, attrs=None, encoding=None)
Parameters:

data : array_like

Values for this array. Must be an numpy.ndarray, ndarray like, or castable to an ndarray. If a self-described xray or pandas object, attempts are made to use this array’s metadata to fill in other unspecified arguments. A view of the array’s data is used instead of a copy if possible.

coords : sequence or dict of array_like objects, optional

Coordinates (tick labels) to use for indexing along each dimension. If dict-like, should be a mapping from dimension names to the corresponding coordinates.

dims : str or sequence of str, optional

Name(s) of the the data dimension(s). Must be either a string (only for 1D data) or a sequence of strings with length equal to the number of dimensions. If this argument is omited, dimension names are taken from coords (if possible) and otherwise default to ['dim_0', ... 'dim_n'].

name : str or None, optional

Name of this array.

attrs : dict_like or None, optional

Attributes to assign to the new variable. By default, an empty attribute dictionary is initialized.

encoding : dict_like or None, optional

Dictionary specifying how to encode this array’s data into a serialized format like netCDF4. Currently used keys (for netCDF) include ‘_FillValue’, ‘scale_factor’, ‘add_offset’, ‘dtype’, ‘units’ and ‘calendar’ (the later two only for datetime arrays). Unrecognized keys are ignored.

Methods

__init__(data[, coords, dims, name, attrs, ...])
Parameters:
all([dim, axis, keep_attrs]) Reduce this DataArray’s data by applying all along some dimension(s).
any([dim, axis, keep_attrs]) Reduce this DataArray’s data by applying any along some dimension(s).
argmax([dim, axis, skipna, keep_attrs]) Reduce this DataArray’s data by applying argmax along some dimension(s).
argmin([dim, axis, skipna, keep_attrs]) Reduce this DataArray’s data by applying argmin along some dimension(s).
argsort([axis, kind, order]) Returns the indices that would sort this array.
assign_coords(**kwargs) Assign new coordinates to this object, returning a new object with all the original data in addition to the new coordinates.
astype(dtype[, order, casting, subok, copy]) Copy of the array, cast to a specified type.
broadcast_equals(other) Two DataArrays are broadcast equal if they are equal after broadcasting them against each other such that they have the same dimensions.
chunk([chunks]) Coerce this array’s data into a dask arrays with the given chunks.
clip(a_min, a_max[, out]) Return an array whose values are limited to [a_min, a_max].
conj() Complex-conjugate all elements.
conjugate() Return the complex conjugate, element-wise.
copy([deep]) Returns a copy of this array.
count([dim, axis, keep_attrs]) Reduce this DataArray’s data by applying count along some dimension(s).
drop(labels[, dim]) Drop coordinates or index labels from this DataArray.
dropna(dim[, how, thresh]) Returns a new array with dropped labels for missing values along the provided dimension.
equals(other) True if two DataArrays have the same dimensions, coordinates and values; otherwise False.
fillna(value) Fill missing values in this object.
from_cdms2(variable) Convert a cdms2.Variable into an xray.DataArray
from_series(series) Convert a pandas.Series into an xray.DataArray.
get_axis_num(dim) Return axis number(s) corresponding to dimension(s) in this array.
groupby(group[, squeeze]) Returns a GroupBy object for performing grouped operations.
identical(other) Like equals, but also checks the array name and attributes, and attributes on all coordinates.
isel(**indexers) Return a new DataArray whose dataset is given by integer indexing along the specified dimension(s).
isnull(*args, **kwargs) Detect missing values (NaN in numeric arrays, None/NaN in object arrays)
item(*args) Copy an element of an array to a standard Python scalar and return it.
load() Manually trigger loading of this array’s data from disk or a remote source into memory and return this array.
load_data()
max([dim, axis, skipna, keep_attrs]) Reduce this DataArray’s data by applying max along some dimension(s).
mean([dim, axis, skipna, keep_attrs]) Reduce this DataArray’s data by applying mean along some dimension(s).
median([dim, axis, skipna, keep_attrs]) Reduce this DataArray’s data by applying median along some dimension(s).
min([dim, axis, skipna, keep_attrs]) Reduce this DataArray’s data by applying min along some dimension(s).
notnull(*args, **kwargs) Replacement for numpy.isfinite / -numpy.isnan which is suitable for use on object arrays.
pipe(func, *args, **kwargs) Apply func(self, *args, **kwargs)
plot(darray[, ax, rtol]) Default plot of DataArray using matplotlib / pylab.
plot_contourf(darray[, ax, xincrease, ...]) Filled contour plot of 2d DataArray
plot_line(darray, *args, **kwargs) Line plot of 1 dimensional DataArray index against values
prod([dim, axis, skipna, keep_attrs]) Reduce this DataArray’s data by applying prod along some dimension(s).
reduce(func[, dim, axis, keep_attrs]) Reduce this array by applying func along some dimension(s).
reindex([method, copy]) Conform this object onto a new set of indexes, filling in missing values with NaN.
reindex_like(other[, method, copy]) Conform this object onto the indexes of another object, filling in missing values with NaN.
rename(new_name_or_name_dict) Returns a new DataArray with renamed coordinates and/or a new name.
resample(freq, dim[, how, skipna, closed, ...]) Resample this object to a new temporal resolution.
reset_coords([names, drop, inplace]) Given names of coordinates, reset them to become variables.
round(*args, **kwargs)
searchsorted(v[, side, sorter]) Find indices where elements of v should be inserted in a to maintain order.
sel([method]) Return a new DataArray whose dataset is given by selecting index labels along the specified dimension(s).
squeeze([dim]) Return a new DataArray object with squeezed data.
std([dim, axis, skipna, keep_attrs]) Reduce this DataArray’s data by applying std along some dimension(s).
sum([dim, axis, skipna, keep_attrs]) Reduce this DataArray’s data by applying sum along some dimension(s).
swap_dims(dims_dict) Returns a new DataArray with swapped dimensions.
to_cdms2() Convert this array into a cdms2.Variable
to_dataframe() Convert this array and its coordinates into a tidy pandas.DataFrame.
to_dataset([dim, name]) Convert a DataArray to a Dataset.
to_index() Convert this variable to a pandas.Index.
to_pandas() Convert this array into a pandas object with the same shape.
to_series() Convert this array into a pandas.Series.
transpose(*dims) Return a new DataArray object with transposed dimensions.
var([dim, axis, skipna, keep_attrs]) Reduce this DataArray’s data by applying var along some dimension(s).

Attributes

T
attrs Dictionary storing arbitrary metadata with this array.
chunks Block dimensions for this array’s data or None if it’s not a dask array.
coords Dictionary-like container of coordinate arrays.
data The array’s data as a dask or numpy array
dims Dimension names associated with this array.
dtype
encoding Dictionary of format-specific settings for how this array should be serialized.
indexes OrderedDict of pandas.Index objects used for label based indexing
loc Attribute for location based indexing like pandas.
name The name of this array.
nbytes
ndim
shape
size
values The array’s data as a numpy.ndarray
variable