cf.Domain.insert_cell_measure

Domain.insert_cell_measure(cm, key=None, dimensions=None, copy=True, replace=True)[source]

Insert a new cell measure into the domain in place, preserving internal consistency.

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.

dimensions : sequence, optional

The ordered dimensions 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.

Returns :
out : str

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

Examples

>>>

Previous topic

cf.Domain.insert_aux_coordinate

Next topic

cf.Domain.insert_dim_coordinate

This Page