cf.Field.insert_aux

Field.insert_aux(item, key=None, axes=None, copy=True, replace=True, finalize=True)

Insert an auxiliary coordinate object into the domain in place.

Parameters :

item : cf.AuxiliaryCoordinate or cf.Coordinate or cf.DimensionCoordinate

The new auxiliary coordinate object. If it is not already a auxiliary coordinate object then it will be converted to one.

key : str, optional

The domain identifier for the item. By default a new, unique identifier will be generated.

axes : sequence of str, optional

The ordered list of axes for the item. Each axis is given by its domain identifier. By default the axes are assumed to be 'dim0' up to 'dimM-1', where M-1 is the number of axes spanned by the item.

copy: bool, optional

If False then the item is not copied before insertion. By default it is copied.

replace : bool, optional

If False then do not replace an existing auxiliary coordinate object of domain which has the same identifier. By default an existing auxiliary coordinate object with the same identifier is replaced with item.

finalize : bool, optional

If False then do not finalize the field after the new item has been inserted. By default the field is finalized. Only set to False if the field is guaranteed to be finalized subsequently, in which case there may be a performance advantage. See cf.Field.finalize for details.

Returns :

out :

The domain identifier for the inserted item.

See also

insert_axis, insert_cm, insert_data, insert_dim, insert_transform

Examples

>>>