cfdm.TiePointIndex

---

class cfdm.TiePointIndex(*args, **kwargs)

Bases: NetCDFVariable, NetCDFSubsampledDimension, NetCDFInterpolationSubareaDimension, PropertiesData, Files, PropertiesData

A tie point index variable with properties.

Space may be saved by storing a subsample of the coordinates. The uncompressed coordinates can be reconstituted by interpolation from the subsampled coordinate values, also called either “tie points” or “bounds tie points”.

For each interpolated dimension, the locations of the (bounds) tie points are defined by a corresponding tie point index variable, which also indicates the extent of each continuous area.

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.

The dataset chunks may be accessed with the nc_dataset_chunksizes, nc_set_dataset_chunksizes, and nc_clear_datset_chunksizes methods.

The netCDF subsampled dimension name may be accessed with the nc_set_subsampled_dimension, nc_get_subsampled_dimension, nc_del_subsampled_dimension and nc_has_subsampled_dimension methods.

The netCDF subsampled dimension group structure may be accessed with the nc_set_subsampled_dimension, nc_get_subsampled_dimension, nc_subsampled_dimension_groups, nc_clear_subsampled_dimension_groups, and nc_set_subsampled_dimension_groups methods.

The netCDF interpolation subarea dimension name may be accessed with the nc_set_interpolation_subarea_dimension, nc_get_interpolation_subarea_dimension, nc_del_interpolation_subarea_dimension, and nc_has_interpolation_subarea_dimension methods.

The netCDF interpolation subarea dimension group structure may be accessed with the nc_set_interpolation_subarea_dimension, nc_get_interpolation_subarea_dimension, nc_interpolation_subarea_dimension_groups, nc_clear_interpolation_subarea_dimension_groups and nc_set_interpolation_subarea_dimension_groups methods.

Added in version (cfdm): 1.10.0.0

See also

InterpolationParameter

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 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 TiePointIndex instance.

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

apply_masking	Apply masking as defined by the CF conventions.
array	A numpy array deep copy of the data.
clear_properties	Remove all properties.
concatenate	Join a together sequence of TiePointIndex.
copy	Return a deep copy.
creation_commands	Return the commands that would create the construct.
data	The data.
datetime_array	An independent numpy array of date-time objects.
del_data	Remove the data.
del_properties	Remove properties.
del_property	Remove a property.
dtype	Data-type of the data elements.
dump	A full description of the tie point index variable.
equals	Whether two instances are the same.
file_directories	The directories of files containing parts of the data.
get_data	Return the data.
get_filenames	Return the name of the file or files containing the data.
get_original_filenames	The names of files containing the original data and metadata.
get_property	Return a property.
get_quantization	Get quantization metadata.
get_quantize_on_write	Get a quantize-on-write instruction.
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.
identities	Return all possible identities.
identity	Return the canonical identity.
insert_dimension	Expand the shape of the data array.
nc_clear_dataset_chunksizes	Clear the dataset chunking strategy for the data.
nc_clear_hdf5_chunksizes	Clear the HDF5 chunking strategy for the data.
nc_clear_interpolation_subarea_dimension_groups	Remove the interpolation subarea dimension group hierarchy.
nc_clear_subsampled_dimension_groups	Remove the netCDF subsampled dimension group hierarchy.
nc_clear_variable_groups	Remove the netCDF variable group hierarchy.
nc_dataset_chunksizes	Get the dataset chunking strategy for the data.
nc_del_interpolation_subarea_dimension	Remove the netCDF interpolation subarea dimension name.
nc_del_subsampled_dimension	Remove the netCDF sample dimension name.
nc_del_variable	Remove the netCDF variable name.
nc_get_interpolation_subarea_dimension	Return the netCDF interpolation subarea dimension name.
nc_get_subsampled_dimension	Return the netCDF subsampled dimension name.
nc_get_variable	Return the netCDF variable name.
nc_has_interpolation_subarea_dimension	Whether the netCDF interpolation subarea dimension is set.
nc_has_subsampled_dimension	Whether the netCDF subsampled dimension name has been set.
nc_has_variable	Whether the netCDF variable name has been set.
nc_hdf5_chunksizes	Get the HDF5 chunking strategy for the data.
nc_interpolation_subarea_dimension_groups	Return the interpolation subarea dimension group hierarchy.
nc_set_dataset_chunksizes	Set the dataset chunking strategy.
nc_set_hdf5_chunksizes	Set the HDF5 chunking strategy.
nc_set_interpolation_subarea_dimension	Set the netCDF interpolation subarea dimension name.
nc_set_interpolation_subarea_dimension_groups	Set the interpolation subarea dimension group hierarchy.
nc_set_subsampled_dimension	Set the netCDF subsampled dimension name.
nc_set_subsampled_dimension_groups	Set the netCDF subsampled dimension group hierarchy.
nc_set_variable	Set the netCDF variable name.
nc_set_variable_groups	Set the netCDF variable group hierarchy.
nc_subsampled_dimension_groups	Return the netCDF subsampled dimension group hierarchy.
nc_variable_groups	Return the netCDF variable group hierarchy.
ndim	The number of data dimensions.
persist	Persist data into memory.
properties	Return all properties.
replace_directory	Replace a file directory in-place.
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.
squeeze	Remove size one axes from the data array.
to_memory	Bring data on disk into memory.
transpose	Permute the axes of the data array.
uncompress	Uncompress the construct.