Reduction Plan Model

IN PROGRESS

The Reduction Plan is described in Data Dictionary Reduction Plan. Every parameter below is collected during the reduction plan creation, besides ub_matrix that is calculated during the UB Matrix/Peaks Finding step.

The detailed Instrument model is found here Intrument.

        classDiagram
   ReductionPlanModel "1" *--"1" InstrumentInfoModel
   ReductionPlanModel "1" *--"1" CalibrationModel
   ReductionPlanModel "1" *--"1" NormalizationModel

   class ReductionPlanModel{
       -String reduction_plan_id
       +String reduction_plan_name
       +InstrumentInfoModel instrument
       +String experiment
       +Number ipts_experiment_number
       +String run_range
       +List~Number~ wavelength
       +String mask_filepath
       +String background_filepath
       +String grouping
       +Number offset
       +Bool elastic
       +String reduction_plan_filepath
       +String data_source_filepath
       +CalibrationModel calibration
       +NormalizationModel vanadium
       +Mantid:OrientedLattice ub_matrix
       +get()
       +create()
       +edit()
       +delete()
       //(backend validation rules)
       +validate_mask()
       +validate_background()
       +validate_run_ranges()
       +reduction_plan_filepath()
   }

   class InstrumentInfoModel{
       <>
   }


   class CalibrationModel{
       +String detector_filepath
       +String tube_filepath
       +get()
       +create()
       +edit()
       +delete()
       //(backend validation rules)
       +validate_detector()
       +validate_tube()
   }

   class NormalizationModel{
       +String flux_filepath
       +String solid_angle_filepath
       +get()
       +create()
       +edit()
       +delete()
       //(backend validation rules)
       +validate_flux()
       +validate_solid_angle()
   }
    

The above validation functions check the following before the Reduction Plan creation:

• whether the files exist and have the correct extension

• the run range files exist in the instrument/experiment filepath.

• the reduction plan filepath is unique. In case of a new reduction plan with an exisiting filepath warning message is sent to the user to ask whether they want to override the existing one.

There are parameters available to specific instruments for the reducton plan creation:

• detector_filepath available for SNAP, CORELLI, TOPAZ and MANDI. Not required.

• tube_filepath available only for CORELLI. Not required.

• elastic available only for CORELLI. Required. (True or False)

• offset available only for CORELLI. Not Required.

• ipts_experiment_number available only for DEMAND. Required.

• wavelength (band) 2nd field available only for SNAP, CORELLI, TOPAZ, MANDI. Required.

The reduction_plan_id is created and assigned during the Reduction Plan creation. It is a unique identifier that is passed along with the reduction plan name and any other necessary parameters between View and Model.

In case any of the above do not pass, an error message is sent and displayed to the user.

Below is the expected schema for the Reduction Plan saved in a file:

        classDiagram
    class ReductionPlanFile{
        +String Instrument
        +List~Number~ Wavelength
        +Number Experiment
        +Number IPTSExperimentNumber
        +String RunRange
        +String Grouping
        +Number Elastic
        +Bool Offset
        +String UBFile
        +String VanadiumFile
        +String BackgroundFile
        +String FluxFile
        +String MaskFile
        +String DetectorCalibration
        +String TubeCalibration
        +String SolidAngle
    }
    

The datapath of the files are saved in the reduction plan file. The Instrument contains the name of the instrument. When the reduction plan file is loaded in Garnet, the instrument name is used to create the new Instrument (if it does not exist).

Reduction pla file validation rules:

• If the data fields and values are correct, a new reduction plan object is created and its values are send and displayed to the user.

• If the data values are missing or invalid, a reduction plan object is not created. The parameters are sent and displayed to the user to fix them. A corresponding error message is displayed to promt the user to edit the parameters and then save the reduction plan.

• If data keys (fields) are missing, the file is considered corrupted. No parameters are loaded and an error message is sent and displayed to the user.