EnginX.py

# Mantid Repository : https://github.com/mantidproject/mantid
#
# Copyright © 2019 ISIS Rutherford Appleton Laboratory UKRI,
#     NScD Oak Ridge National Laboratory, European Spallation Source
#     & Institut Laue - Langevin
# SPDX - License - Identifier: GPL - 3.0 +
from __future__ import (absolute_import, division, print_function)
import Engineering.EngineeringCalibration as Cal
import Engineering.EngineeringFocus as Focus
import Engineering.EngineeringPreProcess as PreProcess
import os


class EnginX:
    def __init__(self, **kwargs):
        if kwargs:
            self.user = kwargs.get("user")
            self.van_run = kwargs.get("vanadium_run")
            if "output_directory" in kwargs:

                self.calibration_directory = os.path.join(kwargs.get("output_directory"), "User", self.user,
                                                          "Calibration")
                self.calibration_general = os.path.join(kwargs.get("output_directory"), "Calibration")
                self.focus_directory = os.path.join(kwargs.get("output_directory"), "User", self.user, "Focus")
                self.focus_general = os.path.join(kwargs.get("output_directory"), "Focus")
            else:
                root = os.path.abspath(os.sep)
                if root == "/":
                    self.calibration_directory = os.path.expanduser("~/EnginX_Mantid/User/"+self.user+"/Calibration")
                    self.calibration_general = os.path.expanduser("~/EnginX_Mantid/Calibration")
                    self.focus_directory = os.path.expanduser("~/EnginX_Mantid/User/"+self.user+"/Focus")
                    self.focus_general = os.path.expanduser("~/EnginX_Mantid/Focus")
                else:
                    self.calibration_directory = os.path.join(root, "EnginX_Mantid", "User", self.user, "Calibration")
                    self.calibration_general = os.path.join(root, "EnginX_Mantid", "Calibration")
                    self.focus_directory = os.path.join(root, "EnginX_Mantid", "User", self.user, "Focus")
                    self.focus_general = os.path.join(root, "EnginX_Mantid", "Focus")

    def create_vanadium(self):
        van_file = _gen_filename(self.van_run)
        van_curves_file, van_int_file = self._get_van_names()
        Cal.create_vanadium_workspaces(van_file, van_curves_file, van_int_file)

    def create_calibration(self, **kwargs):
        van_curves_file, van_int_file = self._get_van_names()
        if "ceria_run" in kwargs:
            ceria_run = kwargs.get("ceria_run")
        else:
            ceria_run = "241391"
        if "cropped" in kwargs:
            if kwargs.get("cropped") == "banks":
                Cal.create_calibration_cropped_file(False, kwargs.get("bank"), kwargs.get("crop_name"),
                                                    van_curves_file, van_int_file, ceria_run, self.calibration_directory
                                                    , self.van_run, self.calibration_general)
            elif kwargs.get("cropped") == "spectra":
                Cal.create_calibration_cropped_file(True, kwargs.get("spectra"), kwargs.get("crop_name"),
                                                    van_curves_file, van_int_file, ceria_run, self.calibration_directory
                                                    , self.van_run, self.calibration_general)
        else:
            Cal.create_calibration_files(van_curves_file, van_int_file, ceria_run, self.calibration_directory,
                                         self.van_run, self.calibration_general)

    def focus(self, **kwargs):
        if "run_number" in kwargs:
            run_no = kwargs.get("run_number")
        else:
            raise KeyError("Cannot focus without run_number")
        van_curves_file, van_int_file = self._get_van_names()
        if "grouping_file" in kwargs:
            grouping_file = os.path.join(self.calibration_directory, kwargs.get("grouping_file"))
            Focus.focus_texture_mode(van_curves_file, van_int_file, run_no,
                                     self.focus_directory, grouping_file, self.focus_general)
        elif "cropped" in kwargs:
            if kwargs.get("cropped") == "banks":
                Focus.focus_cropped(False, kwargs.get("bank"), van_curves_file, van_int_file, run_no,
                                    self.focus_directory, self.focus_general)
            elif kwargs.get("cropped") == "spectra":
                Focus.focus_cropped(True, kwargs.get("spectra"), van_curves_file, van_int_file, run_no,
                                    self.focus_directory, self.focus_general)
        else:
            Focus.focus_whole(van_curves_file, van_int_file, run_no,
                              self.focus_directory, self.focus_general)

    def pre_process(self, **kwargs):
        run = kwargs.get("run")
        params = kwargs.get("time_bin")
        if "time_period" in kwargs:
            PreProcess.rebin_pulse(run, params, kwargs.get("time_period"))
        else:
            PreProcess.rebin_time(run, params)

    def _get_van_names(self):
        van_file = _gen_filename(self.van_run)
        van_out = os.path.join(self.calibration_directory, van_file)
        van_int_file = van_out + "_precalculated_vanadium_run_integration.nxs"
        van_curves_file = van_out + "_precalculated_vanadium_run_bank_curves.nxs"
        return van_curves_file, van_int_file


def _gen_filename(run_number):
    return "ENGINX" + ("0" * (8 - len(run_number))) + run_number