cf.Domain.insert_cm

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

Insert a cell measure into the domain in place.

Parameters :
cm : cf.CellMeasure

The new cell measure.

key : str, optional

The identifier for the new cell measure. The identifier is of the form 'cmN' 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 : sequence, optional

The ordered axes of the new cell measure.

copy : bool, optional

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

replace : bool, optional

If False then do not replace an existing cell measure with the same identifier. By default an existing cell measure with the same identifier is replaced with cm.

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 cell measure (see the key parameter).

Examples

>>>

Previous topic

cf.Domain.insert_axis

Next topic

cf.Domain.insert_coord

This Page