cfdm.Index.concatenate

classmethod Index.concatenate(variables, axis=0, cull_graph=False, relaxed_units=False, copy=True)[source]

Join a together sequence of Index.

New in version (cfdm): 1.12.0.0

See also

Data.concatenate, Data.cull_graph

Parameters

variables: sequence of constructs.

axis: int, optional

Select the axis along which to concatenate, defined by its position in the data array. By default concatenation is along the axis in position 0.

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 Index 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
Index

The concatenated construct.