diff --git a/docs/Changelog.html b/docs/Changelog.html index b42602edaa..a5cf8920eb 100644 --- a/docs/Changelog.html +++ b/docs/Changelog.html @@ -697,7 +697,7 @@
A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +Array.
get_filename
(default=AttributeError())[source]¶The name of the file containing the array.
+If there are multiple files then an AttributeError
is
+raised by default.
New in version (cfdm): 1.10.0.2
+A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +AuxiliaryCoordinate.
get_original_filenames
()[source]¶The names of files containing the original data and metadata.
+The original files are those that contain some or all of the
+data and metadata when it was first instantiated, and are
+necessary (but perhaps not sufficient) to recreate the
+AuxiliaryCoordinate
should the need arise. The cfdm.read
+function automatically records the original file names on all
+data that it creates.
The original files of any constituent components are also +included.
+In-place changes to the AuxiliaryCoordinate
will not generally change
+the collection of original files. However if the AuxiliaryCoordinate
+was produced by combining other objects that also store their
+original file names, then the returned files will be the
+collection of original files from all contributing sources.
New in version (cfdm): 1.10.0.1
+A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +Bounds.
get_original_filenames
()[source]¶The names of files containing the original data and metadata.
+The original files are those that contain some or all of the
+data and metadata when it was first instantiated, and are
+necessary (but perhaps not sufficient) to recreate the
+Bounds
should the need arise. The cfdm.read
+function automatically records the original file names on all
+data that it creates.
The original files of any constituent components are also +included.
+In-place changes to the Bounds
will not generally change
+the collection of original files. However if the Bounds
+was produced by combining other objects that also store their
+original file names, then the returned files will be the
+collection of original files from all contributing sources.
New in version (cfdm): 1.10.0.1
+A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +CellMeasure.
get_original_filenames
()[source]¶The names of files containing the original data and metadata.
+The original files are those that contain some or all of the
+data and metadata when it was first instantiated, and are
+necessary (but perhaps not sufficient) to recreate the
+CellMeasure
should the need arise. The cfdm.read
+function automatically records the original file names on all
+data that it creates.
The original files of any constituent components are also +included.
+In-place changes to the CellMeasure
will not generally change
+the collection of original files. However if the CellMeasure
+was produced by combining other objects that also store their
+original file names, then the returned files will be the
+collection of original files from all contributing sources.
New in version (cfdm): 1.10.0.1
+A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +CompressedArray.
get_filename
(default=AttributeError())[source]¶The name of the file containing the array.
+If there are multiple files then an AttributeError
is
+raised by default.
New in version (cfdm): 1.10.0.2
+A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +CoordinateReference.
get_original_filenames
()[source]¶The names of files containing the original data and metadata.
+The original files are those that contain some or all of the
+data and metadata when it was first instantiated, and are
+necessary (but perhaps not sufficient) to recreate the
+CoordinateReference
should the need arise. The cfdm.read
+function automatically records the original file names on all
+data that it creates.
The original files of any constituent components are also +included.
+In-place changes to the CoordinateReference
will not generally change
+the collection of original files. However if the CoordinateReference
+was produced by combining other objects that also store their
+original file names, then the returned files will be the
+collection of original files from all contributing sources.
New in version (cfdm): 1.10.0.1
+A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +Count.
get_original_filenames
()[source]¶The names of files containing the original data and metadata.
+The original files are those that contain some or all of the
+data and metadata when it was first instantiated, and are
+necessary (but perhaps not sufficient) to recreate the
+Count
should the need arise. The cfdm.read
+function automatically records the original file names on all
+data that it creates.
The original files of any constituent components are also +included.
+In-place changes to the Count
will not generally change
+the collection of original files. However if the Count
+was produced by combining other objects that also store their
+original file names, then the returned files will be the
+collection of original files from all contributing sources.
New in version (cfdm): 1.10.0.1
+A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +Data.
get_dependent_tie_points
(default=ValueError())[source]¶Return the list variable for a compressed array.
+New in version (cfdm): 1.10.0.1
+See also
+get_tie_point_indices
,
+get_interpolation_parameters
, get_index
,
+get_list
Return the value of the default parameter if no
+dependent tie point index variables have been set. If
+set to an Exception
instance then it will be raised
+instead.
Examples
+>>> l = d.get_dependent_tie_points()
+
A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +Data.
get_interpolation_parameters
(default=ValueError())[source]¶Return the list variable for a compressed array.
+New in version (cfdm): 1.10.0.1
+See also
+get_dependent_tie_points
,
+get_tie_point_indices
, get_index
,
+get_list
Return the value of the default parameter if no
+interpolation parameters have been set. If set to an
+Exception
instance then it will be raised instead.
dict
Interpolation parameters required by the subsampling
+interpolation method. Each key is an interpolation
+parameter term name, whose value is an
+InterpolationParameter
variable.
Interpolation parameter term names for the +standardised interpolation methods are defined in CF +Appendix J “Coordinate Interpolation Methods”.
+Examples
+>>> l = d.get_interpolation_parameters()
+
A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +Data.
get_original_filenames
()[source]¶The names of files containing the original data and metadata.
+The original files are those that contain some or all of the
+data and metadata when it was first instantiated, and are
+necessary (but perhaps not sufficient) to recreate the
+Data
should the need arise. The cfdm.read
+function automatically records the original file names on all
+data that it creates.
The original files of any constituent components are also +included.
+In-place changes to the Data
will not generally change
+the collection of original files. However if the Data
+was produced by combining other objects that also store their
+original file names, then the returned files will be the
+collection of original files from all contributing sources.
New in version (cfdm): 1.10.0.1
+A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +Data.
get_tie_point_indices
(default=ValueError())[source]¶Return the list variable for a compressed array.
+New in version (cfdm): 1.10.0.1
+See also
+get_dependent_tie_points
,
+get_interpolation_parameters
,
+get_index
, get_list
Return the value of the default parameter if no tie
+point index variables have been set. If set to an
+Exception
instance then it will be raised instead.
dict
The tie point index variable for each subsampled
+dimension. A key identifies a subsampled dimension by
+its integer position in the compressed array, and its
+value is a TiePointIndex
variable.
Examples
+>>> l = d.get_tie_point_indices()
+
A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +Datum.
get_original_filenames
()[source]¶The names of files containing the original data and metadata.
+The original files are those that contain some or all of the
+data and metadata when it was first instantiated, and are
+necessary (but perhaps not sufficient) to recreate the
+Datum
should the need arise. The cfdm.read
+function automatically records the original file names on all
+data that it creates.
The original files of any constituent components are also +included.
+In-place changes to the Datum
will not generally change
+the collection of original files. However if the Datum
+was produced by combining other objects that also store their
+original file names, then the returned files will be the
+collection of original files from all contributing sources.
New in version (cfdm): 1.10.0.1
+A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +DimensionCoordinate.
get_original_filenames
()[source]¶The names of files containing the original data and metadata.
+The original files are those that contain some or all of the
+data and metadata when it was first instantiated, and are
+necessary (but perhaps not sufficient) to recreate the
+DimensionCoordinate
should the need arise. The cfdm.read
+function automatically records the original file names on all
+data that it creates.
The original files of any constituent components are also +included.
+In-place changes to the DimensionCoordinate
will not generally change
+the collection of original files. However if the DimensionCoordinate
+was produced by combining other objects that also store their
+original file names, then the returned files will be the
+collection of original files from all contributing sources.
New in version (cfdm): 1.10.0.1
+A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +Domain.
get_original_filenames
()[source]¶The names of files containing the original data and metadata.
+The original files are those that contain some or all of the
+data and metadata when it was first instantiated, and are
+necessary (but perhaps not sufficient) to recreate the
+Domain
should the need arise. The cfdm.read
+function automatically records the original file names on all
+data that it creates.
The original files of any constituent components are also +included.
+In-place changes to the Domain
will not generally change
+the collection of original files. However if the Domain
+was produced by combining other objects that also store their
+original file names, then the returned files will be the
+collection of original files from all contributing sources.
New in version (cfdm): 1.10.0.1
+A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +DomainAncillary.
get_original_filenames
()[source]¶The names of files containing the original data and metadata.
+The original files are those that contain some or all of the
+data and metadata when it was first instantiated, and are
+necessary (but perhaps not sufficient) to recreate the
+DomainAncillary
should the need arise. The cfdm.read
+function automatically records the original file names on all
+data that it creates.
The original files of any constituent components are also +included.
+In-place changes to the DomainAncillary
will not generally change
+the collection of original files. However if the DomainAncillary
+was produced by combining other objects that also store their
+original file names, then the returned files will be the
+collection of original files from all contributing sources.
New in version (cfdm): 1.10.0.1
+A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +Field.
get_original_filenames
()[source]¶The names of files containing the original data and metadata.
+The original files are those that contain some or all of the
+data and metadata when it was first instantiated, and are
+necessary (but perhaps not sufficient) to recreate the
+Field
should the need arise. The cfdm.read
+function automatically records the original file names on all
+data that it creates.
The original files of any constituent components are also +included.
+In-place changes to the Field
will not generally change
+the collection of original files. However if the Field
+was produced by combining other objects that also store their
+original file names, then the returned files will be the
+collection of original files from all contributing sources.
New in version (cfdm): 1.10.0.1
+A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +FieldAncillary.
get_original_filenames
()[source]¶The names of files containing the original data and metadata.
+The original files are those that contain some or all of the
+data and metadata when it was first instantiated, and are
+necessary (but perhaps not sufficient) to recreate the
+FieldAncillary
should the need arise. The cfdm.read
+function automatically records the original file names on all
+data that it creates.
The original files of any constituent components are also +included.
+In-place changes to the FieldAncillary
will not generally change
+the collection of original files. However if the FieldAncillary
+was produced by combining other objects that also store their
+original file names, then the returned files will be the
+collection of original files from all contributing sources.
New in version (cfdm): 1.10.0.1
+A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +GatheredArray.
get_filename
(default=AttributeError())[source]¶The name of the file containing the array.
+If there are multiple files then an AttributeError
is
+raised by default.
New in version (cfdm): 1.10.0.2
+A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +Index.
get_original_filenames
()[source]¶The names of files containing the original data and metadata.
+The original files are those that contain some or all of the
+data and metadata when it was first instantiated, and are
+necessary (but perhaps not sufficient) to recreate the
+Index
should the need arise. The cfdm.read
+function automatically records the original file names on all
+data that it creates.
The original files of any constituent components are also +included.
+In-place changes to the Index
will not generally change
+the collection of original files. However if the Index
+was produced by combining other objects that also store their
+original file names, then the returned files will be the
+collection of original files from all contributing sources.
New in version (cfdm): 1.10.0.1
+A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +InteriorRing.
get_original_filenames
()[source]¶The names of files containing the original data and metadata.
+The original files are those that contain some or all of the
+data and metadata when it was first instantiated, and are
+necessary (but perhaps not sufficient) to recreate the
+InteriorRing
should the need arise. The cfdm.read
+function automatically records the original file names on all
+data that it creates.
The original files of any constituent components are also +included.
+In-place changes to the InteriorRing
will not generally change
+the collection of original files. However if the InteriorRing
+was produced by combining other objects that also store their
+original file names, then the returned files will be the
+collection of original files from all contributing sources.
New in version (cfdm): 1.10.0.1
+A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +List.
get_original_filenames
()[source]¶The names of files containing the original data and metadata.
+The original files are those that contain some or all of the
+data and metadata when it was first instantiated, and are
+necessary (but perhaps not sufficient) to recreate the
+List
should the need arise. The cfdm.read
+function automatically records the original file names on all
+data that it creates.
The original files of any constituent components are also +included.
+In-place changes to the List
will not generally change
+the collection of original files. However if the List
+was produced by combining other objects that also store their
+original file names, then the returned files will be the
+collection of original files from all contributing sources.
New in version (cfdm): 1.10.0.1
+A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +NumpyArray.
get_filename
(default=AttributeError())[source]¶The name of the file containing the array.
+If there are multiple files then an AttributeError
is
+raised by default.
New in version (cfdm): 1.10.0.2
+A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +RaggedContiguousArray.
get_filename
(default=AttributeError())[source]¶The name of the file containing the array.
+If there are multiple files then an AttributeError
is
+raised by default.
New in version (cfdm): 1.10.0.2
+A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +RaggedIndexedArray.
get_filename
(default=AttributeError())[source]¶The name of the file containing the array.
+If there are multiple files then an AttributeError
is
+raised by default.
New in version (cfdm): 1.10.0.2
+A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +RaggedIndexedContiguousArray.
get_filename
(default=AttributeError())[source]¶The name of the file containing the array.
+If there are multiple files then an AttributeError
is
+raised by default.
New in version (cfdm): 1.10.0.2
+A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +A Python reference implementation of the CF data model
+ + + + ++ +
+ + + + + + +