add check_converters & updates

Author: TomDonoghue

specparam/convert/definitions.py

@@ -11,6 +11,30 @@
     'periodic' : {'cf' : None, 'pw' : 'log_sub', 'bw' : 'full_width'},
 }
 
+###################################################################################################
+## APERIODIC PARAMETER CONVERTERS
+
+# Null converter for aperiodic parameters
+ap_null = AperiodicParamConverter(
+    parameter=None,
+    name='ap_null',
+    description='Null converter for aperiodic converter - return fit param.',
+    function=lambda param, model : \
+        model.results.params.aperiodic._fit[model.modes.aperiodic.params.indices[param]]
+)
+
+###################################################################################################
+## PERIODIC PARAMETER CONVERTERS
+
+# Null converter for periodic parameters
+pe_null = PeriodicParamConverter(
+    parameter=None,
+    name='pe_null',
+    description='Null converter for aperiodic converter - return fit param.',
+    function=lambda param, model, peak_ind : \
+        model.results.params.periodic._fit[peak_ind, model.modes.periodic.params.indices[param]]
+)
+
 ###################################################################################################
 ## PRE-DEFINED CONVERTERS
 
@@ -86,30 +110,16 @@
 }
 
 ###################################################################################################
-## NULL CONVERTERS: extract the fit parameter, with no conversion applied
+## COLLECT ALL CONVERTERS
 
+# Null converters: extract the fit parameter, with no conversion applied
 NULL_CONVERTERS = {
-
-    'aperiodic' : AperiodicParamConverter(
-        parameter=None,
-        name='ap_null',
-        description='Null converter for aperiodic converter - return fit param',
-        function=lambda param, model : \
-            model.results.params.aperiodic._fit[model.modes.aperiodic.params.indices[param]]
-    ),
-
-    'periodic' : PeriodicParamConverter(
-        parameter=None,
-        name='pe_null',
-        description='Null converter for aperiodic converter - return fit param',
-        function=lambda param, model, peak_ind : \
-            model.results.params.periodic._fit[peak_ind, model.modes.periodic.params.indices[param]]
-    )
-
+    'aperiodic' : ap_null,
+    'periodic' : pe_null,
 }
 
 ###################################################################################################
-## SELECTOR
+## SELECTOR & CHECKER FUNCTIONS
 
 def get_converter(component, parameter, converter):
     """Get a specified parameter converter function.
@@ -146,3 +156,19 @@ def get_converter(component, parameter, converter):
         converter = NULL_CONVERTERS[component]
 
     return converter
+
+
+def check_converters(component):
+    """Check the set of parameter converters that are available.
+
+    Parameters
+    ----------
+    component : {'aperiodic', 'periodic'}
+        Which component to check available parameter converters for.
+    """
+
+    print('Available {:s} converters:'.format(component))
+    for param, convs in CONVERTERS[component].items():
+        print(param)
+        for label, converter in convs.items():
+            print('    {:10s}    {:s}'.format(converter.name, converter.description))

specparam/modes/definitions.py

@@ -166,6 +166,8 @@
     'periodic' : PE_MODES,
 }
 
+###################################################################################################
+## CHECKER FUNCTION
 
 def check_modes(component, check_params=False):
     """Check the set of modes that are available.

specparam/tests/convert/test_converter.py

@@ -15,11 +15,13 @@ def test_aperiodic_param_converter():
     apconv = AperiodicParamConverter('tparameter', 'tname', 'tdescription',
                                      lambda param, model : param)
     assert apconv
+    assert apconv.component == 'aperiodic'
     assert apconv(1, None) == 1
 
 def test_periodic_param_converter():
 
     peconv = PeriodicParamConverter('tparameter', 'tname', 'tdescription',
                                     lambda param, model, peak_ind : param)
     assert peconv
+    assert peconv.component == 'periodic'
     assert peconv(1, None, None) == 1

specparam/tests/convert/test_definitions.py

@@ -17,3 +17,8 @@ def test_converters_library():
                 assert converter.component == component
                 assert converter.name == label
                 assert callable(converter.function)
+
+def test_check_converters():
+
+    check_converters('aperiodic')
+    check_converters('periodic')