cfdm.Field.nc_set_component_variable

Field.nc_set_component_variable(component, value)[source]

Set the netCDF variable name for components.

Sets the netCDF variable name for all components of a given type.

Some components exist within multiple constructs, but when written to a netCDF dataset the netCDF names associated with such components will be arbitrarily taken from one of them. The netCDF names can be set on all such occurrences individually, or preferably by using this method to ensure consistency across all such components.

New in version (cfdm): 1.8.6.0

See also

nc_del_component_variable, nc_set_component_variable_groups, nc_clear_component_variable_groups

Parameters
component: str

Specify the component type. One of:

component

Description

'interior_ring'

Interior ring variables for geometry coordinates

'node_count'

Node count variables for geometry coordinates

'part_node_count'

Part node count variables for geometry coordinates

'count'

Count variables for contiguous ragged arrays

'index'

Index variables for indexed ragged arrays

'list'

List variables for compression by gathering
value: str

The netCDF variable name to be set for each component.

Returns

None

Examples

>>> f.nc_set_component_variable('interior_ring', 'interiorring_1')