cf.Domain.insert_measure

Domain.insert_measure(msr, key=None, axes=None, copy=True, replace=True)[source]

Insert a cell measure into the domain in place.

Parameters:
msr : cf.CellMeasure

The new cell measure.

key : str, optional

The identifier for the new cell measure. The identifier is of the form 'msrN' 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 msr.

Returns:
out : str

The identifier for the new cell measure (see the key parameter).

Examples:
>>>

Previous topic

cf.Domain.insert_dim

Next topic

cf.Domain.insert_ref

This Page