cfdm.Count¶
-
class
cfdm.
Count
(properties=None, data=None, source=None, copy=True, _use_data=True)[source]¶ Bases:
cfdm.mixin.netcdf.NetCDFVariable
,cfdm.mixin.netcdf.NetCDFDimension
,cfdm.mixin.netcdf.NetCDFSampleDimension
,cfdm.mixin.propertiesdata.PropertiesData
,cfdm.core.abstract.propertiesdata.PropertiesData
A count variable required to uncompress a ragged array.
A collection of features stored using a contiguous ragged array combines all features along a single dimension (the sample dimension) such that each feature in the collection occupies a contiguous block.
The information needed to uncompress the data is stored in a count variable that gives the size of each block.
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.The name of the netCDF dimension spanned by the count variable’s data may be accessed with the
nc_set_dimension
,nc_get_dimension
,nc_del_dimension
andnc_has_dimension
methods.The name of the netCDF sample dimension spanned by the compressed data (that is stored in the “sample_dimension” netCDF attribute and which does not correspond to a domain axis construct) may be accessed with the
nc_set_sample_dimension
,nc_get_sample_dimension
,nc_del_sample_dimension
andnc_has_sample_dimension
methods.New in version (cfdm): 1.7.0
Initialisation
- Parameters
- properties:
dict
, optional Set descriptive properties. The dictionary keys are property names, with corresponding values. Ignored if the source parameter is set.
Properties may also be set after initialisation with the
set_properties
andset_property
methods.- Parameter example:
properties={'long_name': 'number of obs'}
- data: data_like, optional
Set the data. Ignored if the source parameter is set.
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 containData
objects.The data also may be set after initialisation with the
set_data
method.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 containData
objects.- source: optional
Initialise the properties and data from those of source.
Note that if source is a
Count
instance thencfdm.Count(source=source)
is equivalent tosource.copy()
.- copy:
bool
, optional If False then do not deep copy input parameters prior to initialisation. By default arguments are deep copied.
- properties:
Inspection¶
Methods
A full description of the count variable. |
|
Return the canonical identity. |
|
Return all possible identities. |
Properties¶
Methods
Remove a property. |
|
Return a property. |
|
Whether a property has been set. |
|
Set a property. |
|
Return all properties. |
|
Remove all properties. |
|
Set properties. |
Data¶
Methods
Apply masking as defined by the CF conventions. |
|
Remove the data. |
|
Return the data. |
|
Whether or not the construct has data. |
|
Set the data. |
|
Expand the shape of the data array. |
|
Remove size one axes from the data array. |
|
Permute the axes of the data array. |
Attributes
Return the data. |
|
Data-type of the data elements. |
|
The number of dimensions in the data array. |
|
A tuple of the data array’s dimension sizes. |
|
The number of elements in the data array. |
Miscellaneous¶
Methods
Return a deep copy. |
|
Return the commands that would create the construct. |
|
Whether two instances are the same. |
|
Return the name of the file or files containing the data. |
|
Whether or not there are cell bounds. |
|
Uncompress the construct. |
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. |
|
Remove the netCDF dimension name. |
|
Return the netCDF dimension name. |
|
Whether the netCDF dimension name has been set. |
|
Set the netCDF dimension name. |
Groups¶
Methods
Return the netCDF variable group hierarchy. |
|
Remove the netCDF variable group hierarchy. |
|
Set the netCDF variable group hierarchy. |
|
Return the netCDF dimension group hierarchy. |
|
Remove the netCDF dimension group hierarchy. |
|
Set the netCDF dimension group hierarchy. |
Sample dimension¶
Methods
Remove the netCDF sample dimension name. |
|
Return the netCDF sample dimension name. |
|
Whether the netCDF sample dimension name has been set. |
|
Set the netCDF sample dimension name. |
|
Return the netCDF dimension group hierarchy. |
|
Remove the netCDF dimension group hierarchy. |
|
Set the netCDF dimension group hierarchy. |
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. |