Merge pull request #355 from nrao/354-add-phase-to-beamcut-mds-and-also-a-function-to-plot-it

354 add phase to beamcut mds and also a function to plot it

Author: vsmagalhaes

docs/tutorials/beamcut_tutorial.ipynb

@@ -1,4 +1,5 @@
 import pathlib
+import numpy as np
 
 from toolviper.utils.parameter import validate
 
@@ -10,7 +11,7 @@
 from astrohack.io.dio import open_holog
 from astrohack.utils.validation import custom_plots_checker
 
-from typing import Union, List
+from typing import Union, List, Tuple
 
 
 @validate(custom_checker=custom_plots_checker)
@@ -22,9 +23,11 @@ def beamcut(
     destination: str = None,
     lm_unit: str = "amin",
     azel_unit: str = "deg",
+    phase_unit: str = "deg",
+    phase_scale: Union[List[float], Tuple[float], np.array] = None,
+    y_scale: list[float] = None,
     dpi: int = 300,
     display: bool = False,
-    y_scale: list[float] = None,
     parallel: bool = False,
     overwrite: bool = False,
 ):
@@ -52,6 +55,12 @@ def beamcut(
     :param azel_unit: Unit for Az/El information in plots and report, default is "deg".
     :type azel_unit: str, optional
 
+    :param phase_unit: Unit for phase plots, default is "deg".
+    :type phase_unit: str, optional
+
+    :param phase_scale: Scale for the phase plots, in phase_unit, default is None, meaning 1 full cycle.
+    :type phase_scale: Union[List[float], Tuple[float], np.array], optional
+
     :param dpi: Resolution in pixels, defaults to 300.
     :type dpi: int, optional
 
@@ -152,6 +161,16 @@ def beamcut(
                 dpi=dpi,
                 parallel=parallel,
             )
+            beamcut_mds.plot_beamcut_in_phase(
+                destination,
+                lm_unit=lm_unit,
+                azel_unit=azel_unit,
+                phase_unit=phase_unit,
+                phase_scale=phase_scale,
+                display=display,
+                dpi=dpi,
+                parallel=parallel,
+            )
             beamcut_mds.plot_beam_cuts_over_sky(
                 destination,
                 lm_unit=lm_unit,

src/astrohack/beamcut.py

@@ -38,6 +38,12 @@
             "type": ["string"],
             "check allowed with": "units.trig"
         },
+        "phase_unit":{
+            "nullable": false,
+            "required": false,
+            "type": ["string"],
+            "check allowed with": "units.trig"
+        },
         "dpi":{
             "nullable": false,
             "required": false,
@@ -65,6 +71,21 @@
                 "ndarray"
             ]
         },
+        "phase_scale":{
+            "nullable": true,
+            "required": false,
+            "struct_type": [
+                "float",
+                "int"
+            ],
+            "minlength": 2,
+            "maxlength": 2,
+            "type": [
+                "list",
+                "tuple",
+                "ndarray"
+            ]
+        },
         "parallel":{
             "nullable": false,
             "required": false,

src/astrohack/config/beamcut.param.json

@@ -287,6 +287,88 @@
             "type": ["boolean"]
         }
     },
+    "AstrohackBeamcutFile.plot_beamcut_in_phase":{
+        "destination":{
+            "nullable": false,
+            "required": true,
+            "type": ["string"]
+        },
+        "ant": {
+            "nullable": false,
+            "required": false,
+            "struct_type": [
+                "str"
+            ],
+            "minlength": 1,
+            "type": [
+                "string",
+                "list"
+            ]
+        },
+        "ddi": {
+            "nullable": false,
+            "required": false,
+            "struct_type": [
+                "int"
+            ],
+            "minlength": 1,
+            "type": [
+                "int",
+                "list",
+                "string"
+            ]
+        },
+        "lm_unit":{
+            "nullable": false,
+            "required": false,
+            "type": ["string"],
+            "check allowed with": "units.trig"
+        },
+        "azel_unit":{
+            "nullable": false,
+            "required": false,
+            "type": ["string"],
+            "check allowed with": "units.trig"
+        },
+        "phase_unit":{
+            "nullable": false,
+            "required": false,
+            "type": ["string"],
+            "check allowed with": "units.trig"
+        },
+        "dpi":{
+            "nullable": false,
+            "required": false,
+            "type": ["int"],
+            "min": 1,
+            "max": 1200
+        },
+        "display":{
+            "nullable": false,
+            "required": false,
+            "type": ["boolean"]
+        },
+        "phase_scale":{
+            "nullable": true,
+            "required": false,
+            "struct_type": [
+                "float",
+                "int"
+            ],
+            "minlength": 2,
+            "maxlength": 2,
+            "type": [
+                "list",
+                "tuple",
+                "ndarray"
+            ]
+        },
+        "parallel":{
+            "nullable": false,
+            "required": false,
+            "type": ["boolean"]
+        }
+    },
     "AstrohackBeamcutFile.create_beam_fit_report":{
         "destination":{
             "nullable": false,

src/astrohack/config/beamcut_mds.param.json

@@ -204,7 +204,6 @@ def summary(self) -> None:
         outstr += get_method_list_string(self)
         outstr += get_data_content_string(self.root)
         print(outstr)
-        return outstr
 
     @classmethod
     def create_from_input_parameters(cls, file_name: str, input_parameters: dict):