cf.NodeCountProperties

---

class cf.NodeCountProperties(*args, **kwargs)

Properties for a netCDF node count variable.

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.

Added in version (cfdm): 1.8.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'}

source: optional

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

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

calendar	The calendar CF property.
clear_properties	Remove all properties.
comment	The comment CF property.
copy	Return a deep copy.
creation_commands	Return the commands that would create the construct.
del_properties	Remove properties.
del_property	Remove a property.
delprop	Deprecated at version 3.0.0, use method del_property instead.
dump	A full description of the node count variable.
equals	Whether two instances are the same.
get_original_filenames	The names of files containing the original data and metadata.
get_property	Get a CF property.
getprop	Deprecated at version 3.0.0, use method get_property instead.
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.
hasprop	Deprecated at version 3.0.0, use method has_property instead.
history	The history CF property.
id	An identity for the NodeCountProperties object.
identities	Return all possible identities.
identity	Return the canonical identity.
leap_month	The leap_month CF property.
leap_year	The leap_year CF property.
long_name	The long_name CF property.
match	Alias for match_by_identity.
match_by_identity	Whether or not the construct identity satisfies conditions.
match_by_ncvar	Whether or not the netCDF variable name satisfies conditions.
match_by_property	Whether or not properties satisfy conditions.
month_lengths	The month_lengths CF property.
nc_clear_variable_groups	Remove the netCDF variable group hierarchy.
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_set_variable_groups	Set the netCDF variable group hierarchy.
nc_variable_groups	Return the netCDF variable group hierarchy.
properties	Return all properties.
set_properties	Set properties.
set_property	Set a property.
setprop	Deprecated at version 3.0.0, use method set_property instead.
standard_name	The standard_name CF property.
units	The units CF property.
valid_max	The valid_max CF property.
valid_min	The valid_min CF property.
valid_range	The valid_range CF property.