cf.CellConnectivity¶
- class cf.CellConnectivity(*args, **kwargs)[source]¶
A cell connectivity construct of the CF data model.
A cell connectivity construct defines explicitly how cells arranged in two or three dimensions in real space but indexed by a single domain (discrete) axis are connected. Connectivity can only be provided when the domain axis construct also has a domain topology construct, and two cells can only be connected if they also have a topological relationship. For instance, the connectivity of two-dimensional face cells could be characterised by whether or not they have shared edges, where the edges are defined by connected nodes of the domain topology construct.
The cell connectivity construct consists of an array recording the connectivity, and properties to describe the data. There must be a property indicating the condition by which the connectivity is derived from the domain topology. The array spans the domain axis construct with the addition of a ragged dimension. For each cell, the first element along the ragged dimension contains the unique identity of the cell, and the following elements contain in arbitrary order the identities of all the other cells to which the cell is connected. Note that the connectivity array for point cells is, by definition, equivalent to the array of the domain topology construct.
When cell connectivity constructs are present they are considered to define the connectivity of the cells. Exactly the same connectivity information could be derived from the domain topology construct. Connectivity information inferred from inspection of any other constructs is not guaranteed to be the same.
In CF-netCDF a cell topology construct can only be provided by a UGRID mesh topology variable. The construct array is supplied either indirectly by any of the UGRID variables that are used to define a domain topology construct, or directly by the UGRID “face_face_connectivity” variable (for face cells). In the direct case, the integer indices contained in the UGRID variable may be used as the cell identities, although the CF data model attaches no significance to the values other than the fact that some values are the same as others.
Restricting the types of connectivity to those implied by the geospatial topology of the cells precludes connectivity derived from any other sources, but is consistent with UGRID encoding within CF-netCDF.
See CF Appendix I “The CF Data Model”.
NetCDF interface
The netCDF variable name may be accessed with the
nc_set_variable
,nc_get_variable
,nc_del_variable
, andnc_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
, andnc_set_variable_groups
methods.Added in version 3.16.0.
Initialisation
- Parameters:
- connectivity:
str
, optional The connectivity type describes a characteristic of inter-cell connectivity defined by the domain topology construct. It may take any value, but the following values are standardised:
'node'``(edge or face cells connected by one or more shared nodes) and ``'edge'
(face cells connected by one or more shared edges).- 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
andset_property
methods.- Parameter example:
properties={'long_name': 'face-face connectivity'}
- 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 cf instances that containData
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
CellConnectivity
instance.All other parameters, apart from copy, are ignored and their values are instead inferred from source by assuming that it has the
CellConnectivity
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 aCellConnectivity
instance thencf.CellConnectivity(source=x)
is equivalent tox.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.
- connectivity:
Inspection¶
Methods
A full description of the cell connectivity construct. |
|
Return the canonical identity. |
|
Return all possible identities. |
|
Inspect the object for debugging. |
Attributes
Return a description of the construct type. |
Topology¶
Methods
Remove the connectivity. |
|
Return the connectivity type. |
|
Whether the connectivity type has been set. |
|
Set the connectivity type. |
|
Normalise the data values. |
Attributes
The connectivity type. |
Selection¶
Methods
Whether or not the construct identity satisfies conditions. |
|
Whether or not the data has a given dimensionality. |
|
Whether or not the netCDF variable name satisfies conditions. |
|
Whether or not properties satisfy conditions. |
|
Whether or not the construct has given units. |
Properties¶
Methods
Remove a property. |
|
Get a CF property. |
|
Whether a property has been set. |
|
Set a property. |
|
Return all properties. |
|
Remove all properties. |
|
Remove properties. |
|
Set properties. |
Attributes
The add_offset CF property. |
|
The calendar CF property. |
|
The comment CF property. |
|
The _FillValue CF property. |
|
The history CF property. |
|
The leap_month CF property. |
|
The leap_year CF property. |
|
The long_name CF property. |
|
The missing_value CF property. |
|
The month_lengths CF property. |
|
The scale_factor CF property. |
|
The standard_name CF property. |
|
The units CF property. |
|
The valid_max CF property. |
|
The valid_min CF property. |
|
The valid_range CF property. |
Units¶
Methods
|
Change the data array units. |
Override the units. |
|
Override the calendar of date-time units. |
Attributes
The |
Data¶
Attributes
A numpy array deep copy of the data. |
|
Deprecated at version 3.0.0, use |
|
The |
|
An independent numpy array of date-time objects. |
|
Return an element of the data array as a standard Python scalar. |
|
The |
|
True if the data array is scalar. |
|
The number of data dimensions. |
|
A tuple of the data array's dimension sizes. |
|
The number elements in the data. |
|
A numpy array view of the data. |
Methods
Convert the data to a |
|
Return a subspace defined by indices. |
|
Remove the data. |
|
Return the data. |
|
Whether or not the construct has data. |
|
Set the data. |
Rearranging elements
Flatten axes of the data. |
|
Flip (reverse the direction of) data dimensions. |
|
Expand the shape of the data array. |
|
Roll the data along one or more axes. |
|
Remove size one axes from the data array. |
|
Interchange two axes of an array. |
|
Permute the axes of the data array. |
Expanding the data
Expand the data by adding a halo. |
|
Pad an axis with missing data. |
Data array mask
Apply masking as defined by the CF conventions. |
|
Count the non-masked elements of the data. |
|
Count the masked elements of the data. |
|
Return the data array missing data value. |
|
Replace masked elements with a fill value. |
|
Mask the array where invalid values occur (NaN or inf). |
A binary (0 and 1) missing data mask of the data array. |
|
Whether the mask is hard (True) or soft (False). |
|
The mask of the data array. |
Changing data values
Called to implement assignment to x[indices] |
|
Mask the array where invalid values occur (NaN or inf). |
|
Return a new variable whose data is subspaced. |
|
Set data array elements depending on a condition. |
Miscellaneous
Change the chunk structure of the data. |
|
Close all files referenced by the construct. |
|
Convert reference time data values to have new units. |
|
Get or set the cyclicity of an axis. |
|
Return or set the period of the data. |
|
Whether or not a given axis is cyclic. |
|
True if a given axis is periodic. |
|
The names of files containing the original data and metadata. |
|
Whether or not there are cell bounds. |
|
Persist data into memory. |
Quantization¶
Methods
Get quantization metadata. |
|
Get a quantize-on-write instruction. |
Miscellaneous¶
Methods
Join a together sequence of |
|
Return a deep copy. |
|
Returns the commands to create the construct. |
|
Whether two instances are the same. |
|
Bring data on disk into memory. |
|
Uncompress the construct. |
Attributes
|
|
Always False. |
|
Always False. |
|
Always False. |
|
An identity for the CellConnectivity object. |
Mathematical operations¶
Methods
Trigonometrical and hyperbolic functions
Take the trigonometric inverse cosine of the data element- wise. |
|
Take the inverse hyperbolic cosine of the data element-wise. |
|
Take the trigonometric inverse sine of the data element-wise. |
|
Take the inverse hyperbolic sine of the data element-wise. |
|
Take the trigonometric inverse tangent of the data element- wise. |
|
Take the inverse hyperbolic tangent of the data element-wise. |
|
Take the trigonometric cosine of the data element-wise. |
|
Take the hyperbolic cosine of the data element-wise. |
|
Take the trigonometric sine of the data element-wise. |
|
Take the hyperbolic sine of the data element-wise. |
|
Take the trigonometric tangent of the data element-wise. |
|
Take the hyperbolic tangent of the data array. |
Rounding and truncation
The ceiling of the data, element-wise. |
|
Limit the values in the data. |
|
Floor the data array, element-wise. |
|
Round the data to the nearest integer, element-wise. |
|
Round the data to the given number of decimals. |
|
Truncate the data, element-wise. |
Statistical collapses
Alias for |
|
The unweighted mean the data array. |
|
The unweighted average of the maximum and minimum of the data array. |
|
Alias for |
|
The absolute difference between the maximum and minimum of the data array. |
|
The number of non-missing data elements in the data array. |
|
The sum of the data array. |
|
Alias for |
|
Alias for |
|
The unweighted sample standard deviation of the data array. |
|
The unweighted sample variance of the data array. |
|
The maximum of the data array. |
|
The minimum of the data array. |
Exponential and logarithmic functions
The exponential of the data, element-wise. |
|
The logarithm of the data array. |
Date-time operations¶
Attributes
The day of each date-time data array element. |
|
An independent numpy array of date-time objects. |
|
The hour of each date-time data array element. |
|
The minute of each date-time data array element. |
|
The month of each date-time data array element. |
|
The reference date-time of units of elapsed time. |
|
The second of each date-time data array element. |
|
The year of each date-time data array element. |
Logic functions¶
Truth value testing
Test whether all data elements evaluate to True. |
|
Test whether any data elements evaluate to True. |
Comparison
Test whether all data are element-wise equal to other, broadcastable data. |
|
Whether two instances are the same. |
|
True if two constructs are equal, False otherwise. |
Set operations
The unique elements of the data. |
NetCDF¶
Methods
Remove the netCDF variable name. |
|
Return the netCDF variable name. |
|
Whether the netCDF variable name has been set. |
|
Set the netCDF variable name. |
|
Clear the dataset chunking strategy for the data. |
|
Get the dataset chunking strategy for the data. |
|
Set the dataset chunking strategy. |
Aggregation¶
Methods
The directories of files containing parts of the data. |
|
Replace a file directory in-place. |
NetCDF¶
Methods
Remove the netCDF variable name. |
|
Return the netCDF variable name. |
|
Whether the netCDF variable name has been set. |
|
Set the netCDF variable name. |
Groups¶
Methods
Return the netCDF variable group hierarchy. |
|
Remove the netCDF variable group hierarchy. |
|
Set the netCDF variable group hierarchy. |
Dataset chunks¶
Methods
Get the dataset chunking strategy for the data. |
|
Set the dataset chunking strategy. |
|
Clear the dataset chunking strategy for the data. |
Aliases¶
Methods
Alias for |
Attributes
Alias for |
Special¶
Methods
Called by the |
|
Return a subspace defined by indices. |
|
Called by the |
|
Called by the |
Docstring substitutions¶
Methods
Return the special docstring substitutions. |
|
Returns the substitutions that apply to methods of the class. |
|
Returns the class {{package}} substitutions package depth. |
|
Returns method names excluded in the class substitutions. |
Deprecated¶
Methods
Deprecated at version 3.0.0. |
|
Deprecated at version 3.0.0. |
|
Deprecated at version 3.0.0. |
|
Partition the data array. |
|
Deprecated at version 3.0.0, use method |
|
Deprecated at version 3.0.0. |
|
Deprecated at version 3.0.0, use |
|
Return the name of the file or files containing the data. |
|
Deprecated at version 3.0.0, use method |
|
Deprecated at version 3.0.0, use |
|
Deprecated at version 3.0.0, use |
|
Deprecated at version 3.0.0, use method |
|
Deprecated at version 3.0.0, use |
|
Deprecated at version 3.7.0, use |
|
Deprecated at version 3.7.0, use |
|
Deprecated at version 3.7.0, use |
|
Deprecated at version 3.7.0, use |
|
Deprecated at version 3.7.0, use |
|
Mask the array where invalid values occur. |
|
Deprecated at version 3.0.0, use method 'identity' instead. |
|
Deprecated at version 3.0.0, use method |
|
Deprecated at version 3.0.0. |
|
Deprecated at version 3.0.0, use method |
|
Deprecated at version 3.0.0, use |
|
Clear the HDF5 chunking strategy for the data. |
|
Get the HDF5 chunking strategy for the data. |
|
Set the HDF5 chunking strategy. |