Merge pull request #1 from cpparts/CST-248-orientation_investigation

add: changing viewer rotation

Author: cpparts

CHANGELOG.md

@@ -16,6 +16,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## Added
+
+- `rotation` parameter can now be called to rotate the ipyaladin viewer [#146]
+
 ## [0.6.0]
 
 ## Added

examples/02_Base_Commands.ipynb

@@ -88,6 +88,31 @@
     "aladin.fov"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "The orientation of the view (view center to north pole angle in degrees) can be set"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "aladin.rotation = 180"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "aladin.rotation"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -134,7 +159,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "The target and field of view can be set with astropy objects"
+    "The target, rotation, and field of view can be set with astropy objects"
    ]
   },
   {
@@ -146,6 +171,15 @@
     "aladin.target = SkyCoord(\"12h00m00s\", \"-30d00m00s\", frame=\"icrs\")"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "aladin.rotation = Angle(0, \"deg\")"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,

examples/11_Extracting_information_from_the_view.ipynb

@@ -81,7 +81,8 @@
     "aladin.survey = \"CDS/P/PLANCK/R2/HFI/color\"\n",
     "aladin.target = \"LMC\"\n",
     "aladin.frame = \"Galactic\"\n",
-    "aladin.fov = 50"
+    "aladin.fov = 50\n",
+    "aladin.rotation = 90"
    ]
   },
   {
@@ -124,6 +125,26 @@
     "aladin.fov_xy  # Recover the current field of view for the x and y axis"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "fcd830c2",
+   "metadata": {},
+   "source": [
+    "## Getting the rotation\n",
+    "\n",
+    "The rotation of the view (view center to north pole angle in degrees) can be found with:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "8c20e7c1",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "aladin.rotation  # Recover the current rotation of the view"
+   ]
+  },
   {
    "cell_type": "markdown",
    "id": "5ef087ca59d890ce",

js/models/event_handler.js

@@ -46,6 +46,15 @@ export default class EventHandler {
     this.model.set("_wcs", this.aladin.getViewWCS());
   }
 
+  /**
+   * Updates the view center rotation in the model.
+   * WARNING: This method doesn't call model.save_changes()!
+   */
+  updateRotation() {
+    if (!this.isLastDiv()) return;
+    this.model.set("_rotation", this.aladin.getRotation());
+  }
+
   /**
    * Updates the 2-axis FoV in the model.
    * WARNING: This method don't call model.save_changes()!
@@ -138,6 +147,15 @@ export default class EventHandler {
       this.model.save_changes();
     });
 
+    /* Rotation control */
+    this.model.on("change:_rotation", () => {
+      this.updateRotation(this.model.get("_rotation"), this.aladinDiv);
+      // Update WCS and FoV only if this is the last div
+      this.updateWCS();
+      this.update2AxisFoV();
+      this.model.save_changes();
+    });
+
     /* Aladin callbacks */
 
     this.aladin.on("cooFrameChanged", () => {
@@ -184,6 +202,17 @@ export default class EventHandler {
       }
     });
 
+    this.aladin.on("rotationChanged", (object) => {
+      if (object["data"] !== undefined) {
+        this.model.send({
+          event_type: "rotation_changed",
+          content: {
+            rotation: object["rotation"],
+          },
+        });
+      }
+    });
+
     this.aladin.on("objectClicked", (clicked) => {
       if (clicked) {
         let clickedContent = {
@@ -273,6 +302,7 @@ export default class EventHandler {
     this.eventHandlers = {
       add_marker: this.messageHandler.handleAddMarker,
       change_fov: this.messageHandler.handleChangeFoV,
+      change_rotation: this.messageHandler.handleChangeRotation,
       goto_ra_dec: this.messageHandler.handleGotoRaDec,
       save_view_as_image: this.messageHandler.handleSaveViewAsImage,
       add_fits: this.messageHandler.handleAddFits,
@@ -302,6 +332,7 @@ export default class EventHandler {
     this.model.off("change:_target");
     this.model.off("change:_fov");
     this.model.off("change:_height");
+    this.model.off("change:_rotation");
     this.model.off("change:coo_frame");
     this.model.off("change:survey");
     this.model.off("change:overlay_survey");

js/models/message_handler.js

@@ -38,6 +38,10 @@ export default class MessageHandler {
     this.aladin.gotoRaDec(msg["ra"], msg["dec"]);
   }
 
+  handleChangeRotation(msg) {
+    this.aladin.setRotation(msg["rotation"]);
+  }
+
   async handleSaveViewAsImage(msg) {
     const path = msg["path"];
     const format = msg["format"];

js/widget.js

@@ -31,14 +31,17 @@ function initAladinLite(model, el) {
   const raDec = model.get("_target").split(" ");
   aladin.gotoRaDec(raDec[0], raDec[1]);
 
-  // Set current FoV and WCS
+  // Set current FoV, WCS, and rotation
   const twoAxisFoV = { ...aladin.getFov() };
   model.set("_fov_xy", {
     x: twoAxisFoV[0],
     y: twoAxisFoV[1],
   });
   const wcs = { ...aladin.getViewWCS() };
   model.set("_wcs", wcs);
+  const rotation = { ...aladin.getRotation() };
+  model.set("_rotation", rotation);
+
   model.set("_is_loaded", true);
   model.save_changes();
 

src/ipyaladin/widget.py

@@ -143,6 +143,7 @@ class Aladin(anywidget.AnyWidget):
     # Options for the view initialization
     _init_options = traitlets.Dict().tag(sync=True)
     _height = Int(400).tag(sync=True, init_option=True)
+    _rotation = Float(0).tag(sync=True, init_option=True)
     _target = Unicode(
         "0 0",
         help="A private trait that stores the current target of the widget in a string."
@@ -220,8 +221,12 @@ def __init__(self, *args: any, **init_options: any) -> None:
         # https://github.com/jupyter-widgets/ipywidgets/blob/main/python/ipywidgets/ipywidgets/widgets/domwidget.py
         for key in ["layout", "tabbable", "tooltip"]:
             init_options.pop(key, None)
+        init_options["north_pole_orientation"] = init_options.get(
+            "north_pole_orientation", init_options.get("rotation", 0)
+        )
         # some init options are properties here
         self.height = init_options.get("height", self._height)
+        self.rotation = init_options.get("north_pole_orientation", self._rotation)
         self.target = init_options.get("target", self._target)
         self.fov = init_options.get("fov", self._fov)
         # apply different default options from Aladin-Lite
@@ -294,6 +299,38 @@ def height(self, height: int) -> None:
         self._fov_xy = {}
         self._height = height
 
+    @property
+    def rotation(self) -> float:
+        """The center rotation of the widget.
+
+        This is the view center to north pole angle in degrees.
+        This is equivalent to getting the 3rd Euler angle.
+        Positive angles rotates the view in the counter clockwise
+        order (or towards the east).
+
+        It can be set with either a float number in degrees
+        or an astropy.coordinates.Angle object.
+
+        Returns
+        -------
+        astropy.coordinates.Angle
+            An astropy.coordinates.Angle object representing the center
+            rotation of the widget in degrees. The default rotation is
+            0 degrees.
+        """
+        return Angle(self._rotation, unit="deg")
+
+    @rotation.setter
+    def rotation(self, rotation: Union[float, Angle]) -> None:
+        if isinstance(rotation, Angle):
+            rotation = rotation.deg
+        if np.isclose(self._rotation, rotation):
+            return
+        self._wcs = {}
+        self._fov_xy = {}
+        self._rotation = rotation
+        self.send({"event_name": "change_rotation", "rotation": rotation})
+
     @property
     def wcs(self) -> WCS:
         """The world coordinate system corresponding to the current view of ipyaladin.

src/tests/test_aladin.py

@@ -129,6 +129,89 @@ def test_aladin_angle_fov_set(angle: float) -> None:
     assert aladin.fov.deg == angle_fov.deg
 
 
+test_aladin_float_rotation = [
+    0,
+    360,
+    180,
+    -180,
+    720,
+]
+
+
+@pytest.mark.parametrize("angle", test_aladin_float_rotation)
+def test_aladin_float_rotation_set(angle: float) -> None:
+    """Test setting the rotation of an Aladin object with a float.
+
+    Parameters
+    ----------
+    angle : float
+        The angle to set.
+
+    """
+    aladin.rotation = angle
+    assert aladin.rotation.deg == angle
+
+
+@pytest.mark.parametrize("angle", test_aladin_float_rotation)
+def test_aladin_angle_rotation_set(angle: float) -> None:
+    """Test setting the rotation of an Aladin object with an Angle object.
+
+    Parameters
+    ----------
+    angle : float
+        The angle to set.
+
+    """
+    angle_rotation = Angle(angle, unit="deg")
+    aladin.rotation = angle_rotation
+    assert aladin.rotation.deg == angle_rotation.deg
+
+
+@pytest.mark.parametrize("angle", test_aladin_float_rotation)
+def test_aladin_init_rotation(angle: float) -> None:
+    """Test initializing an Aladin object with rotation set.
+
+    Parameters
+    ----------
+    angle : float
+        The angle to set.
+
+    """
+    test_aladin = Aladin(rotation=angle)
+    assert test_aladin.rotation.deg == angle
+
+
+@pytest.mark.parametrize("angle", test_aladin_float_rotation)
+def test_aladin_init_north_pole_orientation(angle: float) -> None:
+    """Test initializing Aladin object with north_pole_orientation set.
+
+    Parameters
+    ----------
+    angle : float
+        The angle to set.
+
+    """
+    test_aladin = Aladin(north_pole_orientation=angle)
+    assert test_aladin.rotation.deg == angle
+
+
+@pytest.mark.parametrize("angle", test_aladin_float_rotation)
+def test_aladin_init_north_pole_orientation_overrides_rotation(angle: float) -> None:
+    """
+    Test init Aladin object with north_pole_orientation and rotation set.
+
+    north_pole_orientation should override rotation.
+
+    Parameters
+    ----------
+    angle : float
+        The angle to set.
+
+    """
+    test_aladin = Aladin(north_pole_orientation=angle, rotation=180)
+    assert test_aladin.rotation.deg == angle
+
+
 test_stcs_iterables = [
     "CIRCLE ICRS 258.93205686 43.13632863 0.625",
     [