cf.DomainAncillary.properties

DomainAncillary.properties(props=None, clear=False, copy=True)[source]

Attributes which are CF properties.

Parameters:
props
: dict, optional

Set domain ancillary attributes from the dictionary of values. If the copy parameter is True then the values in the attrs dictionary are deep copied

clear
: bool, optional

If True then delete all CF properties.

copy
: bool, optional

If True then the values in the returned dictionary are deep copies of the domain ancillary’s attribute values. By default they are not copied.

Returns:
out
: dict

The CF properties prior to being changed, or the current CF properties if no changes were specified.

Examples: