quantisation

davidhassell · davidhassell · commit 68ac81c82830 · 2025-06-05T10:09:23.000+01:00
diff --git a/cf/quantization.py b/cf/quantization.py
@@ -19,7 +19,7 @@ class Quantization(cfdm.Quantization):
     take the form ``software-name version version-string
     [(optional-information)]``.
 
-    The retained precision of the algorthm is defined with either the
+    The retained precision of the algorithm is defined with either the
     ``quantization_nsb`` or ``quantization_nsd`` parameter.
 
     For instance, the following parameters describe quantization via
diff --git a/docs/source/class/cf.AuxiliaryCoordinate.rst b/docs/source/class/cf.AuxiliaryCoordinate.rst
@@ -342,6 +342,19 @@ Cyclicity
    ~cf.AuxiliaryCoordinate.get_original_filenames
    ~cf.AuxiliaryCoordinate.persist
 
+Quantization
+^^^^^^^^^^^^
+
+.. rubric:: Methods
+
+.. autosummary::
+   :nosignatures:
+   :toctree: ../method/
+   :template: method.rst
+
+   ~cf.AuxiliaryCoordinate.get_quantization
+   ~cf.AuxiliaryCoordinate.get_quantize_on_write
+
 Miscellaneous
 -------------
 
diff --git a/docs/source/class/cf.Bounds.rst b/docs/source/class/cf.Bounds.rst
@@ -239,6 +239,19 @@ Data
    ~cf.Bounds.has_bounds
    ~cf.Bounds.persist
 
+Quantization
+^^^^^^^^^^^^
+
+.. rubric:: Methods
+
+.. autosummary::
+   :nosignatures:
+   :toctree: ../method/
+   :template: method.rst
+
+   ~cf.Bounds.get_quantization
+   ~cf.Bounds.get_quantize_on_write
+
 Miscellaneous
 -------------
 
diff --git a/docs/source/class/cf.CellConnectivity.rst b/docs/source/class/cf.CellConnectivity.rst
@@ -261,6 +261,19 @@ Data
    ~cf.CellConnectivity.has_bounds
    ~cf.CellConnectivity.persist
 
+Quantization
+^^^^^^^^^^^^
+
+.. rubric:: Methods
+
+.. autosummary::
+   :nosignatures:
+   :toctree: ../method/
+   :template: method.rst
+
+   ~cf.CellConnectivity.get_quantization
+   ~cf.CellConnectivity.get_quantize_on_write
+
 Miscellaneous
 -------------
 
diff --git a/docs/source/class/cf.CellMeasure.rst b/docs/source/class/cf.CellMeasure.rst
@@ -262,6 +262,19 @@ Data
    ~cf.CellMeasure.has_bounds
    ~cf.CellMeasure.persist
 
+Quantization
+^^^^^^^^^^^^
+
+.. rubric:: Methods
+
+.. autosummary::
+   :nosignatures:
+   :toctree: ../method/
+   :template: method.rst
+
+   ~cf.CellMeasure.get_quantization
+   ~cf.CellMeasure.get_quantize_on_write
+
 Miscellaneous
 -------------
 
diff --git a/docs/source/class/cf.CoordinateConversion.rst b/docs/source/class/cf.CoordinateConversion.rst
@@ -10,6 +10,18 @@ cf.CoordinateConversion
    :no-members:
    :no-inherited-members:
    
+Inspection
+----------
+
+.. rubric:: Methods
+	    
+.. autosummary::
+   :nosignatures:
+   :toctree: ../method/
+   :template: method.rst
+
+   ~cf.CoordinateConversion.dump
+
 Parameter terms
 ---------------
 
@@ -58,6 +70,7 @@ Miscellaneous
 
    ~cf.CoordinateConversion.copy
    ~cf.CoordinateConversion.equals
+   ~cf.CoordinateConversion.creation_commands
 
 Special
 -------
diff --git a/docs/source/class/cf.Count.rst b/docs/source/class/cf.Count.rst
@@ -233,6 +233,19 @@ Data
    ~cf.Count.has_bounds
    ~cf.Count.persist
 
+Quantization
+^^^^^^^^^^^^
+
+.. rubric:: Methods
+
+.. autosummary::
+   :nosignatures:
+   :toctree: ../method/
+   :template: method.rst
+
+   ~cf.Count.get_quantization
+   ~cf.Count.get_quantize_on_write
+
 Miscellaneous
 -------------
 
diff --git a/docs/source/class/cf.Datum.rst b/docs/source/class/cf.Datum.rst
@@ -10,6 +10,18 @@ cf.Datum
    :no-members:
    :no-inherited-members:
 
+Inspection
+----------
+
+.. rubric:: Methods
+	    
+.. autosummary::
+   :nosignatures:
+   :toctree: ../method/
+   :template: method.rst
+
+   ~cf.Datum.dump
+
 Parameters
 ----------
 
@@ -57,6 +69,7 @@ Miscellaneous
    ~cf.Datum.copy
    ~cf.Datum.get_original_filenames
    ~cf.Datum.equals
+   ~cf.Datum.creation_commands
 
 Groups
 ^^^^^^
diff --git a/docs/source/class/cf.DimensionCoordinate.rst b/docs/source/class/cf.DimensionCoordinate.rst
@@ -349,6 +349,19 @@ Cyclicity
    ~cf.DimensionCoordinate.anchor
    ~cf.DimensionCoordinate.persist
 
+Quantization
+^^^^^^^^^^^^
+
+.. rubric:: Methods
+
+.. autosummary::
+   :nosignatures:
+   :toctree: ../method/
+   :template: method.rst
+
+   ~cf.DimensionCoordinate.get_quantization
+   ~cf.DimensionCoordinate.get_quantize_on_write
+
 Miscellaneous
 -------------
 
diff --git a/docs/source/class/cf.DomainAncillary.rst b/docs/source/class/cf.DomainAncillary.rst
@@ -306,6 +306,19 @@ Data
    ~cf.DomainAncillary.get_original_filenames
    ~cf.DomainAncillary.persist
 
+Quantization
+^^^^^^^^^^^^
+
+.. rubric:: Methods
+
+.. autosummary::
+   :nosignatures:
+   :toctree: ../method/
+   :template: method.rst
+
+   ~cf.DomainAncillary.get_quantization
+   ~cf.DomainAncillary.get_quantize_on_write
+
 Miscellaneous
 -------------
 
diff --git a/docs/source/class/cf.DomainTopology.rst b/docs/source/class/cf.DomainTopology.rst
@@ -262,6 +262,19 @@ Data
    ~cf.DomainTopology.has_bounds
    ~cf.DomainTopology.persist
 
+Quantization
+^^^^^^^^^^^^
+
+.. rubric:: Methods
+
+.. autosummary::
+   :nosignatures:
+   :toctree: ../method/
+   :template: method.rst
+
+   ~cf.DomainTopology.get_quantization
+   ~cf.DomainTopology.get_quantize_on_write
+
 Miscellaneous
 -------------
 
diff --git a/docs/source/class/cf.Field.rst b/docs/source/class/cf.Field.rst
@@ -265,6 +265,23 @@ Miscellaneous data operations
    ~cf.Field.persist
    ~cf.Field.persist_metadata
  
+Quantization
+^^^^^^^^^^^^
+
+.. rubric:: Methods
+
+.. autosummary::
+   :nosignatures:
+   :toctree: ../method/
+   :template: method.rst
+
+   ~cf.Field.get_quantization
+   ~cf.Field._set_quantization
+   ~cf.Field._del_quantization
+   ~cf.Field.get_quantize_on_write
+   ~cf.Field.set_quantize_on_write
+   ~cf.Field.del_quantize_on_write
+
 Metadata constructs
 -------------------
 
diff --git a/docs/source/class/cf.FieldAncillary.rst b/docs/source/class/cf.FieldAncillary.rst
@@ -237,6 +237,23 @@ Data
    ~cf.FieldAncillary.has_bounds
    ~cf.FieldAncillary.persist
 
+Quantization
+^^^^^^^^^^^^
+
+.. rubric:: Methods
+
+.. autosummary::
+   :nosignatures:
+   :toctree: ../method/
+   :template: method.rst
+
+   ~cf.FieldAncillary.get_quantization
+   ~cf.FieldAncillary._set_quantization
+   ~cf.FieldAncillary._del_quantization
+   ~cf.FieldAncillary.get_quantize_on_write
+   ~cf.FieldAncillary.set_quantize_on_write
+   ~cf.FieldAncillary.del_quantize_on_write
+
 Miscellaneous
 -------------
 
diff --git a/docs/source/class/cf.Index.rst b/docs/source/class/cf.Index.rst
@@ -234,6 +234,19 @@ Data
    ~cf.Index.has_bounds
    ~cf.Index.persist
 
+Quantization
+^^^^^^^^^^^^
+
+.. rubric:: Methods
+
+.. autosummary::
+   :nosignatures:
+   :toctree: ../method/
+   :template: method.rst
+
+   ~cf.Index.get_quantization
+   ~cf.Index.get_quantize_on_write
+
 Miscellaneous
 -------------
 
diff --git a/docs/source/class/cf.List.rst b/docs/source/class/cf.List.rst
@@ -234,6 +234,19 @@ Data
    ~cf.List.has_bounds
    ~cf.List.persist
 
+Quantization
+^^^^^^^^^^^^
+
+.. rubric:: Methods
+
+.. autosummary::
+   :nosignatures:
+   :toctree: ../method/
+   :template: method.rst
+
+   ~cf.List.get_quantization
+   ~cf.List.get_quantize_on_write
+
 Miscellaneous
 -------------
 
diff --git a/docs/source/tutorial.rst b/docs/source/tutorial.rst
@@ -6859,7 +6859,7 @@ efficient. Quantization is described by the following parameters:
   source of the algorithm employed. The text must take the form
   ``software-name version version-string [(optional-information)]``.
 
-* The retained precision of the algortqhm is defined with either the
+* The retained precision of the algorithm is defined with either the
   ``quantization_nsb`` or ``quantization_nsd`` parameter.
 
 If quantization has been applied to the data, then it may be described
@@ -6872,17 +6872,21 @@ method:
    :caption: *Lossy compression via quantization.*
 
    >>> q, t = cf.read('file.nc')
-   >>> t.set_quantize_on_write(algorithm='bitgroom', quantization_nsd=6)
+   >>> t.set_quantize_on_write(algorithm='bitgroom', quantization_nsd=1)
    >>> cf.write(t, 'quantized.nc')
    >>> quantized = cf.read('quantized.nc')[0]
    >>> c = quantized.get_quantization()
    >>> c
-   <CF Quantization: _QuantizeBitGroomNumberOfSignificantDigits=6, algorithm=bitgroom, implementation=libnetcdf version 4.9.4-development, quantization_nsd=6>
+   <CF Quantization: _QuantizeBitGroomNumberOfSignificantDigits=1, algorithm=bitgroom, implementation=libnetcdf version 4.9.4-development, quantization_nsd=1>
    >>> c.parameters()
    {'algorithm': 'bitgroom',
     'implementation': 'libnetcdf version 4.9.4-development',
-    '_QuantizeBitGroomNumberOfSignificantDigits': np.int32(6),
-    'quantization_nsd': np.int64(6)}
+    '_QuantizeBitGroomNumberOfSignificantDigits': np.int32(1),
+    'quantization_nsd': np.int64(1)}
+   >>> t[0, 0, 0].array
+   array([[[262.8]]])
+   >>> quantized[0, 0, 0].array
+   array([[[256.]]])
 
 ----
 
