2022-10-31
+New method: cfdm.Data.get_tie_point_indices
New method: cfdm.Data.get_interpolation_parameters
New method: cfdm.Data.get_dependent_tie_points
Record the names of files that contain the original data +(https://github.com/NCAS-CMS/cfdm/issues/215)
New method: cfdm.Field.get_original_filenames
New method: cfdm.Data.get_original_filenames
New keyword parameter to cfdm.write: omit_data
+(https://github.com/NCAS-CMS/cfdm/issues/221)
Fixed bug that caused incorrect data assignment with some multiple +list indices (https://github.com/NCAS-CMS/cfdm/issues/217)
Fixed bug that caused a failure when printing date-time data with +the first element masked +(https://github.com/NCAS-CMS/cfdm/issues/211)
2022-08-17
New method: cfdm.Field.auxiliary_coordinate
2022-07-18
Upgrade to allow cfdm to work with Python 3.10 @@ -186,7 +207,7 @@
2022-03-10
Fixed bug that caused a failure from cfdm.write when writing
@@ -201,20 +222,20 @@
2022-01-31
Fixed bug that caused a cfdm.write failure when a vertical
coordinate reference construct has no coordinates
(https://github.com/NCAS-CMS/cfdm/issues/164)
Fixed bug that caused a failure when downstream identities methods
-return an itertools.chain object
+return an itertools.chain object
(https://github.com/NCAS-CMS/cfdm/issues/170)
2021-10-12
Fixed bug that prevented some geometry coordinates being written to @@ -228,7 +249,7 @@
2021-09-21
Python 3.6 support removed @@ -260,7 +281,7 @@
2021-05-25
Construct access API changes @@ -286,7 +307,7 @@
2020-12-18
The setting of global constants can now be controlled by a context @@ -299,7 +320,7 @@
2020-10-09
Python 3.5 support deprecated (3.5 was retired on 2020-09-13)
2020-07-24
Removed Python 2.7 support @@ -370,7 +391,7 @@
2020-06-10
Fixed bug that prevented the reading of certain netCDF files, such @@ -379,7 +400,7 @@
2020-06-08
Added new example field 7 to cfdm.example_field.
2020-04-30
cfdm.Field.apply_masking now masks metadata constructs.
2020-04-24
Added time coordinate bounds to the polygon geometry example field @@ -432,7 +453,7 @@
2020-04-16
Improved source code highlighting in links from the documentation @@ -443,7 +464,7 @@
2020-03-23
First release for CF-1.8 (does not include netCDF hierarchical @@ -473,19 +494,19 @@
2019-11-27
New methods: cfdm.Field.compress, cfdm.Field.uncompress
New methods: cfdm.Data.flatten, cfdm.Data.uncompress
New dtype and mask keyword parameters to cfdm.Data
Changed the default value of the ignore_compression parameter to
-True.
True.2019-11-14
New method: cfdm.Field.nc_set_global_attributes.
2019-11-07
Fixed bug relating to setting of parameters on datum and coordinate @@ -507,7 +528,7 @@
2019-10-04
During writing to netCDF files, ensured that _FillValue and @@ -522,7 +543,7 @@
2019-06-13
Don’t set the fill mode for a netCDF4.Dataset open for writing to
@@ -533,7 +554,7 @@
2019-06-05
Added attributes _ATOL and _RTOL to facilitate subclassing.
2019-05-15
New methods: Datum.nc_has_variable, Datum.nc_get_variable,
@@ -553,7 +574,7 @@
2019-05-14
Changed behaviour of cfdm.Constructs.filter_by_axis.
2019-04-24
New method: cfdm.Constructs.filter_by_size.
2019-04-05
New mode parameter options to cfdm.Constructs.filter_by_axis:
@@ -633,7 +654,7 @@
2019-04-02
New methods cfdm.Constructs.clear_filters_applied,
@@ -645,7 +666,7 @@
2019-04-02
First release for CF-1.7
Version 1.10.0.0 for version 1.10 of the CF conventions.
+Version 1.10.0.1 for version 1.10 of the CF conventions.
New in version 1.9.1.0.
+New in version 1.10.0.0.
New in version 1.9.1.0.
+New in version 1.10.0.0.
New in version 1.9.1.0.
+New in version 1.10.0.0.
New in version 1.9.1.0.
+New in version 1.10.0.0.
New in version 1.9.1.0.
+New in version 1.10.0.0.
New in version 1.9.1.0.
+New in version 1.10.0.0.
New in version 1.9.1.0.
+New in version 1.10.0.0.
New in version 1.9.1.0.
+New in version 1.10.0.0.
New in version 1.9.1.0.
+New in version 1.10.0.0.
New in version 1.9.1.0.
+New in version 1.10.0.0.
New in version 1.9.1.0.
+New in version 1.10.0.0.
New in version 1.9.1.0.
+New in version 1.10.0.0.
New in version 1.9.1.0.
+New in version 1.10.0.0.
New in version 1.9.1.0.
+New in version 1.10.0.0.
New in version 1.9.1.0.
+New in version 1.10.0.0.
New in version 1.9.1.0.
+New in version 1.10.0.0.
New in version 1.9.1.0.
+New in version 1.10.0.0.
New in version 1.9.1.0.
+New in version 1.10.0.0.
New in version 1.9.1.0.
+New in version 1.10.0.0.
New in version 1.9.1.0.
+New in version 1.10.0.0.
New in version 1.9.1.0.
+New in version 1.10.0.0.
New in version 1.9.1.0.
+New in version 1.10.0.0.
data¶
Return the data.
f.data is equivalent to f.get_data()
Note that a Data instance is returned. Use its array
+
Note that a Data instance is returned. Use its array
attribute to return the data as a numpy array.
The units, calendar and fill value properties are, if set, inserted into the data.
@@ -175,7 +175,7 @@data¶
Return the data.
f.data is equivalent to f.get_data()
Note that a Data instance is returned. Use its array
+
Note that a Data instance is returned. Use its array
attribute to return the data as a numpy array.
The units, calendar and fill value properties are, if set, inserted into the data.
@@ -175,7 +175,7 @@data¶
Return the data.
f.data is equivalent to f.get_data()
Note that a Data instance is returned. Use its array
+
Note that a Data instance is returned. Use its array
attribute to return the data as a numpy array.
The units, calendar and fill value properties are, if set, inserted into the data.
@@ -175,7 +175,7 @@data¶
Return the data.
f.data is equivalent to f.get_data()
Note that a Data instance is returned. Use its array
+
Note that a Data instance is returned. Use its array
attribute to return the data as a numpy array.
The units, calendar and fill value properties are, if set, inserted into the data.
@@ -175,7 +175,7 @@data¶
Return the data.
f.data is equivalent to f.get_data()
Note that a Data instance is returned. Use its array
+
Note that a Data instance is returned. Use its array
attribute to return the data as a numpy array.
The units, calendar and fill value properties are, if set, inserted into the data.
@@ -175,7 +175,7 @@data¶
Return the data.
f.data is equivalent to f.get_data()
Note that a Data instance is returned. Use its array
+
Note that a Data instance is returned. Use its array
attribute to return the data as a numpy array.
The units, calendar and fill value properties are, if set, inserted into the data.
@@ -175,7 +175,7 @@data¶
Return the data.
f.data is equivalent to f.get_data()
Note that a Data instance is returned. Use its array
+
Note that a Data instance is returned. Use its array
attribute to return the data as a numpy array.
The units, calendar and fill value properties are, if set, inserted into the data.
@@ -175,7 +175,7 @@data¶
Return the data.
f.data is equivalent to f.get_data()
Note that a Data instance is returned. Use its array
+
Note that a Data instance is returned. Use its array
attribute to return the data as a numpy array.
The units, calendar and fill value properties are, if set, inserted into the data.
@@ -175,7 +175,7 @@data¶
Return the data.
f.data is equivalent to f.get_data()
Note that a Data instance is returned. Use its array
+
Note that a Data instance is returned. Use its array
attribute to return the data as a numpy array.
The units, calendar and fill value properties are, if set, inserted into the data.
@@ -175,7 +175,7 @@data¶
Return the data.
f.data is equivalent to f.get_data()
Note that a Data instance is returned. Use its array
+
Note that a Data instance is returned. Use its array
attribute to return the data as a numpy array.
The units, calendar and fill value properties are, if set, inserted into the data.
@@ -175,7 +175,7 @@data¶
Return the data.
f.data is equivalent to f.get_data()
Note that a Data instance is returned. Use its array
+
Note that a Data instance is returned. Use its array
attribute to return the data as a numpy array.
The units, calendar and fill value properties are, if set, inserted into the data.
@@ -175,7 +175,7 @@Version 1.10.0.0 for version 1.10 of the CF conventions.
+Version 1.10.0.1 for version 1.10 of the CF conventions.
cfdm.AuxiliaryCoordinate(properties=None, data=None, bounds=None, geometry=None, interior_ring=None, source=None, copy=True, _use_data=True)[source]¶Bases: cfdm.mixin.netcdf.NetCDFVariable, cfdm.mixin.coordinate.Coordinate, cfdm.core.auxiliarycoordinate.AuxiliaryCoordinate
cfdm.AuxiliaryCoordinate(properties=None, data=None, bounds=None, geometry=None, interior_ring=None, source=None, copy=True, _use_data=True)[source]¶
+Bases: cfdm.mixin.netcdf.NetCDFVariable, cfdm.mixin.coordinate.Coordinate, cfdm.mixin.files.Files, cfdm.core.auxiliarycoordinate.AuxiliaryCoordinate
An auxiliary coordinate construct of the CF data model.
An auxiliary coordinate construct provides information which locate the cells of the domain and which depend on a subset of the @@ -167,7 +167,7 @@
dict, optional+- properties:
dict, optionalSet descriptive properties. The dictionary keys are property names, with corresponding values. Ignored if the source parameter is set.
@@ -193,7 +193,7 @@Related Topics
The bounds array may also be set after initialisation with the
-set_boundsmethod.- geometry:
str, optionalSet the geometry type. Ignored if the source +
- geometry:
str, optional- -
Set the geometry type. Ignored if the source parameter is set.
The geometry type may also be set after initialisation with the
@@ -213,7 +213,7 @@set_geometrymethod.Related Topics
cfdm.AuxiliaryCoordinate(source=source)is equivalent tosource.copy().- copy:
bool, optionalIf True (the default) deep copy input parameters prior +
- copy:
bool, optional- @@ -513,7 +513,10 @@
If True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Miscellaneous
- Return the name of the file or files containing the data.
+ + +
cfdm.AuxiliaryCoordinate.original_filenames+ @@ -574,16 +577,16 @@ Bring data on disk into memory.
Special
- + Called by the
copy.deepcopyfunction.Called by the
copy.deepcopyfunction.Return a subspace of the construct defined by indices.
- + Called by the
reprbuilt-in function.Called by the
reprbuilt-in function.@@ -623,7 +626,7 @@ - + Called by the
strbuilt-in function.Called by the
strbuilt-in function.Docstring substitutions
cfdm.Bounds(properties=None, data=None, source=None, copy=True, _use_data=True)[source]¶Bases: cfdm.mixin.netcdf.NetCDFVariable, cfdm.mixin.netcdf.NetCDFDimension, cfdm.mixin.propertiesdata.PropertiesData, cfdm.core.bounds.Bounds
cfdm.Bounds(properties=None, data=None, source=None, copy=True, _use_data=True)[source]¶
+Bases: cfdm.mixin.netcdf.NetCDFVariable, cfdm.mixin.netcdf.NetCDFDimension, cfdm.mixin.propertiesdata.PropertiesData, cfdm.mixin.files.Files, cfdm.core.bounds.Bounds
A cell bounds component.
Specifically, a cell bounds component of a coordinate or domain ancillary construct of the CF data model.
@@ -163,7 +163,7 @@dict, optionalSet descriptive properties. The dictionary keys are +
dict, optionalSet 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 @@ -189,7 +189,7 @@
source.copy().
bool, optionalIf True (the default) deep copy input parameters prior +
bool, optionalIf True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Return the name of the file or files containing the data.
cfdm.Bounds.original_filenames
Bring data on disk into memory.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
Return a subspace defined by indices.
Called by the repr built-in function.
Called by the repr built-in function.
Called by the str built-in function.
Called by the str built-in function.
cfdm.CellMeasure(measure=None, properties=None, data=None, source=None, copy=True, _use_data=True)[source]¶Bases: cfdm.mixin.netcdf.NetCDFVariable, cfdm.mixin.netcdf.NetCDFExternal, cfdm.mixin.propertiesdata.PropertiesData, cfdm.core.cellmeasure.CellMeasure
cfdm.CellMeasure(measure=None, properties=None, data=None, source=None, copy=True, _use_data=True)[source]¶
+Bases: cfdm.mixin.netcdf.NetCDFVariable, cfdm.mixin.netcdf.NetCDFExternal, cfdm.mixin.propertiesdata.PropertiesData, cfdm.mixin.files.Files, cfdm.core.cellmeasure.CellMeasure
A cell measure construct of the CF data model.
A cell measure construct provides information that is needed about the size or shape of the cells and that depends on a subset of the @@ -164,7 +164,7 @@
dict, optional+- properties:
dict, optionalSet descriptive properties. The dictionary keys are property names, with corresponding values. Ignored if the source parameter is set.
@@ -201,7 +201,7 @@Related Topics
cfdm.CellMeasure(source=source)is equivalent tosource.copy(). -- copy:
bool, optionalIf True (the default) deep copy input parameters prior +
- copy:
bool, optional- @@ -381,7 +381,10 @@
If True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Miscellaneous
- Return the name of the file or files containing the data.
+ + +
cfdm.CellMeasure.original_filenames+ @@ -448,16 +451,16 @@ Bring data on disk into memory.
Special
- + Called by the
copy.deepcopyfunction.Called by the
copy.deepcopyfunction.Return a subspace defined by indices.
- + Called by the
reprbuilt-in function.Called by the
reprbuilt-in function.@@ -497,7 +500,7 @@ - + Called by the
strbuilt-in function.Called by the
strbuilt-in function.Docstring substitutions
cfdm.CellMethod(axes=None, method=None, qualifiers=None, source=None, copy=True)[source]¶cfdm.CellMethod(axes=None, method=None, qualifiers=None, source=None, copy=True)[source]¶
Bases: cfdm.mixin.container.Container, cfdm.core.cellmethod.CellMethod
A cell method construct of the CF data model.
One or more cell method constructs describe how the cell values of @@ -148,7 +148,7 @@
str, optionalSet the axes of the cell method construct, specified +
str, optionalSet the axes of the cell method construct, specified
either by the construct identifiers of domain axis
constructs, standard names, or the special string
'area'.
str, optionalSet the axes of the cell method construct. Either one or +
str, optionalSet the axes of the cell method construct. Either one or more domain axis construct identifiers or standard names. Ignored if the source parameter is set.
The method may also be set after initialisation with the @@ -177,7 +177,7 @@
dict, optionalSet descriptive qualifiers. The dictionary keys are +
dict, optionalSet descriptive qualifiers. The dictionary keys are qualifier names, with corresponding values. Ignored if the source parameter is set.
Qualifiers may also be set after initialisation with the @@ -195,7 +195,7 @@
cfdm.CellMethod(source=source) is equivalent
to source.copy().
bool, optionalIf True (the default) deep copy input parameters prior +
bool, optionalIf True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
Called by the repr built-in function.
Called by the repr built-in function.
Called by the str built-in function.
Called by the str built-in function.
cfdm.CompressedArray(compressed_array=None, shape=None, size=None, ndim=None, compressed_dimension=None, compressed_dimensions=None, compression_type=None, source=None, copy=True)[source]¶cfdm.CompressedArray(compressed_array=None, shape=None, size=None, ndim=None, compressed_dimension=None, compressed_dimensions=None, compression_type=None, source=None, copy=True)[source]¶
Bases: cfdm.data.abstract.array.Array
Mixin class for a container of an underlying compressed array.
The compressed array.
tupleThe uncompressed array dimension sizes.
+tupleThe uncompressed array dimension sizes.
dictMapping of dimensions of the compressed array to their +
dictMapping of dimensions of the compressed array to their corresponding dimensions in the uncompressed array. Compressed array dimensions that are not compressed must be omitted from the mapping.
@@ -160,7 +160,7 @@strThe type of compression.
+strThe type of compression.
Further named parameters and their values needed to define the compressed array.
@@ -175,18 +175,18 @@bool, optionalIf True (the default) then deep copy input parameters +
bool, optionalIf True (the default) then deep copy input parameters prior to initialisation. If False then arguments are not deep copied.
New in version (cfdm): 1.10.0.0
intDeprecated at version 1.10.0.0. If set will be +
intDeprecated at version 1.10.0.0. If set will be ignored.
Number of elements in the uncompressed array.
intDeprecated at version 1.10.0.0. If set will be +
intDeprecated at version 1.10.0.0. If set will be ignored.
The number of uncompressed array dimensions
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
Return a subspace of the uncompressed subarray.
Called by the repr built-in function.
Called by the repr built-in function.
Called by the str built-in function.
Called by the str built-in function.
cfdm.Configuration[source]¶Bases: dict
cfdm.Configuration[source]¶
+Bases: dict
Dictionary-like container for the global constants.
The container has context manager support.
-Initialisation is as for a dict, and nearly all of the dict
+
Initialisation is as for a dict, and nearly all of the dict
methods are available with the same behaviours (clear,
fromkeys, get, items, keys, pop, popitem,
setdefault, update, values):
Called by the repr built-in function.
Called by the repr built-in function.
cfdm.Constant(value, _func=None)[source]¶Bases: object
cfdm.Constant(value, _func=None)[source]¶
+Bases: object
A container for a constant with context manager support.
The constant value is accessed via the value attribute:
>>> c = cfdm.Constant(1.2)
@@ -135,7 +135,7 @@ cfdm.Constant1.2
Conversion to int, float, str and bool is with the usual
+
Conversion to int, float, str and bool is with the usual
built-in functions:
>>> c = cfdm.Constant(1.2)
>>> int(c)
@@ -195,7 +195,7 @@ cfdm.Constantint
Unary arithmetic operations (+, -, abs) are equivalent
+
Unary arithmetic operations (+, -, abs) are equivalent
to the operation acting on the Constant object’s value
attribute:
>>> c = cfdm.Constant(-20)
@@ -321,7 +321,7 @@ SpecialCalled by the copy.deepcopy function.
Called by the copy.deepcopy function.
Enter the runtime context.
SpecialCalled by the repr built-in function.
Called by the repr built-in function.
Called by the str built-in function.
Called by the str built-in function.
Special
cfdm.Constructs(auxiliary_coordinate=None, dimension_coordinate=None, domain_ancillary=None, field_ancillary=None, cell_measure=None, coordinate_reference=None, domain_axis=None, cell_method=None, source=None, copy=True, _use_data=True, _view=False, _ignore=())[source]¶cfdm.Constructs(auxiliary_coordinate=None, dimension_coordinate=None, domain_ancillary=None, field_ancillary=None, cell_measure=None, coordinate_reference=None, domain_axis=None, cell_method=None, source=None, copy=True, _use_data=True, _view=False, _ignore=())[source]¶
Bases: cfdm.mixin.container.Container, cfdm.core.constructs.Constructs
A container for metadata constructs.
The following metadata constructs can be included:
@@ -159,52 +159,52 @@str, optionalThe base name for keys of auxiliary coordinate +
str, optionalThe base name for keys of auxiliary coordinate constructs.
auxiliary_coordinate='auxiliarycoordinate'
str, optionalThe base name for keys of dimension coordinate +
str, optionalThe base name for keys of dimension coordinate constructs.
dimension_coordinate='dimensioncoordinate'
str, optionalThe base name for keys of domain ancillary constructs.
+str, optionalThe base name for keys of domain ancillary constructs.
domain_ancillary='domainancillary'
str, optionalThe base name for keys of field ancillary constructs.
+str, optionalThe base name for keys of field ancillary constructs.
field_ancillary='fieldancillary'
str, optionalThe base name for keys of cell measure constructs.
+str, optionalThe base name for keys of cell measure constructs.
cell_measure='cellmeasure'
str, optionalThe base name for keys of coordinate reference +
str, optionalThe base name for keys of coordinate reference constructs.
coordinate_reference='coordinatereference'
str, optionalThe base name for keys of domain axis constructs.
+str, optionalThe base name for keys of domain axis constructs.
domain_axis='domainaxis'
str, optionalThe base name for keys of cell method constructs.
+str, optionalThe base name for keys of cell method constructs.
cell_method='cellmethod'
bool, optionalIf True (the default) then deep copy metadata constructs +
bool, optionalIf True (the default) then deep copy metadata constructs from those of source prior to initialisation, else they are not deep copied.
str, optionalIgnores the given construct types.
+str, optionalIgnores the given construct types.
_ignore=('cell_method', 'field_ancillary')
Called by the copy.copy standard library function.
Called by the copy.copy standard library function.
Called by the copy.deepcopy standard library function.
Called by the copy.deepcopy standard library function.
Return a construct with the given key.
Called by the repr built-in function.
Called by the repr built-in function.
Called by the str built-in function.
Called by the str built-in function.
cfdm.CoordinateConversion(parameters=None, domain_ancillaries=None, source=None, copy=True)[source]¶cfdm.CoordinateConversion(parameters=None, domain_ancillaries=None, source=None, copy=True)[source]¶
Bases: cfdm.mixin.parametersdomainancillaries.ParametersDomainAncillaries, cfdm.core.coordinateconversion.CoordinateConversion
A coordinate conversion component.
Specifically, a coordinate conversion component of a coordinate @@ -148,7 +148,7 @@
dict, optionalSet parameters. The dictionary keys are term names, +
dict, optionalSet parameters. The dictionary keys are term names, with corresponding parameter values. Ignored if the source parameter is set.
Parameters may also be set after initialisation with @@ -158,7 +158,7 @@
dict, optionalSet references to domain ancillary constructs. The +
dict, optionalSet references to domain ancillary constructs. The dictionary keys are term names, with corresponding domain ancillary construct keys. Ignored if the source parameter is set.
@@ -176,7 +176,7 @@source.copy().
bool, optionalIf True (the default) deep copy input parameters prior +
bool, optionalIf True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Called by the bool built-in function.
Called by the bool built-in function.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
cfdm.CoordinateConversion.__nonzero__
Called by the repr built-in function.
Called by the repr built-in function.
Called by the str built-in function.
Called by the str built-in function.
cfdm.CoordinateReference(coordinates=None, datum=None, coordinate_conversion=None, source=None, copy=True)[source]¶Bases: cfdm.mixin.netcdf.NetCDFVariable, cfdm.mixin.container.Container, cfdm.core.coordinatereference.CoordinateReference
cfdm.CoordinateReference(coordinates=None, datum=None, coordinate_conversion=None, source=None, copy=True)[source]¶
+Bases: cfdm.mixin.netcdf.NetCDFVariable, cfdm.mixin.container.Container, cfdm.mixin.files.Files, cfdm.core.coordinatereference.CoordinateReference
A coordinate reference construct of the CF data model.
A coordinate reference construct relates the coordinate values of the coordinate system to locations in a planetary reference frame.
@@ -184,7 +184,7 @@str, optionalIdentify the related dimension and auxiliary +
str, optionalIdentify the related dimension and auxiliary coordinate constructs by their construct identifiers. Ignored if the source parameter is set.
The coordinates may also be set after initialisation @@ -215,7 +215,7 @@
cfdm.CoordinateReference(source=source) is equivalent
to source.copy().
bool, optionalIf True (the default) deep copy input parameters prior +
bool, optionalIf True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
Called by the repr built-in function.
Called by the repr built-in function.
Called by the str built-in function.
Called by the str built-in function.
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
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.mixin.files.Files, 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 @@ -160,7 +160,7 @@
dict, optionalSet descriptive properties. The dictionary keys are +
dict, optionalSet 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 @@ -189,7 +189,7 @@
source.copy().
bool, optionalIf True (the default) deep copy input parameters prior +
bool, optionalIf True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Return the name of the file or files containing the data.
cfdm.Count.original_filenames
Whether or not there are cell bounds.
Uncompress the construct.
Bring data on disk into memory.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
Return a subspace defined by indices.
Called by the repr built-in function.
Called by the repr built-in function.
Called by the str built-in function.
Called by the str built-in function.
cfdm.Data(array=None, units=None, calendar=None, fill_value=None, source=None, copy=True, dtype=None, mask=None, _use_array=True, **kwargs)[source]¶Bases: cfdm.mixin.container.Container, cfdm.mixin.netcdf.NetCDFHDF5, cfdm.core.data.data.Data
cfdm.Data(array=None, units=None, calendar=None, fill_value=None, source=None, copy=True, dtype=None, mask=None, _use_array=True, **kwargs)[source]¶
+Bases: cfdm.mixin.container.Container, cfdm.mixin.netcdf.NetCDFHDF5, cfdm.mixin.files.Files, cfdm.core.data.data.Data
An orthogonal multidimensional array with masking and units.
New in version (cfdm): 1.7.0
@@ -150,7 +150,7 @@str, optionalThe physical units of the data. Ignored if the source +
str, optionalThe physical units of the data. Ignored if the source parameter is set.
The units may also be set after initialisation with the
set_units method.
str, optionalThe calendar for reference time units. Ignored if the +
str, optionalThe calendar for reference time units. Ignored if the source parameter is set.
The calendar may also be set after initialisation with the
set_calendar method.
None, the numpy fill value appropriate to the array’s
+None, the numpy fill value appropriate to the array’s
data type will be used (see
numpy.ma.default_fill_value). Ignored if the source
parameter is set.
@@ -196,10 +196,10 @@ None, no mask
+parameter. By default, or if mask is None, no mask
is applied. May be any data_like object that
broadcasts to array. Masking will be carried out
-where mask elements evaluate to True.
+where mask elements evaluate to True.
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
@@ -213,7 +213,7 @@
source.copy().
bool, optionalIf True (the default) then deep copy input +
bool, optionalIf True (the default) then deep copy input parameters prior to initialisation, else they are not (deep) copied.
Return the name of the file containing the data array.
cfdm.Data.original_filenames
Return the underlying array object.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
Return a subspace of the data defined by indices.
Called by the int built-in function.
Called by the int built-in function.
Called when an iterator is required.
Called by the repr built-in function.
Called by the repr built-in function.
Assign to data elements defined by indices.
Called by the str built-in function.
Called by the str built-in function.
cfdm.Datum(parameters=None, source=None, copy=True)[source]¶Bases: cfdm.mixin.parameters.Parameters, cfdm.mixin.netcdf.NetCDFVariable, cfdm.core.datum.Datum
cfdm.Datum(parameters=None, source=None, copy=True)[source]¶
+Bases: cfdm.mixin.parameters.Parameters, cfdm.mixin.netcdf.NetCDFVariable, cfdm.mixin.files.Files, cfdm.core.datum.Datum
A datum component of a CF data model coordinate reference.
A datum is a complete or partial definition of the zeroes of the dimension and auxiliary coordinate constructs which define a @@ -155,7 +155,7 @@
dict, optionalSet parameters. The dictionary keys are parameter +
dict, optionalSet parameters. The dictionary keys are parameter names, with corresponding values. Ignored if the source parameter is set.
Parameters may also be set after initialisation with @@ -170,7 +170,7 @@
source.copy().
bool, optionalIf True (the default) deep copy input parameters prior +
bool, optionalIf True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Called by the bool built-in function.
Called by the bool built-in function.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
cfdm.Datum.__nonzero__
Called by the repr built-in function.
Called by the repr built-in function.
Called by the str built-in function.
Called by the str built-in function.
cfdm.DimensionCoordinate(properties=None, data=None, bounds=None, geometry=None, interior_ring=None, source=None, copy=True, _use_data=True)[source]¶Bases: cfdm.mixin.netcdf.NetCDFVariable, cfdm.mixin.coordinate.Coordinate, cfdm.core.dimensioncoordinate.DimensionCoordinate
cfdm.DimensionCoordinate(properties=None, data=None, bounds=None, geometry=None, interior_ring=None, source=None, copy=True, _use_data=True)[source]¶
+Bases: cfdm.mixin.netcdf.NetCDFVariable, cfdm.mixin.coordinate.Coordinate, cfdm.mixin.files.Files, cfdm.core.dimensioncoordinate.DimensionCoordinate
A dimension coordinate construct of the CF data model.
A dimension coordinate construct provides information which locate the cells of the domain and which depend on a subset of the domain @@ -167,7 +167,7 @@
dict, optional+- properties:
dict, optionalSet descriptive properties. The dictionary keys are property names, with corresponding values. Ignored if the source parameter is set.
@@ -193,7 +193,7 @@Related Topics
The bounds array may also be set after initialisation with the
-set_boundsmethod.- geometry:
str, optionalSet the geometry type. Ignored if the source +
- geometry:
str, optional- -
Set the geometry type. Ignored if the source parameter is set.
The geometry type may also be set after initialisation with the
@@ -213,7 +213,7 @@set_geometrymethod.Related Topics
cfdm.DimensionCoordinate(source=source)is equivalent tosource.copy().- copy:
bool, optionalIf True (the default) deep copy input parameters prior +
- copy:
bool, optional- @@ -513,7 +513,10 @@
If True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Miscellaneous
- Return the name of the file or files containing the data.
+ + +
cfdm.DimensionCoordinate.original_filenames+ @@ -574,16 +577,16 @@ Bring data on disk into memory.
Special
- + Called by the
copy.deepcopyfunction.Called by the
copy.deepcopyfunction.Return a subspace of the construct defined by indices.
- + Called by the
reprbuilt-in function.Called by the
reprbuilt-in function.@@ -623,7 +626,7 @@ - + Called by the
strbuilt-in function.Called by the
strbuilt-in function.Docstring substitutions
cfdm.Domain(properties=None, source=None, copy=True, _use_data=True)[source]¶Bases: cfdm.mixin.fielddomain.FieldDomain, cfdm.mixin.netcdf.NetCDFVariable, cfdm.mixin.netcdf.NetCDFGeometry, cfdm.mixin.netcdf.NetCDFGlobalAttributes, cfdm.mixin.netcdf.NetCDFGroupAttributes, cfdm.mixin.netcdf.NetCDFComponents, cfdm.mixin.netcdf.NetCDFUnreferenced, cfdm.mixin.properties.Properties, cfdm.core.domain.Domain
cfdm.Domain(properties=None, source=None, copy=True, _use_data=True)[source]¶
+Bases: cfdm.mixin.fielddomain.FieldDomain, cfdm.mixin.netcdf.NetCDFVariable, cfdm.mixin.netcdf.NetCDFGeometry, cfdm.mixin.netcdf.NetCDFGlobalAttributes, cfdm.mixin.netcdf.NetCDFGroupAttributes, cfdm.mixin.netcdf.NetCDFComponents, cfdm.mixin.netcdf.NetCDFUnreferenced, cfdm.mixin.properties.Properties, cfdm.mixin.files.Files, cfdm.core.domain.Domain
A domain construct of the CF data model.
The domain represents a set of discrete “locations” in what generally would be a multi-dimensional space, either in the real @@ -180,7 +180,7 @@
dict, optionalSet descriptive properties. The dictionary keys are +
dict, optionalSet 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 @@ -198,7 +198,7 @@
A new domain may also be instantiated with the
fromconstructs class method.
bool, optionalIf True (the default) deep copy input parameters prior +
bool, optionalIf True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Apply masking as defined by the CF conventions.
Return the file names containing the metadata construct data.
cfdm.Domain.original_filenames
Uncompress the domain construct.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
Called by the repr built-in function.
Called by the repr built-in function.
Called by the str built-in function.
Called by the str built-in function.
cfdm.DomainAncillary(properties=None, data=None, bounds=None, geometry=None, interior_ring=None, source=None, copy=True, _use_data=True)[source]¶Bases: cfdm.mixin.netcdf.NetCDFVariable, cfdm.mixin.propertiesdatabounds.PropertiesDataBounds, cfdm.core.domainancillary.DomainAncillary
cfdm.DomainAncillary(properties=None, data=None, bounds=None, geometry=None, interior_ring=None, source=None, copy=True, _use_data=True)[source]¶
+Bases: cfdm.mixin.netcdf.NetCDFVariable, cfdm.mixin.propertiesdatabounds.PropertiesDataBounds, cfdm.mixin.files.Files, cfdm.core.domainancillary.DomainAncillary
A domain ancillary construct of the CF data model.
A domain ancillary construct provides information which is needed for computing the location of cells in an alternative coordinate @@ -156,7 +156,7 @@
dict, optional+- properties:
dict, optionalSet descriptive properties. The dictionary keys are property names, with corresponding values. Ignored if the source parameter is set.
@@ -182,7 +182,7 @@Related Topics
The bounds array may also be set after initialisation with the
-set_boundsmethod.- geometry:
str, optionalSet the geometry type. Ignored if the source +
- geometry:
str, optional- -
Set the geometry type. Ignored if the source parameter is set.
The geometry type may also be set after initialisation with the
@@ -202,7 +202,7 @@set_geometrymethod.Related Topics
cfdm.DomainAncillary(source=source)is equivalent tosource.copy().- copy:
bool, optionalIf True (the default) deep copy input parameters prior +
- copy:
bool, optional- @@ -478,7 +478,10 @@
If True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Miscellaneous
- Return the name of the file or files containing the data.
+ + +
cfdm.DomainAncillary.original_filenames+ @@ -539,16 +542,16 @@ Bring data on disk into memory.
Special
- + Called by the
copy.deepcopyfunction.Called by the
copy.deepcopyfunction.Return a subspace of the construct defined by indices.
- + Called by the
reprbuilt-in function.Called by the
reprbuilt-in function.@@ -588,7 +591,7 @@ - + Called by the
strbuilt-in function.Called by the
strbuilt-in function.Docstring substitutions
cfdm.DomainAxis(size=None, source=None, copy=True)[source]¶cfdm.DomainAxis(size=None, source=None, copy=True)[source]¶
Bases: cfdm.mixin.netcdf.NetCDFDimension, cfdm.mixin.netcdf.NetCDFUnlimitedDimension, cfdm.mixin.container.Container, cfdm.core.domainaxis.DomainAxis
A domain axis construct of the CF data model.
A domain axis construct specifies the number of points along an @@ -153,7 +153,7 @@
int, optionalThe size of the domain axis.
+int, optionalThe size of the domain axis.
The size may also be set after initialisation with the
set_size method.
cfdm.DomainAxis(source=source) is equivalent
to source.copy().
bool, optionalIf True (the default) deep copy input parameters prior +
bool, optionalIf True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
Called by the repr built-in function.
Called by the repr built-in function.
Called by the str built-in function.
Called by the str built-in function.
cfdm.Field(properties=None, source=None, copy=True, _use_data=True)[source]¶Bases: cfdm.mixin.netcdf.NetCDFVariable, cfdm.mixin.netcdf.NetCDFGeometry, cfdm.mixin.netcdf.NetCDFGlobalAttributes, cfdm.mixin.netcdf.NetCDFGroupAttributes, cfdm.mixin.netcdf.NetCDFComponents, cfdm.mixin.netcdf.NetCDFUnreferenced, cfdm.mixin.fielddomain.FieldDomain, cfdm.mixin.propertiesdata.PropertiesData, cfdm.core.field.Field
cfdm.Field(properties=None, source=None, copy=True, _use_data=True)[source]¶
+Bases: cfdm.mixin.netcdf.NetCDFVariable, cfdm.mixin.netcdf.NetCDFGeometry, cfdm.mixin.netcdf.NetCDFGlobalAttributes, cfdm.mixin.netcdf.NetCDFGroupAttributes, cfdm.mixin.netcdf.NetCDFComponents, cfdm.mixin.netcdf.NetCDFUnreferenced, cfdm.mixin.fielddomain.FieldDomain, cfdm.mixin.propertiesdata.PropertiesData, cfdm.mixin.files.Files, cfdm.core.field.Field
A field construct of the CF data model.
The field construct is central to the CF data model, and includes all the other constructs. A field corresponds to a CF-netCDF data @@ -193,7 +193,7 @@
dict, optionalSet descriptive properties. The dictionary keys are +
dict, optionalSet 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 @@ -209,7 +209,7 @@
cfdm.Field(source=source) is equivalent
to source.copy().
bool, optionalIf True (the default) deep copy input parameters prior +
bool, optionalIf True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Return the names of the files containing the data.
cfdm.Field.original_filenames
Bring data on disk into memory.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
Return a subspace of the field defined by indices.
Called by the repr built-in function.
Called by the repr built-in function.
Called by the str built-in function.
Called by the str built-in function.
cfdm.FieldAncillary(properties=None, data=None, source=None, copy=True, _use_data=True)[source]¶Bases: cfdm.mixin.netcdf.NetCDFVariable, cfdm.mixin.propertiesdata.PropertiesData, cfdm.core.fieldancillary.FieldAncillary
cfdm.FieldAncillary(properties=None, data=None, source=None, copy=True, _use_data=True)[source]¶
+Bases: cfdm.mixin.netcdf.NetCDFVariable, cfdm.mixin.propertiesdata.PropertiesData, cfdm.mixin.files.Files, cfdm.core.fieldancillary.FieldAncillary
A field ancillary construct of the CF data model.
The field ancillary construct provides metadata which are distributed over the same sampling domain as the field itself. For @@ -161,7 +161,7 @@
dict, optional+- properties:
dict, optionalSet descriptive properties. The dictionary keys are property names, with corresponding values. Ignored if the source parameter is set.
@@ -188,7 +188,7 @@Related Topics
cfdm.FieldAncillary(source=source)is equivalent tosource.copy(). -- copy:
bool, optionalIf True (the default) deep copy input parameters prior +
- copy:
bool, optional- @@ -356,7 +356,10 @@
If True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Miscellaneous
- Return the name of the file or files containing the data.
+ + +
cfdm.FieldAncillary.original_filenames+ @@ -417,16 +420,16 @@ Bring data on disk into memory.
Special
- + Called by the
copy.deepcopyfunction.Called by the
copy.deepcopyfunction.Return a subspace defined by indices.
- + Called by the
reprbuilt-in function.Called by the
reprbuilt-in function.@@ -466,7 +469,7 @@ - + Called by the
strbuilt-in function.Called by the
strbuilt-in function.Docstring substitutions
cfdm.GatheredArray(compressed_array=None, shape=None, size=None, ndim=None, compressed_dimension=None, compressed_dimensions=None, list_variable=None, source=None, copy=True)[source]¶cfdm.GatheredArray(compressed_array=None, shape=None, size=None, ndim=None, compressed_dimension=None, compressed_dimensions=None, list_variable=None, source=None, copy=True)[source]¶
Bases: cfdm.data.abstract.compressedarray.CompressedArray
An underlying gathered array.
Compression by gathering combines axes of a multidimensional array @@ -144,9 +144,9 @@
The compressed array.
tupleThe shape of the uncompressed array.
+tupleThe shape of the uncompressed array.
dictMapping of dimensions of the compressed array to their +
dictMapping of dimensions of the compressed array to their corresponding dimensions in the uncompressed array. Compressed array dimensions that are not compressed must be omitted from the mapping.
@@ -171,17 +171,17 @@bool, optionalIf True (the default) then deep copy input +
bool, optionalIf True (the default) then deep copy input parameters prior to initialisation, else they are not (deep) copied.
New in version (cfdm): 1.10.0.0
intDeprecated at version 1.10.0.0. Ignored if set.
+intDeprecated at version 1.10.0.0. Ignored if set.
Number of elements in the uncompressed array.
intDeprecated at version 1.10.0.0. Ignored if set.
+intDeprecated at version 1.10.0.0. Ignored if set.
The number of uncompressed array dimensions
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
Return a subspace of the uncompressed data.
Called by the repr built-in function.
Called by the repr built-in function.
Called by the str built-in function.
Called by the str built-in function.
cfdm.Index(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
cfdm.Index(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.mixin.files.Files, cfdm.core.abstract.propertiesdata.PropertiesData
An index variable required to uncompress a ragged array.
A collection of features stored using an indexed ragged array combines all features along a single dimension (the sample @@ -173,7 +173,7 @@
dict, optionalSet descriptive properties. The dictionary keys are +
dict, optionalSet 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 @@ -197,7 +197,7 @@
source.copy().
bool, optionalIf True (the default) deep copy input parameters prior +
bool, optionalIf True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Return the name of the file or files containing the data.
cfdm.Index.original_filenames
Whether or not there are cell bounds.
Uncompress the construct.
Bring data on disk into memory.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
Return a subspace defined by indices.
Called by the repr built-in function.
Called by the repr built-in function.
Called by the str built-in function.
Called by the str built-in function.
cfdm.InteriorRing(properties=None, data=None, source=None, copy=True, _use_data=True)[source]¶Bases: cfdm.mixin.netcdf.NetCDFDimension, cfdm.mixin.netcdf.NetCDFVariable, cfdm.mixin.propertiesdata.PropertiesData, cfdm.core.interiorring.InteriorRing
cfdm.InteriorRing(properties=None, data=None, source=None, copy=True, _use_data=True)[source]¶
+Bases: cfdm.mixin.netcdf.NetCDFDimension, cfdm.mixin.netcdf.NetCDFVariable, cfdm.mixin.propertiesdata.PropertiesData, cfdm.mixin.files.Files, cfdm.core.interiorring.InteriorRing
An interior ring array with properties.
If a cell is composed of multiple polygon parts, an individual polygon may define an “interior ring”, i.e. a region that is to be @@ -162,7 +162,7 @@
dict, optionalSet descriptive properties. The dictionary keys are +
dict, optionalSet 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 @@ -187,7 +187,7 @@
source.copy().
bool, optionalIf True (the default) deep copy input parameters prior +
bool, optionalIf True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Return the name of the file or files containing the data.
cfdm.InteriorRing.original_filenames
Bring data on disk into memory.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
Return a subspace defined by indices.
Called by the repr built-in function.
Called by the repr built-in function.
Called by the str built-in function.
Called by the str built-in function.
cfdm.List(properties=None, data=None, source=None, copy=True, _use_data=True)[source]¶Bases: cfdm.mixin.netcdf.NetCDFVariable, cfdm.mixin.propertiesdata.PropertiesData, cfdm.core.abstract.propertiesdata.PropertiesData
cfdm.List(properties=None, data=None, source=None, copy=True, _use_data=True)[source]¶
+Bases: cfdm.mixin.netcdf.NetCDFVariable, cfdm.mixin.propertiesdata.PropertiesData, cfdm.mixin.files.Files, cfdm.core.abstract.propertiesdata.PropertiesData
A list variable required to uncompress a gathered array.
Compression by gathering combines axes of a multidimensional array into a new, discrete axis whilst omitting the missing values and @@ -149,7 +149,7 @@
dict, optionalSet descriptive properties. The dictionary keys are +
dict, optionalSet 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 @@ -174,7 +174,7 @@
source.copy().
bool, optionalIf True (the default) deep copy input parameters prior +
bool, optionalIf True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Return the name of the file or files containing the data.
cfdm.List.original_filenames
Whether or not there are cell bounds.
Uncompress the construct.
Bring data on disk into memory.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
Return a subspace defined by indices.
Called by the repr built-in function.
Called by the repr built-in function.
Called by the str built-in function.
Called by the str built-in function.
cfdm.NetCDFArray(filename=None, ncvar=None, varid=None, group=None, dtype=None, ndim=None, shape=None, size=None, mask=True, source=None, copy=True)[source]¶cfdm.NetCDFArray(filename=None, ncvar=None, varid=None, group=None, dtype=None, ndim=None, shape=None, size=None, mask=True, source=None, copy=True)[source]¶
Bases: cfdm.data.abstract.array.Array
An underlying array stored in a netCDF file.
strThe name of the netCDF file containing the array.
+strThe name of the netCDF file containing the array.
str, optionalThe name of the netCDF variable containing the +
str, optionalThe name of the netCDF variable containing the array. Required unless varid is set.
int, optionalThe UNIDATA netCDF interface ID of the variable +
int, optionalThe UNIDATA netCDF interface ID of the variable containing the array. Required if ncvar is not set, ignored if ncvar is set.
None or sequence of str, optionalSpecify the netCDF4 group to which the netCDF variable
-belongs. By default, or if group is None or an
+
None or sequence of str, optionalSpecify the netCDF4 group to which the netCDF variable
+belongs. By default, or if group is None or an
empty sequence, it assumed to be in the root
group. The last element in the sequence is the name of
the group in which the variable lies, with other
@@ -168,16 +168,16 @@
numpy.dtypeThe data type of the array in the netCDF file. May be
-None if the numpy data-type is not known (which can be
+None if the numpy data-type is not known (which can be
the case for netCDF string types, for example).
tupleThe array dimension sizes in the netCDF file.
+tupleThe array dimension sizes in the netCDF file.
intNumber of elements in the array in the netCDF file.
+intNumber of elements in the array in the netCDF file.
intThe number of array dimensions in the netCDF file.
+intThe number of array dimensions in the netCDF file.
boolIf True (the default) then mask by convention when +
boolIf True (the default) then mask by convention when reading data from disk.
A netCDF array is masked depending on the values of any of
the netCDF variable attributes valid_min,
@@ -195,7 +195,7 @@
bool, optionalIf True (the default) then deep copy input +
bool, optionalIf True (the default) then deep copy input parameters prior to initialisation, else they are not (deep) copied.
cfdm.RaggedContiguousArray(compressed_array=None, shape=None, size=None, ndim=None, count_variable=None, source=None, copy=True)[source]¶cfdm.RaggedContiguousArray(compressed_array=None, shape=None, size=None, ndim=None, count_variable=None, source=None, copy=True)[source]¶
Bases: cfdm.data.abstract.raggedarray.RaggedArray
An underlying contiguous ragged array.
A collection of features stored using a contiguous ragged array @@ -147,7 +147,7 @@
The compressed data.
tupleThe shape of the uncompressed array.
+tupleThe shape of the uncompressed array.
CountThe count variable required to uncompress the data, corresponding to a CF-netCDF count variable.
@@ -160,17 +160,17 @@bool, optionalIf True (the default) then deep copy input +
bool, optionalIf True (the default) then deep copy input parameters prior to initialisation, else they are not (deep) copied.
New in version (cfdm): 1.10.0.0
intDeprecated at version 1.10.0.0. Ignored if set.
+intDeprecated at version 1.10.0.0. Ignored if set.
Number of elements in the uncompressed array.
intDeprecated at version 1.10.0.0. Ignored if set.
+intDeprecated at version 1.10.0.0. Ignored if set.
The number of uncompressed array dimensions.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
Return a subspace of the uncompressed data.
Called by the repr built-in function.
Called by the repr built-in function.
Called by the str built-in function.
Called by the str built-in function.
cfdm.RaggedIndexedArray(compressed_array=None, shape=None, size=None, ndim=None, index_variable=None, source=None, copy=True)[source]¶cfdm.RaggedIndexedArray(compressed_array=None, shape=None, size=None, ndim=None, index_variable=None, source=None, copy=True)[source]¶
Bases: cfdm.data.abstract.raggedarray.RaggedArray
An underlying indexed ragged array.
A collection of features stored using an indexed ragged array @@ -148,7 +148,7 @@
The compressed array.
tupleThe shape of the uncompressed array.
+tupleThe shape of the uncompressed array.
IndexThe index variable required to uncompress the data, corresponding to a CF-netCDF index variable.
@@ -161,17 +161,17 @@bool, optionalIf True (the default) then deep copy input +
bool, optionalIf True (the default) then deep copy input parameters prior to initialisation, else they are not (deep) copied.
New in version (cfdm): 1.10.0.0
intDeprecated at version 1.10.0.0. Ignored if set.
+intDeprecated at version 1.10.0.0. Ignored if set.
Number of elements in the uncompressed array.
intDeprecated at version 1.10.0.0. Ignored if set.
+intDeprecated at version 1.10.0.0. Ignored if set.
The number of uncompressed array dimensions.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
Return a subspace of the uncompressed data.
Called by the repr built-in function.
Called by the repr built-in function.
Called by the str built-in function.
Called by the str built-in function.
cfdm.RaggedIndexedContiguousArray(compressed_array=None, shape=None, size=None, ndim=None, count_variable=None, index_variable=None, source=None, copy=True)[source]¶cfdm.RaggedIndexedContiguousArray(compressed_array=None, shape=None, size=None, ndim=None, count_variable=None, index_variable=None, source=None, copy=True)[source]¶
Bases: cfdm.data.abstract.raggedarray.RaggedArray
An underlying indexed contiguous ragged array.
A collection of features, each of which is sequence of (vertical) @@ -151,7 +151,7 @@
The compressed array.
tupleThe shape of the uncompressed array.
+tupleThe shape of the uncompressed array.
CountThe count variable required to uncompress the data, corresponding to a CF-netCDF count variable.
@@ -167,17 +167,17 @@bool, optionalIf True (the default) then deep copy input +
bool, optionalIf True (the default) then deep copy input parameters prior to initialisation, else they are not (deep) copied.
New in version (cfdm): 1.10.0.0
intDeprecated at version 1.10.0.0. Ignored if set.
+intDeprecated at version 1.10.0.0. Ignored if set.
Number of elements in the uncompressed array.
intDeprecated at version 1.10.0.0. Ignored if set.
+intDeprecated at version 1.10.0.0. Ignored if set.
The number of uncompressed array dimensions.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
Return a subspace of the uncompressed data.
Called by the repr built-in function.
Called by the repr built-in function.
Called by the str built-in function.
Called by the str built-in function.
cfdm.core.Array(source=None, copy=True)[source]¶cfdm.core.Array(source=None, copy=True)[source]¶
Bases: cfdm.core.abstract.container.Container
Abstract base class for a container of an array.
The form of the array is defined by the initialisation parameters @@ -199,7 +199,7 @@
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
cfdm.core.AuxiliaryCoordinate(properties=None, data=None, bounds=None, geometry=None, interior_ring=None, source=None, copy=True, _use_data=True)[source]¶cfdm.core.AuxiliaryCoordinate(properties=None, data=None, bounds=None, geometry=None, interior_ring=None, source=None, copy=True, _use_data=True)[source]¶
Bases: cfdm.core.abstract.coordinate.Coordinate
An auxiliary coordinate construct of the CF data model.
An auxiliary coordinate construct provides information which @@ -158,7 +158,7 @@
dict, optionalSet descriptive properties. The dictionary keys are +
dict, optionalSet 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 @@ -182,7 +182,7 @@
set_bounds method.
str, optionalSet the geometry type. Ignored if the source +
str, optionalSet the geometry type. Ignored if the source parameter is set.
The geometry type may also be set after initialisation
with the set_geometry method.
source.copy().
bool, optionalIf True (the default) deep copy input parameters prior +
bool, optionalIf True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
cfdm.core.Bounds(properties=None, data=None, source=None, copy=True, _use_data=True)[source]¶cfdm.core.Bounds(properties=None, data=None, source=None, copy=True, _use_data=True)[source]¶
Bases: cfdm.core.abstract.propertiesdata.PropertiesData
A cell bounds component.
That is, a cell bounds component of a coordinate or domain @@ -145,7 +145,7 @@
dict, optionalSet descriptive properties. The dictionary keys are +
dict, optionalSet 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 @@ -170,7 +170,7 @@
source.copy().
bool, optionalIf True (the default) deep copy input parameters prior +
bool, optionalIf True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
cfdm.core.CellMeasure(measure=None, properties=None, data=None, source=None, copy=True, _use_data=True)[source]¶cfdm.core.CellMeasure(measure=None, properties=None, data=None, source=None, copy=True, _use_data=True)[source]¶
Bases: cfdm.core.abstract.propertiesdata.PropertiesData
A cell measure construct of the CF data model.
A cell measure construct provides information that is needed about @@ -152,7 +152,7 @@
dict, optionalSet descriptive properties. The dictionary keys are +
dict, optionalSet 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 @@ -187,7 +187,7 @@
source.copy().
bool, optionalIf True (the default) deep copy input parameters prior +
bool, optionalIf True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
cfdm.core.CellMethod(axes=None, method=None, qualifiers=None, source=None, copy=True)[source]¶cfdm.core.CellMethod(axes=None, method=None, qualifiers=None, source=None, copy=True)[source]¶
Bases: cfdm.core.abstract.container.Container
A cell method construct of the CF data model.
One or more cell method constructs describe how the cell values of @@ -148,7 +148,7 @@
str, optionalSet the axes of the cell method construct, specified +
str, optionalSet the axes of the cell method construct, specified
either by the construct identifiers of domain axis
constructs, standard names, or the special string
'area'.
str, optionalSet the axes of the cell method construct. Either one or +
str, optionalSet the axes of the cell method construct. Either one or more domain axis construct identifiers or standard names. Ignored if the source parameter is set.
The method may also be set after initialisation with the @@ -177,7 +177,7 @@
dict, optionalSet descriptive qualifiers. The dictionary keys are +
dict, optionalSet descriptive qualifiers. The dictionary keys are qualifier names, with corresponding values. Ignored if the source parameter is set.
Qualifiers may also be set after initialisation with the @@ -195,7 +195,7 @@
source.copy().
bool, optionalIf True (the default) deep copy input parameters prior +
bool, optionalIf True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
cfdm.core.Constructs(auxiliary_coordinate=None, dimension_coordinate=None, domain_ancillary=None, field_ancillary=None, cell_measure=None, coordinate_reference=None, domain_axis=None, cell_method=None, source=None, copy=True, _use_data=True, _view=False, _ignore=())[source]¶cfdm.core.Constructs(auxiliary_coordinate=None, dimension_coordinate=None, domain_ancillary=None, field_ancillary=None, cell_measure=None, coordinate_reference=None, domain_axis=None, cell_method=None, source=None, copy=True, _use_data=True, _view=False, _ignore=())[source]¶
Bases: cfdm.core.abstract.container.Container
A container for metadata constructs.
The following metadata constructs can be included:
@@ -152,52 +152,52 @@str, optionalThe base name for keys of auxiliary coordinate +
str, optionalThe base name for keys of auxiliary coordinate constructs.
auxiliary_coordinate='auxiliarycoordinate'
str, optionalThe base name for keys of dimension coordinate +
str, optionalThe base name for keys of dimension coordinate constructs.
dimension_coordinate='dimensioncoordinate'
str, optionalThe base name for keys of domain ancillary constructs.
+str, optionalThe base name for keys of domain ancillary constructs.
domain_ancillary='domainancillary'
str, optionalThe base name for keys of field ancillary constructs.
+str, optionalThe base name for keys of field ancillary constructs.
field_ancillary='fieldancillary'
str, optionalThe base name for keys of cell measure constructs.
+str, optionalThe base name for keys of cell measure constructs.
cell_measure='cellmeasure'
str, optionalThe base name for keys of coordinate reference +
str, optionalThe base name for keys of coordinate reference constructs.
coordinate_reference='coordinatereference'
str, optionalThe base name for keys of domain axis constructs.
+str, optionalThe base name for keys of domain axis constructs.
domain_axis='domainaxis'
str, optionalThe base name for keys of cell method constructs.
+str, optionalThe base name for keys of cell method constructs.
cell_method='cellmethod'
Initialise the construct keys and contained metadata constructs from those of source.
bool, optionalIf True (the default) then deep copy metadata constructs +
bool, optionalIf True (the default) then deep copy metadata constructs from those of source prior to initialisation, else they are not deep copied.
str, optionalIgnores the given construct types.
+str, optionalIgnores the given construct types.
_ignore=('cell_method', 'field_ancillary')
Called by the copy.copy standard library function.
Called by the copy.copy standard library function.
Called by the copy.deepcopy standard library function.
Called by the copy.deepcopy standard library function.
Return a construct with the given key.
cfdm.core.Container(source=None, copy=True)[source]¶Bases: object
cfdm.core.Container(source=None, copy=True)[source]¶
+Bases: object
Abstract base class for storing components.
Warning
@@ -152,7 +152,7 @@source.copy().
-bool, optionalIf True (the default) deep copy input parameters prior +
bool, optionalIf True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
cfdm.core.Coordinate(properties=None, data=None, bounds=None, geometry=None, interior_ring=None, source=None, copy=True, _use_data=True)[source]¶cfdm.core.Coordinate(properties=None, data=None, bounds=None, geometry=None, interior_ring=None, source=None, copy=True, _use_data=True)[source]¶
Bases: cfdm.core.abstract.propertiesdatabounds.PropertiesDataBounds
Mixin for CF data model dimension and auxiliary coordinates.
dict, optionalSet descriptive properties. The dictionary keys are +
dict, optionalSet 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 @@ -160,7 +160,7 @@
set_bounds method.
str, optionalSet the geometry type. Ignored if the source +
str, optionalSet the geometry type. Ignored if the source parameter is set.
The geometry type may also be set after initialisation
with the set_geometry method.
source.copy().
bool, optionalIf True (the default) deep copy input parameters prior +
bool, optionalIf True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
cfdm.core.CoordinateConversion(parameters=None, domain_ancillaries=None, source=None, copy=True)[source]¶cfdm.core.CoordinateConversion(parameters=None, domain_ancillaries=None, source=None, copy=True)[source]¶
Bases: cfdm.core.abstract.parametersdomainancillaries.ParametersDomainAncillaries
A coordinate conversion for a coordinate reference.
That is, a coordinate conversion component of a coordinate @@ -148,7 +148,7 @@
dict, optionalSet parameters. The dictionary keys are term names, +
dict, optionalSet parameters. The dictionary keys are term names, with corresponding parameter values. Ignored if the source parameter is set.
Parameters may also be set after initialisation with @@ -158,7 +158,7 @@
dict, optionalSet references to domain ancillary constructs. The +
dict, optionalSet references to domain ancillary constructs. The dictionary keys are term names, with corresponding domain ancillary construct keys. Ignored if the source parameter is set.
@@ -176,7 +176,7 @@source.copy().
bool, optionalIf True (the default) deep copy input parameters prior +
bool, optionalIf True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
cfdm.core.CoordinateReference(coordinates=None, datum=None, coordinate_conversion=None, source=None, copy=True)[source]¶cfdm.core.CoordinateReference(coordinates=None, datum=None, coordinate_conversion=None, source=None, copy=True)[source]¶
Bases: cfdm.core.abstract.container.Container
A coordinate reference construct of the CF data model.
A coordinate reference construct relates the coordinate values of @@ -176,7 +176,7 @@
str, optionalIdentify the related dimension and auxiliary +
str, optionalIdentify the related dimension and auxiliary coordinate constructs by their construct identifiers. Ignored if the source parameter is set.
The coordinates may also be set after initialisation @@ -207,7 +207,7 @@
source.copy().
bool, optionalIf True (the default) deep copy input parameters prior +
bool, optionalIf True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
cfdm.core.Data(array=None, units=None, calendar=None, fill_value=None, source=None, copy=True, _use_array=True, _custom_deep_copy=False)[source]¶cfdm.core.Data(array=None, units=None, calendar=None, fill_value=None, source=None, copy=True, _use_array=True, _custom_deep_copy=False)[source]¶
Bases: cfdm.core.abstract.container.Container
An orthogonal multidimensional array with masking and units.
Ignored if the source parameter is set.
-str, optionalThe physical units of the data. Ignored if the +
str, optionalThe physical units of the data. Ignored if the source parameter is set.
The units may also be set after initialisation with
the set_units method.
str, optionalThe calendar for reference time units. Ignored if the +
str, optionalThe calendar for reference time units. Ignored if the source parameter is set.
The calendar may also be set after initialisation with
the set_calendar method.
None, the numpy fill value appropriate to the
+None, the numpy fill value appropriate to the
array’s data type will be used (see
numpy.ma.default_fill_value). Ignored if the
source parameter is set.
@@ -187,7 +187,7 @@ bool, optionalIf True (the default) deep copy input parameters prior +
bool, optionalIf True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
Return repr(self).
cfdm.core.Datum(parameters=None, source=None, copy=True)[source]¶cfdm.core.Datum(parameters=None, source=None, copy=True)[source]¶
Bases: cfdm.core.abstract.parameters.Parameters
A datum component of a coordinate reference of the CF data model.
A datum is a complete or partial definition of the zeroes of the @@ -147,7 +147,7 @@
dict, optionalSet parameters. The dictionary keys are parameter +
dict, optionalSet parameters. The dictionary keys are parameter names, with corresponding values. Ignored if the source parameter is set.
Parameters may also be set after initialisation with @@ -162,7 +162,7 @@
source.copy().
bool, optionalIf True (the default) deep copy input parameters prior +
bool, optionalIf True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
cfdm.core.DimensionCoordinate(properties=None, data=None, bounds=None, geometry=None, interior_ring=None, source=None, copy=True, _use_data=True)[source]¶cfdm.core.DimensionCoordinate(properties=None, data=None, bounds=None, geometry=None, interior_ring=None, source=None, copy=True, _use_data=True)[source]¶
Bases: cfdm.core.abstract.coordinate.Coordinate
A dimension coordinate construct of the CF data model.
A dimension coordinate construct provides information which locate @@ -159,7 +159,7 @@
dict, optionalSet descriptive properties. The dictionary keys are +
dict, optionalSet 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 @@ -183,7 +183,7 @@
set_bounds method.
str, optionalSet the geometry type. Ignored if the source +
str, optionalSet the geometry type. Ignored if the source parameter is set.
The geometry type may also be set after initialisation
with the set_geometry method.
source.copy().
bool, optionalIf True (the default) deep copy input parameters prior +
bool, optionalIf True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
cfdm.core.Domain(properties=None, source=None, copy=True, _use_data=True)[source]¶cfdm.core.Domain(properties=None, source=None, copy=True, _use_data=True)[source]¶
Bases: cfdm.core.mixin.fielddomain.FieldDomain, cfdm.core.abstract.properties.Properties
A domain construct of the CF data model.
The domain represents a set of discrete “locations” in what @@ -145,7 +145,7 @@
dict, optionalSet descriptive properties. The dictionary keys are +
dict, optionalSet 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 @@ -161,7 +161,7 @@
fromconstructs class method.
bool, optionalIf True (the default) deep copy input parameters prior +
bool, optionalIf True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
cfdm.core.DomainAncillary(properties=None, data=None, bounds=None, geometry=None, interior_ring=None, source=None, copy=True, _use_data=True)[source]¶cfdm.core.DomainAncillary(properties=None, data=None, bounds=None, geometry=None, interior_ring=None, source=None, copy=True, _use_data=True)[source]¶
Bases: cfdm.core.abstract.propertiesdatabounds.PropertiesDataBounds
A domain ancillary construct of the CF data model.
A domain ancillary construct provides information which is needed @@ -148,7 +148,7 @@
dict, optionalSet descriptive properties. The dictionary keys are +
dict, optionalSet 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 @@ -172,7 +172,7 @@
set_bounds method.
str, optionalSet the geometry type. Ignored if the source +
str, optionalSet the geometry type. Ignored if the source parameter is set.
The geometry type may also be set after initialisation
with the set_geometry method.
source.copy().
bool, optionalIf True (the default) deep copy input parameters prior +
bool, optionalIf True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
cfdm.core.DomainAxis(size=None, source=None, copy=True)[source]¶cfdm.core.DomainAxis(size=None, source=None, copy=True)[source]¶
Bases: cfdm.core.abstract.container.Container
A domain axis construct of the CF data model.
A domain axis construct specifies the number of points along an @@ -144,7 +144,7 @@
int, optionalThe size of the domain axis.
+int, optionalThe size of the domain axis.
size=192
source.copy().
bool, optionalIf True (the default) deep copy input parameters prior +
bool, optionalIf True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
cfdm.core.Field(properties=None, source=None, copy=True, _use_data=True)[source]¶cfdm.core.Field(properties=None, source=None, copy=True, _use_data=True)[source]¶
Bases: cfdm.core.mixin.fielddomain.FieldDomain, cfdm.core.abstract.propertiesdata.PropertiesData
A field construct of the CF data model.
The field construct is central to the CF data model, and includes @@ -157,7 +157,7 @@
dict, optionalSet descriptive properties. The dictionary keys are +
dict, optionalSet 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 @@ -173,7 +173,7 @@
source.copy().
bool, optionalIf True (the default) deep copy input parameters prior +
bool, optionalIf True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
cfdm.core.FieldAncillary(properties=None, data=None, source=None, copy=True, _use_data=True)[source]¶cfdm.core.FieldAncillary(properties=None, data=None, source=None, copy=True, _use_data=True)[source]¶
Bases: cfdm.core.abstract.propertiesdata.PropertiesData
A field ancillary construct of the CF data model.
The field ancillary construct provides metadata which are @@ -153,7 +153,7 @@
dict, optionalSet descriptive properties. The dictionary keys are +
dict, optionalSet 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 @@ -177,7 +177,7 @@
source.copy().
bool, optionalIf True (the default) deep copy input parameters prior +
bool, optionalIf True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
cfdm.core.InteriorRing(properties=None, data=None, source=None, copy=True, _use_data=True)[source]¶cfdm.core.InteriorRing(properties=None, data=None, source=None, copy=True, _use_data=True)[source]¶
Bases: cfdm.core.abstract.propertiesdata.PropertiesData
An interior ring array with properties.
If a cell is composed of multiple polygon parts, an individual @@ -149,7 +149,7 @@
dict, optionalSet descriptive properties. The dictionary keys are +
dict, optionalSet 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 @@ -173,7 +173,7 @@
source.copy().
bool, optionalIf True (the default) deep copy input parameters prior +
bool, optionalIf True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
cfdm.core.Parameters(parameters=None, source=None, copy=True)[source]¶cfdm.core.Parameters(parameters=None, source=None, copy=True)[source]¶
Bases: cfdm.core.abstract.container.Container
Mixin class for a collection of named parameters.
dict, optionalSet parameters. The dictionary keys are parameter +
dict, optionalSet parameters. The dictionary keys are parameter names, with corresponding values. Ignored if the source parameter is set.
Parameters may also be set after initialisation with @@ -151,7 +151,7 @@
source.copy().
bool, optionalIf True (the default) deep copy input parameters prior +
bool, optionalIf True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
cfdm.core.ParametersDomainAncillaries(parameters=None, domain_ancillaries=None, source=None, copy=True)[source]¶cfdm.core.ParametersDomainAncillaries(parameters=None, domain_ancillaries=None, source=None, copy=True)[source]¶
Bases: cfdm.core.abstract.parameters.Parameters
Mixin to collect named parameters and domain ancillaries.
dict, optionalSet parameters. The dictionary keys are term names, +
dict, optionalSet parameters. The dictionary keys are term names, with corresponding parameter values. Ignored if the source parameter is set.
Parameters may also be set after initialisation with @@ -146,7 +146,7 @@
dict, optionalSet references to domain ancillary constructs. The +
dict, optionalSet references to domain ancillary constructs. The dictionary keys are term names, with corresponding domain ancillary construct keys. Ignored if the source parameter is set.
@@ -164,7 +164,7 @@source.copy().
bool, optionalIf True (the default) deep copy input parameters prior +
bool, optionalIf True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
cfdm.core.Properties(properties=None, source=None, copy=True)[source]¶cfdm.core.Properties(properties=None, source=None, copy=True)[source]¶
Bases: cfdm.core.abstract.container.Container
Mixin class for an object with descriptive properties.
dict, optionalSet descriptive properties. The dictionary keys are +
dict, optionalSet 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 @@ -151,7 +151,7 @@
source.copy().
bool, optionalIf True (the default) deep copy input parameters prior +
bool, optionalIf True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
cfdm.core.PropertiesData(properties=None, data=None, source=None, copy=True, _use_data=True)[source]¶cfdm.core.PropertiesData(properties=None, data=None, source=None, copy=True, _use_data=True)[source]¶
Bases: cfdm.core.abstract.properties.Properties
Mixin class for a data array with descriptive properties.
dict, optionalSet descriptive properties. The dictionary keys are +
dict, optionalSet 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 @@ -160,7 +160,7 @@
source.copy().
bool, optionalIf True (the default) deep copy input parameters prior +
bool, optionalIf True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
cfdm.core.PropertiesDataBounds(properties=None, data=None, bounds=None, geometry=None, interior_ring=None, source=None, copy=True, _use_data=True)[source]¶cfdm.core.PropertiesDataBounds(properties=None, data=None, bounds=None, geometry=None, interior_ring=None, source=None, copy=True, _use_data=True)[source]¶
Bases: cfdm.core.abstract.propertiesdata.PropertiesData
Mixin for a data array with bounds and descriptive properties.
dict, optionalSet descriptive properties. The dictionary keys are +
dict, optionalSet 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 @@ -160,7 +160,7 @@
set_bounds method.
str, optionalSet the geometry type. Ignored if the source +
str, optionalSet the geometry type. Ignored if the source parameter is set.
The geometry type may also be set after initialisation
with the set_geometry method.
source.copy().
bool, optionalIf True (the default) deep copy input parameters prior +
bool, optionalIf True (the default) deep copy input parameters prior to initialisation. If False arguments are not deep copied.
Called by the copy.deepcopy function.
Called by the copy.deepcopy function.
Version 1.10.0.0 for version 1.10 of the CF conventions.
+Version 1.10.0.1 for version 1.10 of the CF conventions.