cfdm.Field.nc_clear_dataset_chunksizes

Field.nc_clear_dataset_chunksizes(constructs=False)[source]

Clear the dataset chunking strategy.

Added in version (cfdm): 1.12.2.0

See also

nc_dataset_chunksizes, nc_set_hdataset_chunksizes, cfdm.read, cfdm.write

Parameters:
constructs: dict or bool, optional

Also clear the dataset chunking strategy from selected metadata constructs. The chunking strategies of unselected metadata constructs are unchanged.

If constructs is a dict then the selected metadata constructs are those that would be returned by f.constructs.filter(**constructs, filter_by_data=True). Note that an empty dictionary will therefore select all metadata constructs that have data. See filter for details.

For constructs being anything other than a dictionary, if it evaluates to True then all metadata constructs that have data are selected, and if it evaluates to False (the default) then no metadata are constructs selected.

Returns:
None or str or int or tuple of int

The chunking strategy prior to being cleared, as would be returned by nc_dataset_chunksizes.