add & use update_converters

Author: TomDonoghue

specparam/convert/definitions.py

@@ -1,5 +1,7 @@
 """Define parameter converters."""
 
+from copy import deepcopy
+
 from specparam.convert.converter import AperiodicParamConverter, PeriodicParamConverter
 from specparam.convert.params import compute_peak_height
 
@@ -11,6 +13,30 @@
     'periodic' : {'cf' : None, 'pw' : 'log_sub', 'bw' : 'full_width'},
 }
 
+
+def update_converters(defaults, updates):
+    """Update default converters.
+
+    Parameters
+    ----------
+    defaults : dict
+        Default converters.
+    updates : dict
+        Converter definitions to update.
+
+    Returns
+    -------
+    converters : dict
+        Updated converters definition.
+    """
+
+    out = deepcopy(defaults)
+    for component, converters in updates.items():
+        for param, converter in converters.items():
+            out[component][param] = converter
+
+    return out
+
 ###################################################################################################
 ## APERIODIC PARAMETER CONVERTERS
 

specparam/models/model.py

@@ -13,7 +13,7 @@
 from specparam.results.results import Results
 
 from specparam.convert.convert import convert_aperiodic_params, convert_periodic_params
-from specparam.convert.definitions import DEFAULT_CONVERTERS
+from specparam.convert.definitions import update_converters, DEFAULT_CONVERTERS
 
 from specparam.algorithms.spectral_fit import SpectralFitAlgorithm, SPECTRAL_FIT_SETTINGS_DEF
 from specparam.algorithms.definitions import ALGORITHMS, check_algorithm_definition
@@ -91,7 +91,8 @@ def __init__(self, aperiodic_mode='fixed', periodic_mode='gaussian',
                  debug=False, verbose=True, **model_kwargs):
         """Initialize model object."""
 
-        converters = DEFAULT_CONVERTERS if not converters else converters
+        converters = DEFAULT_CONVERTERS if not converters else \
+            update_converters(DEFAULT_CONVERTERS, converters)
         BaseModel.__init__(self, aperiodic_mode, periodic_mode, converters, verbose)
 
         self.data = Data()

specparam/tests/convert/test_definitions.py

@@ -18,6 +18,23 @@ def test_converters_library():
                 assert converter.name == label
                 assert callable(converter.function)
 
+def test_update_converters():
+
+    converters1 = {'aperiodic' : {'exponent' : 'custom'}}
+    out1 = update_converters(DEFAULT_CONVERTERS, converters1)
+    assert out1['periodic'] == DEFAULT_CONVERTERS['periodic']
+    assert out1['aperiodic']['exponent'] == converters1['aperiodic']['exponent']
+
+    converters2 = {'periodic' : {'cf' : 'custom'}}
+    out2 = update_converters(DEFAULT_CONVERTERS, converters2)
+    assert out2['aperiodic'] == DEFAULT_CONVERTERS['aperiodic']
+    assert out2['periodic']['cf'] == converters2['periodic']['cf']
+
+    converters3 = {'aperiodic' : {'knee' : 'custom'}}
+    out3 = update_converters(DEFAULT_CONVERTERS, converters3)
+    assert out3['periodic'] == DEFAULT_CONVERTERS['periodic']
+    assert out3['aperiodic']['knee'] == converters3['aperiodic']['knee']
+
 def test_check_converters():
 
     check_converters('aperiodic')