diff --git a/scripts/Diffraction/isis_powder/__init__.py b/scripts/Diffraction/isis_powder/__init__.py
index dd21b7db222d59a6c5c07444c019be57732350d9..36a0e1a7878aecb44ad5fc93618b8c6c8debf47c 100644
--- a/scripts/Diffraction/isis_powder/__init__.py
+++ b/scripts/Diffraction/isis_powder/__init__.py
@@ -3,9 +3,9 @@ from __future__ import (absolute_import, division, print_function)
# Disable unused import warnings. The import is for user convenience
# Bring instruments into package namespace
from .gem import Gem # noqa: F401
-from .hrpd import HRPD # noqa: F401
-from .pearl import Pearl # noqa: F401
-from .polaris import Polaris # noqa: F401
+#from .hrpd import HRPD # noqa: F401
+#from .pearl import Pearl # noqa: F401
+#from .polaris import Polaris # noqa: F401
# Other useful classes
from .routines.sample_details import SampleDetails # noqa: F401
diff --git a/scripts/Diffraction/isis_powder/gem_routines/gem_algs.py b/scripts/Diffraction/isis_powder/gem_routines/gem_algs.py
index 56f5b5c31c8b5384b26c15c9b5ca24d4a1dd701c..fb8b54116bee2d8e357ac22894f606691a8edd1b 100644
--- a/scripts/Diffraction/isis_powder/gem_routines/gem_algs.py
+++ b/scripts/Diffraction/isis_powder/gem_routines/gem_algs.py
@@ -3,8 +3,7 @@ from __future__ import (absolute_import, division, print_function)
import mantid.simpleapi as mantid
from isis_powder.routines import absorb_corrections, common
-from isis_powder.routines.run_details import create_run_details_object, \
- RunDetailsWrappedCommonFuncs, CustomFuncForRunDetails
+from isis_powder.routines.run_details import create_run_details_object, get_cal_mapping_dict
from isis_powder.gem_routines import gem_advanced_config
@@ -20,29 +19,28 @@ def calculate_van_absorb_corrections(ws_to_correct, multiple_scattering, is_vana
return ws_to_correct
-def gem_get_chopper_config(forwarded_value, inst_settings):
- # Forwarded value should be a cal mapping
- cal_mapping = forwarded_value
- return common.cal_map_dictionary_key_helper(cal_mapping, inst_settings.mode)
-
-
def get_run_details(run_number_string, inst_settings, is_vanadium_run):
- cal_mapping_callable = CustomFuncForRunDetails().add_to_func_chain(
- user_function=RunDetailsWrappedCommonFuncs.get_cal_mapping_dict, run_number_string=run_number_string,
- inst_settings=inst_settings
- ).add_to_func_chain(user_function=gem_get_chopper_config, inst_settings=inst_settings)
-
# Get empty and vanadium
- err_message = "this must be under the relevant Rietveld or PDF mode."
- empty_run_callable = cal_mapping_callable.add_to_func_chain(
- user_function=RunDetailsWrappedCommonFuncs.cal_dictionary_key_helper, key="empty_run_numbers",
- append_to_error_message=err_message)
+ mode_run_numbers = _get_current_mode_dictionary(run_number_string, inst_settings)
+
+ empty_runs = _get_run_numbers_for_key(current_mode_run_numbers=mode_run_numbers, key="empty_run_numbers")
+ vanadium_runs = _get_run_numbers_for_key(current_mode_run_numbers=mode_run_numbers, key="vanadium_run_numbers")
- vanadium_run_callable = cal_mapping_callable.add_to_func_chain(
- user_function=RunDetailsWrappedCommonFuncs.cal_dictionary_key_helper, key="vanadium_run_numbers",
- append_to_error_message=err_message)
+ grouping_file_name = inst_settings.grouping_file_name
return create_run_details_object(run_number_string=run_number_string, inst_settings=inst_settings,
- is_vanadium_run=is_vanadium_run, empty_run_call=empty_run_callable,
- vanadium_run_call=vanadium_run_callable)
+ is_vanadium_run=is_vanadium_run, empty_run_number=empty_runs,
+ grouping_file_name=grouping_file_name, vanadium_string=vanadium_runs)
+
+
+def _get_run_numbers_for_key(current_mode_run_numbers, key):
+ err_message = "this must be under the relevant Rietveld or PDF mode."
+ return common.cal_map_dictionary_key_helper(current_mode_run_numbers, key=key,
+ append_to_error_message=err_message)
+
+
+def _get_current_mode_dictionary(run_number_string, inst_settings):
+ mapping_dict = get_cal_mapping_dict(run_number_string, inst_settings.cal_mapping_path)
+ # Get the current mode "Rietveld" or "PDF" run numbers
+ return common.cal_map_dictionary_key_helper(mapping_dict, inst_settings.mode)
\ No newline at end of file
diff --git a/scripts/Diffraction/isis_powder/routines/run_details.py b/scripts/Diffraction/isis_powder/routines/run_details.py
index 45079bbe066daa62d69a0e7f5a58f8e683a766ed..f96c8e946c9ce69038f1ed9d5b3870b591dc179c 100644
--- a/scripts/Diffraction/isis_powder/routines/run_details.py
+++ b/scripts/Diffraction/isis_powder/routines/run_details.py
@@ -4,24 +4,24 @@ from isis_powder.routines import common, yaml_parser
import os
-def create_run_details_object(run_number_string, inst_settings, is_vanadium_run, empty_run_call=None,
- grouping_file_name_call=None, vanadium_run_call=None,
- splined_name_list=None, van_abs_file_name=None):
+def create_run_details_object(run_number_string, inst_settings, is_vanadium_run, empty_run_number,
+ grouping_file_name, vanadium_string, splined_name_list=None, van_abs_file_name=None):
"""
Creates and returns a run details object which holds various
properties about the current run.
:param run_number_string: The user string for the current run
:param inst_settings: The current instrument object
:param is_vanadium_run: Boolean of if the current run is a vanadium run
- :param empty_run_call: (Optional) Callable to setup custom empty run number(s) from mapping file
- :param grouping_file_name_call: (Optional) Callable to setup custom grouping file name
- :param vanadium_run_call: (Optional) Callable to setup custom van run number(s) from mapping file
+ :param empty_run_number: Empty run number(s) from mapping file
+ :param grouping_file_name: Filename of the grouping file found in the calibration folder
+ :param vanadium_string: Vanadium run number(s) from mapping file
:param splined_name_list: (Optional) List of unique properties to generate a splined vanadium name from
:param van_abs_file_name: (Optional) The name of the vanadium absorption file
:return: RunDetails object with attributes set to applicable values
"""
- cal_map_dict = RunDetailsWrappedCommonFuncs.get_cal_mapping_dict(
- run_number_string=run_number_string, inst_settings=inst_settings)
+ cal_map_dict = get_cal_mapping_dict(run_number_string=run_number_string,
+ cal_mapping_path=inst_settings.cal_mapping_path)
+
run_number = common.get_first_run_number(run_number_string=run_number_string)
# Get names of files we will be using
@@ -29,29 +29,18 @@ def create_run_details_object(run_number_string, inst_settings, is_vanadium_run,
label = common.cal_map_dictionary_key_helper(dictionary=cal_map_dict, key="label")
offset_file_name = common.cal_map_dictionary_key_helper(dictionary=cal_map_dict, key="offset_file_name")
- # Always make sure the offset file name is included
- if splined_name_list:
- # Force Python to make a copy so we don't modify original
- new_splined_list = list(splined_name_list)
- new_splined_list.append(os.path.basename(offset_file_name))
- else:
- new_splined_list = [os.path.basename(offset_file_name)]
-
- # These can either be generic or custom so defer to another method
- results_dict = _get_customisable_attributes(
- cal_dict=cal_map_dict, inst_settings=inst_settings, empty_run_call=empty_run_call,
- grouping_name_call=grouping_file_name_call, vanadium_run_call=vanadium_run_call,
- splined_name_list=new_splined_list)
+ # Prepend the properties used for creating a van spline so we can fingerprint the file
+ new_splined_list = [splined_name_list] if splined_name_list else []
+ new_splined_list.append(os.path.basename(offset_file_name))
- vanadium_run_string = results_dict["vanadium_runs"]
+ splined_van_name = common.generate_splined_name(vanadium_string, new_splined_list)
+ unsplined_van_name = common.generate_unsplined_name(vanadium_string, new_splined_list)
if is_vanadium_run:
# The run number should be the vanadium number in this case
- run_number = vanadium_run_string
- output_run_string = vanadium_run_string
- else:
- # Otherwise set it to the user input
- output_run_string = run_number_string
+ run_number = vanadium_string
+
+ output_run_string = vanadium_string if is_vanadium_run else run_number_string
# Get the file extension if set
file_extension = getattr(inst_settings, "file_extension")
@@ -65,124 +54,32 @@ def create_run_details_object(run_number_string, inst_settings, is_vanadium_run,
# Sample empty if there is one as this is instrument specific
sample_empty = getattr(inst_settings, "sample_empty", None)
- # Generate the paths
- grouping_file_path = os.path.join(calibration_dir, results_dict["grouping_file_name"])
-
- # By default, offset file sits in correct label folder, but it can also be given as an absolute path
+ # By default, offset file sits in the calibration folder, but it can also be given as an absolute path
if os.path.exists(offset_file_name):
offset_file_path = offset_file_name
else:
offset_file_path = os.path.join(calibration_dir, label, offset_file_name)
- # splined vanadium is within the correct label folder
- splined_van_path = os.path.join(calibration_dir, label, results_dict["splined_van_name"])
- unsplined_van_path = os.path.join(calibration_dir, label, results_dict["unsplined_van_name"])
+ # Generate the paths
+ grouping_file_path = os.path.join(calibration_dir, grouping_file_name)
+ splined_van_path = os.path.join(calibration_dir, label, splined_van_name)
+ unsplined_van_path = os.path.join(calibration_dir, label, unsplined_van_name)
van_absorb_path = os.path.join(calibration_dir, van_abs_file_name) if van_abs_file_name else None
- return _RunDetails(empty_run_number=results_dict["empty_runs"], file_extension=file_extension,
+ return _RunDetails(empty_run_number=empty_run_number, file_extension=file_extension,
run_number=run_number, output_run_string=output_run_string, label=label,
offset_file_path=offset_file_path, grouping_file_path=grouping_file_path,
- splined_vanadium_path=splined_van_path, vanadium_run_number=vanadium_run_string,
+ splined_vanadium_path=splined_van_path, vanadium_run_number=vanadium_string,
sample_empty=sample_empty, vanadium_abs_path=van_absorb_path,
unsplined_vanadium_path=unsplined_van_path, output_suffix=suffix)
-def _get_customisable_attributes(cal_dict, inst_settings, empty_run_call, grouping_name_call, vanadium_run_call,
- splined_name_list):
- dict_to_return = {}
- if empty_run_call:
- empty_runs = empty_run_call.get_result()
- else:
- empty_runs = common.cal_map_dictionary_key_helper(dictionary=cal_dict, key="empty_run_numbers")
- dict_to_return["empty_runs"] = empty_runs
-
- if vanadium_run_call:
- vanadium_runs = vanadium_run_call.get_result()
- else:
- vanadium_runs = common.cal_map_dictionary_key_helper(dictionary=cal_dict, key="vanadium_run_numbers")
- dict_to_return["vanadium_runs"] = vanadium_runs
-
- if grouping_name_call:
- grouping_name = grouping_name_call.get_result()
- else:
- grouping_name = inst_settings.grouping_file_name
- dict_to_return["grouping_file_name"] = grouping_name
-
- dict_to_return["splined_van_name"] = common.generate_splined_name(vanadium_runs, splined_name_list)
- dict_to_return["unsplined_van_name"] = common.generate_unsplined_name(vanadium_runs, splined_name_list)
-
- return dict_to_return
-
-
-class RunDetailsWrappedCommonFuncs(object):
- """
- Creates a compatible signature when using custom functions when
- constructing RunDetails objects and calls the common methods underneath.
- """
- @staticmethod
- def get_cal_mapping_dict(run_number_string, inst_settings):
- # Get the python dictionary from the YAML mapping
- run_number = common.get_first_run_number(run_number_string=run_number_string)
- cal_mapping_dict = yaml_parser.get_run_dictionary(run_number_string=run_number,
- file_path=inst_settings.cal_mapping_path)
- return cal_mapping_dict
-
- @staticmethod
- def cal_dictionary_key_helper(key, append_to_error_message=None, **kwargs):
- dictionary = kwargs.pop("forwarded_value")
- return common.cal_map_dictionary_key_helper(dictionary=dictionary, key=key,
- append_to_error_message=append_to_error_message)
-
-
-class CustomFuncForRunDetails(object):
- # Holds a callable method, associated args and return value so we can pass it in
- # as a single method
-
- def __init__(self, user_function=None, *args, **func_kwargs):
- if args:
- # If we allow args with position Python gets confused as the forwarded value can be in the first place too
- raise RuntimeError("Cannot use un-named arguments with callable methods")
-
- self.user_function = user_function
- self.function_kwargs = func_kwargs
-
- self._previous_callable = None
- self._returned_value = None
- self._function_is_executed = False
-
- def _exec_func(self):
- forwarded_value = self._previous_callable.get_result() if self._previous_callable else None
-
- if not self.user_function:
- # We maybe are the 0th case just return any values we hold
- return forwarded_value
-
- if forwarded_value:
- self.function_kwargs["forwarded_value"] = forwarded_value
- self._returned_value = self.user_function(**self.function_kwargs)
- else:
- self._returned_value = self.user_function(**self.function_kwargs)
-
- self._function_is_executed = True
-
- def _set_previous_callable(self, previous_callable):
- if not previous_callable:
- return None
- elif not isinstance(previous_callable, CustomFuncForRunDetails):
- raise ValueError("Previous callable is not a CustomFuncForRunDetails type")
-
- self._previous_callable = previous_callable
-
- def add_to_func_chain(self, user_function, *args, **func_kwargs):
- # Construct a new object that will be the next in line
- next_in_chain = CustomFuncForRunDetails(user_function=user_function, *args, **func_kwargs)
- next_in_chain._set_previous_callable(self)
- return next_in_chain
-
- def get_result(self):
- if not self._function_is_executed:
- self._exec_func()
- return self._returned_value
+def get_cal_mapping_dict(run_number_string, cal_mapping_path):
+ # Get the python dictionary from the YAML mapping
+ run_number = common.get_first_run_number(run_number_string=run_number_string)
+ cal_mapping_dict = yaml_parser.get_run_dictionary(run_number_string=run_number,
+ file_path=cal_mapping_path)
+ return cal_mapping_dict
class _RunDetails(object):