cfdm.Field.nc_set_component_sample_dimension

Field.nc_set_component_sample_dimension(component, value)[source]

Set the netCDF sample dimension name of components.

Sets the netCDF sample dimension 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

Parameters
component: str

Specify the component type. One of:

component

Description

'count'

Count variables for contiguous ragged arrays

'index'

Index variables for indexed ragged arrays

value: str

The netCDF sample_dimension name to be set for each component.

Returns

None

Examples:

>>> f.nc_set_component_sample_dimension('count', 'obs')