cfdm.List

---

class cfdm.List(*args, **kwargs)

Bases: NetCDFVariable, PropertiesData, Files, PropertiesData

A list variable required to uncompress a gathered array.

Compression by gathering combines axes of a multidimensional array into a new, discrete axis whilst omitting the missing values and thus reducing the number of values that need to be stored.

The information needed to uncompress the data is stored in a list variable that gives the indices of the required points.

NetCDF interface

The netCDF variable name may be accessed with the nc_set_variable, nc_get_variable, nc_del_variable, and nc_has_variable methods.

The netCDF variable group structure may be accessed with the nc_set_variable, nc_get_variable, nc_variable_groups, nc_clear_variable_groups, and nc_set_variable_groups methods.

The dataset chunks may be accessed with the nc_dataset_chunksizes, nc_set_dataset_chunksizes, and nc_clear_datset_chunksizes methods.

Added in version (cfdm): 1.7.0

Initialisation

Parameters:

properties: dict, optional

Set descriptive properties. The dictionary keys are property names, with corresponding values.

Properties may also be set after initialisation with the set_properties and set_property methods.

Parameter example:

properties={'standard_name': 'altitude'}

data: data_like, optional

Set the data.

A data_like object is any object that can be converted to a Data object, i.e. numpy array_like objects, Data objects, and cfdm instances that contain Data objects.

The data also may be set after initialisation with the set_data method.

source: optional

Convert source, which can be any type of object, to a List instance.

All other parameters, apart from copy, are ignored and their values are instead inferred from source by assuming that it has the List API. Any parameters that can not be retrieved from source in this way are assumed to have their default value.

Note that if x is also a List instance then cfdm.List(source=x) is equivalent to x.copy().

copy: bool, optional

If True (the default) then deep copy the input parameters prior to initialisation. By default the parameters are not deep copied.

Inspection

Methods

dump	A full description of the list variable.
identity	Return the canonical identity.
identities	Return all possible identities.

Properties

Methods

del_property	Remove a property.
get_property	Return a property.
has_property	Whether a property has been set.
set_property	Set a property.
properties	Return all properties.
clear_properties	Remove all properties.
del_properties	Remove properties.
set_properties	Set properties.

Data

Methods

apply_masking	Apply masking as defined by the CF conventions.
del_data	Remove the data.
get_data	Return the data.
has_data	Whether or not the construct has data.
set_data	Set the data.
insert_dimension	Expand the shape of the data array.
persist	Persist data into memory.
squeeze	Remove size one axes from the data array.
transpose	Permute the axes of the data array.

Attributes

array	A numpy array deep copy of the data.
data	The data.
datetime_array	An independent numpy array of date-time objects.
dtype	Data-type of the data elements.
ndim	The number of data dimensions.
shape	A tuple of the data array's dimension sizes.
size	The number elements in the data.

Quantization

Methods

get_quantization	Get quantization metadata.
get_quantize_on_write	Get a quantize-on-write instruction.

Miscellaneous

Methods

copy	Return a deep copy.
concatenate	Join a together sequence of List.
creation_commands	Return the commands that would create the construct.
equals	Whether two instances are the same.
get_filenames	Return the name of the file or files containing the data.
get_original_filenames	The names of files containing the original data and metadata.
has_bounds	Whether or not there are cell bounds.
uncompress	Uncompress the construct.
to_memory	Bring data on disk into memory.

Aggregation

Methods

file_directories	The directories of files containing parts of the data.
replace_directory	Replace a file directory in-place.

NetCDF

Methods

nc_del_variable	Remove the netCDF variable name.
nc_get_variable	Return the netCDF variable name.
nc_has_variable	Whether the netCDF variable name has been set.
nc_set_variable	Set the netCDF variable name.
nc_clear_dataset_chunksizes	Clear the dataset chunking strategy for the data.
nc_dataset_chunksizes	Get the dataset chunking strategy for the data.
nc_set_dataset_chunksizes	Set the dataset chunking strategy.

Groups

Methods

nc_variable_groups	Return the netCDF variable group hierarchy.
nc_clear_variable_groups	Remove the netCDF variable group hierarchy.
nc_set_variable_groups	Set the netCDF variable group hierarchy.

Special

Methods

__deepcopy__	Called by the copy.deepcopy function.
__getitem__	Return a subspace defined by indices.
__repr__	Called by the repr built-in function.
__str__	Called by the str built-in function.

Docstring substitutions

Methods

_docstring_special_substitutions	Return the special docstring substitutions.
_docstring_substitutions	Returns the substitutions that apply to methods of the class.
_docstring_package_depth	Returns the class {{package}} substitutions package depth.
_docstring_method_exclusions	Returns method names excluded in the class substitutions.

Deprecated

Methods

nc_clear_hdf5_chunksizes	Clear the HDF5 chunking strategy for the data.
nc_hdf5_chunksizes	Get the HDF5 chunking strategy for the data.
nc_set_hdf5_chunksizes	Set the HDF5 chunking strategy.