cf.Domain.insert_aux_coordinate

Domain.insert_aux_coordinate(coord, key=None, dimensions=None, transforms=None, copy=True, replace=True)

Insert a new auxiliary coordinate into the domain in place, preserving internal consistency.

Parameters :

coord :cf.Coordinate

The new auxiliary coordinate.

key : str, optional

The identifier for the new dimension coordinate. The identifier is of the form 'auxN' where the N part should be replaced by an arbitrary integer greater then or equal to zero. By default a unique identifier will be generated.

dimensions : list, optional

The ordered dimensions of the new coordinate. Ignored if the coordinate is a dimension coordinate. Required if the coordinate is an auxiliary coordinate.

transforms : sequence, optional

copy: bool, optional

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

replace : bool, optional

If False then do not replace an existing auxiliary coordinate with the same identifier. By default an existing auxiliary coordinate with the same identifier is replaced with coord.

Returns :

out : str

The identifier for the new auxiliary coordinate (see the key parameter).

Examples

>>>