diff --git a/CHANGES.rst b/CHANGES.rst index 700bb9fdd1..c5daa223d9 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -9,6 +9,10 @@ New Features - Configurations that support multiple, simultaneous data files now allow multiple data products to be specified in the command line. [#1890] +- Ability to cycle through datasets to expose information during mouseover. [#1953] + +- New markers plugin to log mouseover information to a table. [#1953] + Cubeviz ^^^^^^^ diff --git a/docs/cubeviz/export_data.rst b/docs/cubeviz/export_data.rst index 10b7264d66..6c2419eb0c 100644 --- a/docs/cubeviz/export_data.rst +++ b/docs/cubeviz/export_data.rst @@ -126,3 +126,10 @@ the ``x`` and ``y`` parameters identify specifically which spaxel fits are to be for models applied to every spaxel using the :guilabel:`Apply to Cube` button. Leaving ``x`` or ``y`` as ``None`` will mean that the models fit to every spaxel across that axis will be returned. + +Markers Table +============= + +All mouseover information in the :ref:`markers plugin ` can be exported to an +:ref:`astropy table ` +by calling :meth:`~jdaviz.core.template_mixin.TableMixin.export_table` (see :ref:`plugin-apis`). diff --git a/docs/cubeviz/plugins.rst b/docs/cubeviz/plugins.rst index 10701e5c7f..abea089de8 100644 --- a/docs/cubeviz/plugins.rst +++ b/docs/cubeviz/plugins.rst @@ -55,6 +55,15 @@ Subset Tools :ref:`Subset Tools ` Imviz documentation describing the concept of subsets in Jdaviz. + +Markers +======= + +.. seealso:: + + :ref:`Markers ` + Imviz documentation describing the markers plugin. + .. _slice: Slice diff --git a/docs/imviz/displayimages.rst b/docs/imviz/displayimages.rst index 5beef47b9a..ec8b2fb357 100644 --- a/docs/imviz/displayimages.rst +++ b/docs/imviz/displayimages.rst @@ -35,6 +35,10 @@ cursor's location in pixel space (X and Y), the RA and Dec at that point, and th of the data there. This information is displayed in the top bar of the UI, on the middle-right side. +By default, the cursor information will correspond to the top image layer in the viewer. +To change to a specific data-layer, click the layer-icon in the top bar to cycle between +"auto", "cursor", or specific data layers. + Notes on GWCS ------------- diff --git a/docs/imviz/export_data.rst b/docs/imviz/export_data.rst index ed3c644cae..328f5c1f91 100644 --- a/docs/imviz/export_data.rst +++ b/docs/imviz/export_data.rst @@ -111,3 +111,15 @@ The columns are as follow: Once you have the results in a table, you can further manipulated them as documented in :ref:`astropy:astropy-table`. + +Markers Table +============= + +All mouseover information in the :ref:`markers plugin ` can be exported to an +:ref:`astropy table ` +by calling :meth:`~jdaviz.core.template_mixin.TableMixin.export_table` (see :ref:`plugin-apis`): + +.. code-block:: python + + markers_plugin = imviz.plugins["Markers"] + markers_table = markers_plugin.export_table() diff --git a/docs/imviz/plugins.rst b/docs/imviz/plugins.rst index 38df466801..4844c2e48c 100644 --- a/docs/imviz/plugins.rst +++ b/docs/imviz/plugins.rst @@ -74,6 +74,28 @@ parameters, shape, and orientation (if applicable) all update concurrently. Angle is counter-clockwise rotation around the center in degrees. +.. _markers-plugin: + +Markers +======= + +This plugin allows for interactively creating markers in any viewer and logging information about +the location of that marker along with the applicable data and viewer labels into a table. + +With the plugin open in the tray, mouse over any viewer and press the "m" key to log the information +displayed in the app toolbar into the table. The markers remain at that fixed pixel-position in +the viewer they were created (regardless of changes to the underlying data or linking) and are only +visible when the plugin is opened. + +In Imviz, the table also exposed columns labeled "pixel:unreliable", "world:unreliable", and +"value:unreliable". These will be logged as ``True`` in cases where the information is outside +the bounds of the reference image's WCS (noted in the mouseover display by the information showing +as grayed). + +To export the table into the notebook via the API, call +:meth:`~jdaviz.core.template_mixin.TableMixin.export_table` +(see :ref:`plugin-apis`). + .. _imviz-link-control: Link Control diff --git a/docs/mosviz/plugins.rst b/docs/mosviz/plugins.rst index 93f3aac7bf..7ca0c9376f 100644 --- a/docs/mosviz/plugins.rst +++ b/docs/mosviz/plugins.rst @@ -44,6 +44,16 @@ Subset Tools :ref:`Subset Tools ` Imviz documentation describing the concept of subsets in Jdaviz. +.. _imviz_export_markers: + +Markers +======= + +.. seealso:: + + :ref:`Markers ` + Imviz documentation describing the markers plugin. + Gaussian Smooth =============== diff --git a/docs/reference/api.rst b/docs/reference/api.rst index ef3963f30c..551b7f3b81 100644 --- a/docs/reference/api.rst +++ b/docs/reference/api.rst @@ -84,6 +84,9 @@ Plugins .. automodapi:: jdaviz.configs.default.plugins.line_lists.line_lists :no-inheritance-diagram: +.. automodapi:: jdaviz.configs.default.plugins.markers.markers + :no-inheritance-diagram: + .. automodapi:: jdaviz.configs.default.plugins.metadata_viewer.metadata_viewer :no-inheritance-diagram: diff --git a/docs/specviz/displaying.rst b/docs/specviz/displaying.rst index ff417f115e..2909d874a2 100644 --- a/docs/specviz/displaying.rst +++ b/docs/specviz/displaying.rst @@ -51,6 +51,10 @@ cursor position as well as the spectral axis value, pixel, and flux of the close to the cursor. This information is displayed in the top bar of the UI, on the middle-right side. +By default, the cursor information will correspond to the closest data layer to the cursor. +To change to a specific data-layer, click the layer-icon in the top bar to cycle between +"auto", "cursor", or specific data layers. + Home ==== diff --git a/docs/specviz/export_data.rst b/docs/specviz/export_data.rst index 711800f9f0..f7c0fab6f3 100644 --- a/docs/specviz/export_data.rst +++ b/docs/specviz/export_data.rst @@ -96,3 +96,11 @@ To extract all of the model parameters: myparams where the ``model_label`` parameter identifies which model should be returned. +.. _specviz-export-markers: + +Markers Table +============= + +All mouseover information in the :ref:`markers plugin ` can be exported to an +:ref:`astropy table ` +by calling :meth:`~jdaviz.core.template_mixin.TableMixin.export_table` (see :ref:`plugin-apis`). diff --git a/docs/specviz/plugins.rst b/docs/specviz/plugins.rst index 958d79e26a..c824c0cae2 100644 --- a/docs/specviz/plugins.rst +++ b/docs/specviz/plugins.rst @@ -50,6 +50,14 @@ Subset Tools :ref:`Subset Tools ` Imviz documentation describing the concept of subsets in Jdaviz. +Markers +======= + +.. seealso:: + + :ref:`Markers ` + Imviz documentation describing the markers plugin. + .. _gaussian-smooth: Gaussian Smooth diff --git a/docs/specviz2d/export_data.rst b/docs/specviz2d/export_data.rst index f4646b9b13..4fc2ecd8bc 100644 --- a/docs/specviz2d/export_data.rst +++ b/docs/specviz2d/export_data.rst @@ -37,3 +37,11 @@ An instance of Specviz can also be accessed, which exposes some helper methods f :ref:`Specviz: Export Data ` Specviz documentation on exporting spectra. + + +Markers Table +============= + +All mouseover information in the :ref:`markers plugin ` can be exported to an +:ref:`astropy table ` +by calling :meth:`~jdaviz.core.template_mixin.TableMixin.export_table` (see :ref:`plugin-apis`). diff --git a/docs/specviz2d/plugins.rst b/docs/specviz2d/plugins.rst index 734fdfaa3d..e4cdfc73c3 100644 --- a/docs/specviz2d/plugins.rst +++ b/docs/specviz2d/plugins.rst @@ -37,6 +37,14 @@ Subset Tools :ref:`Subset Tools ` Imviz documentation describing the concept of subsets in Jdaviz. + +Markers +======= + +.. seealso:: + + :ref:`Markers ` + Imviz documentation describing the markers plugin. .. _specviz2d-spectral-extraction: diff --git a/jdaviz/components/layer_viewer_icon.vue b/jdaviz/components/layer_viewer_icon.vue index b006f7faf8..a04190fe1f 100644 --- a/jdaviz/components/layer_viewer_icon.vue +++ b/jdaviz/components/layer_viewer_icon.vue @@ -1,6 +1,11 @@ @@ -19,7 +24,7 @@ module.exports = {