cf.Field.insert_transform

Field.insert_transform(item, key=None, copy=True, replace=True, finalize=True)[source]

Insert a transform object into the domain in place.

Parameters :
item : cf.Transform

The new transform object.

key : str, optional

The domain identifier for the item. By default a new, unique identifier will be generated.

copy: bool, optional

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

replace : bool, optional

If False then do not replace an existing transform object of domain which has the same identifier. By default an existing transform object with the same identifier is replaced with item.

finalize : bool, optional

If False then do not finalize the field after the new item has been inserted. By default the field is finalized. Only set to False if the field is guaranteed to be finalized subsequently, in which case there may be a performance advantage. See cf.Field.finalize for details.

Returns :
out :

The domain identifier for the item.

Examples

>>>

Previous topic

cf.Field.insert_dim

Next topic

cf.Field.item

This Page