cfdm.CFDMImplementation

---

class cfdm.CFDMImplementation(cf_version=None, **kwargs)

Bases: Implementation

A container for the CF data model implementation.

Added in version (cfdm): 1.7.0

Initialisation

Parameters:

kwargs:

The concrete objects required to represent a Field.

Methods

Methods

bounds_insert_dimension	Insert a new dimension into bounds data.
classes	Return all the classes of the implementation.
climatological_time_axes	Return all axes which are climatological time axes.
conform_geometry_variables	Collate geometry variable properties.
construct_insert_dimension	Insert a new dimension into metadata construct data.
convert	Convert a metadata construct into a field construct.
copy	Copy.
copy_construct	Return a deep copy of a construct.
data_insert_dimension	Insert a new dimension into a data array.
del_parameter	Delete a parameter from a component.
del_properties	Remove a property from a construct.
del_property	Remove a property from a construct.
equal_components	Whether or not two field construct components are equal.
equal_constructs	Whether or not two field construct components are equal.
equal_datums	Whether or not two coordinate reference datums are equal.
equal_properties	Whether or not two property values are equal.
field_insert_dimension	Insert a new dimension into field construct data.
get_array	Return the data as a numpy array.
get_auxiliary_coordinates	Returns auxiliary coordinates that span particular axes.
get_bounds	Return the bounds of a construct.
get_bounds_ncvar	Return the netCDF variable name of the bounds.
get_cell_connectivities	Return the cell connectivities from a parent.
get_cell_measures	Return all of the cell measure constructs of a field.
get_cell_method_axes	Return the axes of a cell method construct.
get_cell_method_qualifiers	Return the str representation of a cell method construct.
get_cell_method_string	Return the str representation of a cell method construct.
get_cell_methods	Return all of the cell method constructs of a field.
get_cf_version	Return the CF version of the implementation.
get_class	Return a class of the implementation.
get_compressed_array	Return the data in its compressed form .
get_compressed_axes	Return the axes that have been compressed.
get_compression_type	Returns the type of compression applied.
get_construct_data_axes	Returns the construct keys of the spanned axes.
get_construct_data_size	Return the size of a construct's data.
get_construct_type	Return the construct type of a variable.
get_constructs	Return constructs that span particular axes.
get_coordinate_conversion_parameters	Gets the coordinate reference conversion parameters.
get_coordinate_reference_coordinates	Return the coordinates of a coordinate reference construct.
get_coordinate_references	Return all of the coordinate reference constructs of a field.
get_coordinates	Return all of the coordinate constructs of a field or domain.
get_count	Return the count variable of compressed data.
get_data	Return the data array.
get_data_axes	Get domain axis identifiers.
get_data_calendar	Return the calendar of date-time data.
get_data_compressed_axes	Return the indices of the axes that have been compressed.
get_data_max	Use get_data_maximum instead (since cfdm version 1.8.0).
get_data_maximum	Return the maximum value of the data.
get_data_ndim	Return the number of dimensions spanned by the data array.
get_data_shape	Return the shape of the data array.
get_data_size	Return the number of elements in the data array.
get_data_source	Return the data array.
get_data_sum	Return the sum of the data.
get_data_units	Return the units of data.
get_datum	Return the datum of a coordinate reference construct.
get_datum_parameters	Returns coordinate reference datum parameter-valued terms.
get_dimension_coordinates	Return all of the dimension coordinate constructs of a field.
get_domain_ancillaries	Return all of the domain ancillary constructs of a field.
get_domain_axes	Return all of the domain axis constructs of a field.
get_domain_axis_size	Return the size a of domain axis construct.
get_domain_topologies	Return the domain topologies from a parent.
get_field_ancillaries	Return the field ancillaries of a field.
get_field_data_axes	Returns the construct keys of the field's data dimensions.
get_filenames	Return the name of the file or files containing the data.
get_geometry	Return the geometry type of coordinates.
get_index	Return the index variable of compressed data.
get_inherited_properties	Return all inherited properties.
get_interior_ring	Return the interior ring variable of geometry coordinates.
get_interpolation_name	Return the interior ring variable of geometry coordinates.
get_list	Return the list variable of compressed data.
get_measure	Return the measure property of a cell measure construct.
get_node_count	Return the node count variable of geometry coordinates.
get_original_filenames	Get the original names of the files containing the construct.
get_parameter	Get a parameter value from a component.
get_part_node_count	Return the part node count variable of geometry coordinates.
get_properties	Return all properties.
get_property	Return a property of a construct.
get_quantization	Get quantization metadata.
get_quantize_on_write	Get a quantize-on-write instruction form a construct.
get_sample_dimension_position	Returns the position of the compressed data sample dimension.
get_tie_points	TODO.
has_bounds	Whether or not a construct has bounds.
has_datum	Return True if a coordinate reference has a datum.
has_domain_topology	Whether or not a field or domain has a domain topology.
has_property	Return True if a property exists.
initialise_AggregatedArray	Return a AggregatedArray instance.
initialise_AuxiliaryCoordinate	Return an auxiliary coordinate construct.
initialise_Bounds	Return a bounds component.
initialise_BoundsFromNodesArray	Return a node bounds array.
initialise_CellConnectivity	Return a cell connectivity construct.
initialise_CellConnectivityArray	Return a cell connectivity array.
initialise_CellMeasure	Return a cell measure construct.
initialise_CellMethod	Return a cell method construct.
initialise_CoordinateConversion	Return a coordinate conversion component.
initialise_CoordinateReference	Return a coordinate reference construct.
initialise_Count	Return a count variable.
initialise_Data	Return a data instance.
initialise_Datum	Return a coordinate conversion component.
initialise_DimensionCoordinate	Return a dimension coordinate construct.
initialise_DimensionCoordinate_from_AuxiliaryCoordinate	Returns a dimension coordinate from an auxiliary coordinate.
initialise_Domain	Return a domain construct.
initialise_DomainAncillary	Return a domain ancillary construct.
initialise_DomainAxis	Return a domain ancillary construct.
initialise_DomainTopology	Return a domain topology construct.
initialise_Field	Return a field construct.
initialise_FieldAncillary	Return a field ancillary construct.
initialise_GatheredArray	Return a gathered array instance.
initialise_Index	Return an index variable.
initialise_InteriorRing	Return an interior ring variable.
initialise_InterpolationParameter	Return an interpolation parameter variable.
initialise_List	Return a list variable.
initialise_NodeCountProperties	Return a node count properties variable.
initialise_PartNodeCount	Return a part node count properties variable.
initialise_PointTopologyArray	Return a point topology array.
initialise_Quantization	Return a quantization metadata class.
initialise_RaggedContiguousArray	Return a ragged contiguous array instance.
initialise_RaggedIndexedArray	Return a ragged indexed array instance.
initialise_RaggedIndexedContiguousArray	Return a ragged indexed contiguous array instance.
initialise_SubsampledArray	Return a subsampled array instance.
initialise_TiePointIndex	Return an index variable.
initialise_XnetcdfArray	Return a XnetcdfArray instance.
is_climatology	Whether or not the coordinate represent climatologies.
is_domain	Return True if the construct is a domain construct.
is_field	Return True if the construct is a field construct.
is_geometry	Return True if the coordinate bounds are geometries.
is_masked	Whether or not the data has any masked values.
nc_get_dataset_chunksizes	Get the dataset chunking strategy for the data.
nc_get_dataset_shards	Get the Zarr dataset sharding strategy for the data.
nc_get_datum_variable	Get the netCDF grid mapping variable name for a datum.
nc_get_dimension	Return the netCDF variable name.
nc_get_external	Return whether a construct is external.
nc_get_geometry_variable	Return the netCDF variable name of the geometry container.
nc_get_global_attributes	Return the netCDF global attributes.
nc_get_group_attributes	Returns the netCDF sub-group attributes for the field.
nc_get_hdf5_chunksizes	Get the HDF5 chunking strategy for the data.
nc_get_sample_dimension	Return the name of the netCDF sample dimension.
nc_get_variable	Return the netCDF variable name.
nc_get_variable_groups	Return the netCDF groups for the field construct.
nc_is_unlimited_axis	Whether a domain axis matches a netCDF unlimited dimension.
nc_set_dataset_chunksizes	Set the dataset chunking strategy for the data.
nc_set_dataset_shards	Set the Zarr dataset sharding strategy for the data.
nc_set_datum_variable	Set the netCDF grid mapping variable name for a datum.
nc_set_dimension	Set the netCDF dimension name.
nc_set_external	Set the external status of a construct.
nc_set_geometry_variable	Set the netCDF geometry container variable name.
nc_set_global_attributes	Set netCDF global attributes.
nc_set_group_attributes	Set netCDF group attributes.
nc_set_hdf5_chunksizes	Set the HDF5 chunking strategy for the data.
nc_set_instance_dimension	Set the netCDF instance dimension name.
nc_set_interpolation_subarea_dimension	Set the netCDF sample dimension name.
nc_set_node_coordinate_variable	Set the netCDF node coordinate variable name.
nc_set_sample_dimension	Set the netCDF sample dimension name.
nc_set_subsampled_dimension	Set the netCDF subsampled dimension name.
nc_set_unlimited_axis	Sets a domain axis to match a netCDF unlimited dimension.
nc_set_variable	Set the netCDF variable name.
parameters	Return all parameters from a component.
set_auxiliary_coordinate	Insert a auxiliary coordinate object into a field.
set_bounds	Set the bounds component of a construct.
set_cell_connectivity	Insert a cell connectivity object into a field.
set_cell_measure	Insert a cell_measure object into a field.
set_cell_method	Insert a cell_method object into a field.
set_cell_method_axes	Set the axes of a cell method construct.
set_cell_method_method	Set the method of a cell method construct.
set_class	Set a class of the implementation.
set_climatology	Set the construct as a climatology.
set_construct	Insert a construct into a field or domain.
set_coordinate_conversion	Set a coordinate conversion component.
set_coordinate_reference	Insert a coordinate reference object into a field.
set_coordinate_reference_coordinate	Set a coordinate of a coordinate reference construct.
set_coordinate_reference_coordinates	Set the coordinates of a coordinate reference construct.
set_data	The the data instance of a construct.
set_dataset_compliance	Set the dataset compliance report on a field construct.
set_datum	Insert a datum object into a coordinate reference construct.
set_dependent_tie_points	Set dependent tie points and their dimensions.
set_dimension_coordinate	Insert a dimension coordinate object into a field.
set_domain_ancillary	Insert a domain ancillary object into a field.
set_domain_axis	Insert a domain_axis object into a field.
set_domain_topology	Insert a domain topology object into a field.
set_field_ancillary	Insert a field ancillary object into a field.
set_geometry	Set the geometry type of a coordinate construct.
set_inherited_properties	Set any inherited properties.
set_interior_ring	Insert an interior ring array into a coordinate.
set_interpolation	Set an interpolation variable.
set_node_count_properties	Set a node count properties variable.
set_original_filenames	Set the original files.
set_parameter	Set a parameter on a component.
set_part_node_count_properties	Set a part node count properties variable.
set_properties	Set construct properties.
set_quantization	Set quantization metadata.
squeeze	Remove size 1 axes from construct data.
unsqueeze	Insert size 1 axes into the field data array.