cfdm.Field.concatenate

classmethod Field.concatenate(fields, axis, cull_graph=False, relaxed_units=False, copy=True)[source]

Join together a sequence of Field constructs.

Added in version (cfdm): 1.12.0.0

See also

Data.concatenate, Data.cull_graph

Parameters:
fields: sequence of Field

The fields to concatenate.

axis:

Select the domain axis to along which to concatenate, defined by that which would be selected by passing axis to a call of the field construct’s domain_axis method. For example, for a value of ‘time’, the domain axis construct returned by f.domain_axis('time') is selected.

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.

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.

copy: bool, optional

If True (the default) then make copies of the Field objects 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.

Returns:
Field

The concatenated construct.