cf.Field.concatenate

classmethod Field.concatenate(fields, axis=0, cull_graph=False, relaxed_units=False, copy=True)

Join a sequence of fields together.

This is different to cf.aggregate because it does not account for all metadata. For example, it assumes that the axis order is the same in each field.

New in version 1.0.

See also

cf.aggregate, Data.concatenate, Data.cull_graph

Parameters

fields: (sequence of) Field

The fields to concatenate.

axis: int, optional

The axis along which the arrays will be joined. The default is 0. Note that scalar arrays are treated as if they were one dimensional.

cull_graph: bool, optional

If True then unnecessary tasks are removed (culled) from each array’s dask graph before concatenation. This process can have a considerable overhead but can sometimes improve the overall performance of a workflow. If False (the default) then dask graphs are not culled. See dask.optimization.cull for details.

New in version 3.14.0.

relaxed_units: bool, optional

If True then allow the concatenation of data with invalid but otherwise equal units. By default, if any data array has invalid units then the concatenation will fail. A Units object is considered to be invalid if its isvalid attribute is False.

New in version 3.15.1.

copy: bool, optional

If True (the default) then make copies of the Field constructs, prior to the concatenation, thereby ensuring that the input constructs are not changed by the concatenation process. If False then some or all input constructs might be changed in-place, but the concatenation process will be faster.

New in version 3.15.1.

Returns

Field

The field generated from the concatenation of input fields.