cf.Domain.insert_coord

Domain.insert_coord(variable, key, copy=True, axes=None)[source]

Insert a dimension coordinate or auxiliary coordinate into the domain in place.

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

The new dimension coordinate or auxiliary coordinate. If required, it will be converted to the appropiate object type (dimension coordinate or auxiliary).

key : str

The identifier for the new coordinate. The identifier must start with the string dim or aux, corresponding to whether the variable is to be a dimension coordinate or an auxiliary coordinate respectively.

axes : list, optional

If the variable is an auxiliary coordinate then the identities of its dimensions must be provided. Ignored if the variable is a dimension coordinate.

copy: bool, optional

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

Returns :

None

Examples

>>>

Previous topic

cf.Domain.insert_cm

Next topic

cf.Domain.insert_dim

This Page