cf.Domain.insert_aux

Domain.insert_aux(coord, key=None, axes=None, copy=True, replace=True, finalize=True)[source]

Insert a auxiliary coordinate into the domain in place.

Parameters :
coord : cf.AuxiliaryCoordinate or cf.Coordinate or cf.DimensionCoordinate

The new coordinate. If not an auxiliary coordinate object then it will be converted to one.

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.

axes : list, optional

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

transform : cf.Transform

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.

finalize : bool, optional

If False then do not finalize the domain for the new coordinate. By default the domain is finalized. Only set to False if the domain is guaranteed to be finalized subsequently, in which case there may be a performance advantage.

Returns :
out : str

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

Examples

>>>

Previous topic

cf.Domain.has

Next topic

cf.Domain.insert_axis

This Page