Refactor GIFtools parameters to use BASE_PARAMETERS for consistency

gmcga · gmcga · commit 04ec4cfc0dc6 · 2026-06-17T12:13:48.000-04:00
diff --git a/geoh5py/groups/giftools/__init__.py b/geoh5py/groups/giftools/__init__.py
@@ -16,33 +16,3 @@
 #  You should have received a copy of the GNU Lesser General Public License    '
 #  along with geoh5py.  If not, see <https://www.gnu.org/licenses/>.           '
 # ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
-"""
-GIFtools application groups.
-
-How to add support for a new GIFtools group:
------
-
-1. Create a GIFtools group in Geoscience ANALYST (the outer GIFtools group, and the inner group you
-    would like to add support for within that)
-
-2. Copy its parameters using (from the actual "GIFtools" group, not the inner one) into
-   a module-level ``<NAME>_PARAMETERS`` dict.  For example, if you want to add support for the group
-   named "maginv3d_60", copy from the parameters of the object with the named "GIFtools" and not the
-   object with the name "maginv3d_60".
-
-   Keep the form exactly as ANALYST writes it. Object selectors such as ``mesh``
-   rely on the rich form (notably ``meshType``) to bind and auto-select the stored entity.
-
-3. Reset instance-specific fields (``uuid``, ``working_directory`` and the object
-   ``value`` entries) to empty.
-
-4. Subclass :obj:`~geoh5py.groups.giftools.base.BaseGIFtoolsGroup` and set
-   ``_TYPE_UID``, ``_default_name`` and ``_default_parameters``.
-
-5. Export the class from :mod:`geoh5py.groups` so it is registered for
-   read/write.
-
-6. Add the class to ``tests/groups/giftools_test.py`` with the mesh type it
-   expects (octree groups -> :obj:`~geoh5py.objects.Octree`; tensor-mesh groups
-   -> :obj:`~geoh5py.objects.BlockModel`, etc.).
-"""
diff --git a/geoh5py/groups/giftools/magnetics_inversion.py b/geoh5py/groups/giftools/magnetics_inversion.py
@@ -23,13 +23,13 @@
 from uuid import UUID
 
 from geoh5py.groups.giftools.base import BaseGIFtoolsGroup
+from geoh5py.groups.giftools.parameters import BASE_PARAMETERS, merge_field
 
 
 # Default parameters for the maginv3d_60 inversion group.
 # Note -- as we add support for more GIFtools groups, these may be able to be restructured to avoid
 # some redundancy between groups.
 
-# pylint: disable=duplicate-code
 MAGINV3D_PARAMETERS: dict[str, Any] = {
     "Lp_model": {
         "association": "Cell",
@@ -79,19 +79,7 @@
         "property": "",
         "value": 2,
     },
-    "active_model": {
-        "association": "Cell",
-        "dataType": ["Integer", "Boolean"],
-        "default": "",
-        "enabled": False,
-        "group": "Model parameters",
-        "label": "Active model",
-        "main": False,
-        "optional": True,
-        "parent": "mesh",
-        "suffix": ".act",
-        "value": "",
-    },
+    "active_model": merge_field(BASE_PARAMETERS["active_model"], main=False),
     "auto_threshold": {
         "choiceList": ["Relative error", "Specify value"],
         "default": "Relative error",
@@ -125,19 +113,7 @@
         "property": "",
         "value": 10,
     },
-    "cell_weight": {
-        "association": "Cell",
-        "dataType": "Float",
-        "default": "",
-        "enabled": False,
-        "group": "Model objective function",
-        "label": "Weights (Ws)",
-        "ndv": 1,
-        "optional": True,
-        "parent": "mesh",
-        "suffix": ".wgt",
-        "value": "",
-    },
+    "cell_weight": BASE_PARAMETERS["cell_weight"],
     "data": {
         "default": "",
         "gifType": ["MAGdata", "MAGAMPdata"],
@@ -177,31 +153,8 @@
         "min": 0,
         "value": 0,
     },
-    "face_weight": {
-        "association": "Face",
-        "dataType": "Float",
-        "default": "",
-        "enabled": False,
-        "group": "Model objective function",
-        "label": "Weights (Wxyz)",
-        "ndv": 1,
-        "optional": True,
-        "parent": "mesh",
-        "suffix": ".wgt",
-        "value": "",
-    },
-    "initial_model": {
-        "association": "Cell",
-        "dataType": "Float",
-        "default": 0.0010000000474974513,
-        "group": "Model parameters",
-        "isValue": True,
-        "label": "Initial model",
-        "main": False,
-        "parent": "mesh",
-        "property": "",
-        "value": 0.0010000000474974513,
-    },
+    "face_weight": BASE_PARAMETERS["face_weight"],
+    "initial_model": BASE_PARAMETERS["initial_model"],
     "inversion_mode": {
         "choiceList": ["Chifactor", "Single beta"],
         "default": "Chifactor",
@@ -288,14 +241,8 @@
         "property": "",
         "value": 0,
     },
-    "results_loaded": False,
-    "smooth_mod": {
-        "default": False,
-        "group": "Model objective function",
-        "label": "Reference model in Wxyz",
-        "tooltip": "Wxyz(m-mref): SMOOTH_MOD_DIF option",
-        "value": False,
-    },
+    "results_loaded": BASE_PARAMETERS["results_loaded"],
+    "smooth_mod": BASE_PARAMETERS["smooth_mod"],
     "threshold": {
         "default": 0.05000000074505806,
         "enabled": True,
@@ -313,7 +260,7 @@
         "optional": True,
         "value": "",
     },
-    "uuid": "",
+    "uuid": BASE_PARAMETERS["uuid"],
     "version": "6",
     "wavelet": {
         "choiceList": [
@@ -343,7 +290,7 @@
         "main": False,
         "value": False,
     },
-    "working_directory": "",
+    "working_directory": BASE_PARAMETERS["working_directory"],
     "xy_localize": {
         "default": False,
         "label": "Localize coordinates",
diff --git a/geoh5py/groups/giftools/octree_base.py b/geoh5py/groups/giftools/octree_base.py
@@ -21,24 +21,15 @@
 
 from typing import Any
 
+from geoh5py.groups.giftools.parameters import BASE_PARAMETERS, merge_field
+
 
 # Parameters shared by the GIFtools octree inversion groups.
 # Note -- this will likely be restructured as we know more about what the commonalities and
 # differences are between different GIFtools/GIFtools octree/GIFtools inversion groups.
-# pylint: disable=duplicate-code
+
 OCTREE_INVERSION_PARAMETERS: dict[str, Any] = {
-    "active_model": {
-        "association": "Cell",
-        "dataType": ["Integer", "Boolean"],
-        "default": "",
-        "enabled": False,
-        "group": "Model parameters",
-        "label": "Active model",
-        "optional": True,
-        "parent": "mesh",
-        "suffix": ".act",
-        "value": "",
-    },
+    "active_model": BASE_PARAMETERS["active_model"],
     "assignConRes": {
         "alternateLabel": "Resistivity",
         "group": "Model parameters",
@@ -75,39 +66,15 @@
         "label": "No bounds",
         "value": True,
     },
-    "cell_weight": {
-        "association": "Cell",
-        "dataType": "Float",
-        "default": "",
-        "enabled": False,
-        "group": "Model objective function",
-        "label": "Weights (Ws)",
-        "ndv": 1,
-        "optional": True,
-        "parent": "mesh",
-        "suffix": ".wgt",
-        "value": "",
-    },
+    "cell_weight": BASE_PARAMETERS["cell_weight"],
     "delta_beta": {
         "default": -1234567,
         "dependency": "beta_given",
         "group": "Inversion parameters",
         "label": "Beta step",
         "value": 0.25,
     },
-    "face_weight": {
-        "association": "Face",
-        "dataType": "Float",
-        "default": "",
-        "enabled": False,
-        "group": "Model objective function",
-        "label": "Weights (Wxyz)",
-        "ndv": 1,
-        "optional": True,
-        "parent": "mesh",
-        "suffix": ".wgt",
-        "value": "",
-    },
+    "face_weight": BASE_PARAMETERS["face_weight"],
     "global_weight": {
         "association": "Cell",
         "dataType": "Float",
@@ -126,20 +93,12 @@
         "label": "Solver tolerance",
         "value": 0.009999999776482582,
     },
-    "initial_model": {
-        "association": "Cell",
-        "dataType": "Float",
-        "default": 0.0010000000474974513,
-        "group": "Model parameters",
-        "isValue": True,
-        "label": "Initial model",
-        "main": False,
-        "max": 100000000,
-        "min": 9.99999993922529e-09,
-        "parent": "mesh",
-        "property": "",
-        "value": 0.0010000000474974513,
-    },
+    # initial_model shares the common base and octree adds max/min bounds.
+    "initial_model": merge_field(
+        BASE_PARAMETERS["initial_model"],
+        max=100000000,
+        min=9.99999993922529e-09,
+    ),
     "inversion_chifact": {
         "default": 1,
         "group": "Inversion parameters",
@@ -231,14 +190,8 @@
         "property": "",
         "value": 0.0010000000474974513,
     },
-    "results_loaded": False,
-    "smooth_mod": {
-        "default": False,
-        "group": "Model objective function",
-        "label": "Reference model in Wxyz",
-        "tooltip": "Wxyz(m-mref): SMOOTH_MOD_DIF option",
-        "value": False,
-    },
+    "results_loaded": BASE_PARAMETERS["results_loaded"],
+    "smooth_mod": BASE_PARAMETERS["smooth_mod"],
     "topography": {
         "association": "Cell",
         "dataType": ["Integer", "Boolean"],
@@ -273,7 +226,7 @@
         "property": "",
         "value": 10,
     },
-    "uuid": "",
+    "uuid": BASE_PARAMETERS["uuid"],
     "version": "",
-    "working_directory": "",
+    "working_directory": BASE_PARAMETERS["working_directory"],
 }
diff --git a/geoh5py/groups/giftools/parameters.py b/geoh5py/groups/giftools/parameters.py
@@ -0,0 +1,102 @@
+# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+#  Copyright (c) 2026 Mira Geoscience Ltd.                                     '
+#                                                                              '
+#  This file is part of geoh5py.                                               '
+#                                                                              '
+#  geoh5py is free software: you can redistribute it and/or modify             '
+#  it under the terms of the GNU Lesser General Public License as published by '
+#  the Free Software Foundation, either version 3 of the License, or           '
+#  (at your option) any later version.                                         '
+#                                                                              '
+#  geoh5py is distributed in the hope that it will be useful,                  '
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of              '
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               '
+#  GNU Lesser General Public License for more details.                         '
+#                                                                              '
+#  You should have received a copy of the GNU Lesser General Public License    '
+#  along with geoh5py.  If not, see <https://www.gnu.org/licenses/>.           '
+# ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
+import copy
+from typing import Any
+
+
+def merge_field(base_field: dict[str, Any], **overrides: Any) -> dict[str, Any]:
+    """
+    Return a deep copy of a :data:`BASE_PARAMETERS` field with ``overrides`` applied.
+
+    Can be used when a group shares a field with the common base, but needs a small
+    difference (an extra key or a changed value). The deep copy ensures the per-group dict
+    never aliases the shared ``BASE_PARAMETERS`` template, so in-place edits
+    cannot leak between groups.
+
+    :param base_field: The shared field taken from :data:`BASE_PARAMETERS`.
+    :param overrides: Keys to add or override on the copied field.
+    :return: A new field dict, safe to embed in a group's parameter dict.
+    """
+    field = copy.deepcopy(base_field)
+    field.update(overrides)
+    return field
+
+
+BASE_PARAMETERS: dict[str, Any] = {
+    "active_model": {
+        "association": "Cell",
+        "dataType": ["Integer", "Boolean"],
+        "default": "",
+        "enabled": False,
+        "group": "Model parameters",
+        "label": "Active model",
+        "optional": True,
+        "parent": "mesh",
+        "suffix": ".act",
+        "value": "",
+    },
+    "cell_weight": {
+        "association": "Cell",
+        "dataType": "Float",
+        "default": "",
+        "enabled": False,
+        "group": "Model objective function",
+        "label": "Weights (Ws)",
+        "ndv": 1,
+        "optional": True,
+        "parent": "mesh",
+        "suffix": ".wgt",
+        "value": "",
+    },
+    "face_weight": {
+        "association": "Face",
+        "dataType": "Float",
+        "default": "",
+        "enabled": False,
+        "group": "Model objective function",
+        "label": "Weights (Wxyz)",
+        "ndv": 1,
+        "optional": True,
+        "parent": "mesh",
+        "suffix": ".wgt",
+        "value": "",
+    },
+    "initial_model": {
+        "association": "Cell",
+        "dataType": "Float",
+        "default": 0.0010000000474974513,
+        "group": "Model parameters",
+        "isValue": True,
+        "label": "Initial model",
+        "main": False,
+        "parent": "mesh",
+        "property": "",
+        "value": 0.0010000000474974513,
+    },
+    "results_loaded": False,
+    "smooth_mod": {
+        "default": False,
+        "group": "Model objective function",
+        "label": "Reference model in Wxyz",
+        "tooltip": "Wxyz(m-mref): SMOOTH_MOD_DIF option",
+        "value": False,
+    },
+    "uuid": "",
+    "working_directory": "",
+}
