cfdm.core.Topology

---

class cfdm.core.Topology(*args, **kwargs)

Bases: PropertiesData

Abstract base class for topology-related constructs.

Added in version (cfdm): 1.11.0.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.core 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 Topology instance.

All other parameters, apart from copy, are ignored and their values are instead inferred from source by assuming that it has the Topology 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 Topology instance then cfdm.core.Topology(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.

Methods

Methods

clear_properties	Remove all properties.
copy	Return a deep copy.
data	The data.
del_data	Remove the data.
del_properties	Remove properties.
del_property	Remove a property.
dtype	Data-type of the data elements.
get_data	Return the data.
get_property	Return a property.
has_bounds	Whether or not there are cell bounds.
has_data	Whether or not the construct has data.
has_property	Whether a property has been set.
ndim	The number of data dimensions.
properties	Return all properties.
set_data	Set the data.
set_properties	Set properties.
set_property	Set a property.
shape	A tuple of the data array's dimension sizes.
size	The number elements in the data.