diff --git a/docs/cubeviz/displaycubes.rst b/docs/cubeviz/displaycubes.rst index 7a3ebb01a7..9e05919d3c 100644 --- a/docs/cubeviz/displaycubes.rst +++ b/docs/cubeviz/displaycubes.rst @@ -7,7 +7,7 @@ Displaying Cubes The Cubeviz layout includes two image viewers (at the top of the app) and one spectrum viewer (at the bottom of the app), which it attempts to populate automatically when the first dataset is loaded. By default, Cubeviz -attempts to parse and display the flux in the top left viewer, the uncertainty +attempts to parse and display the flux in the top left viewer and the uncertainty in the top right viewer. The spectrum viewer is populated by default by collapsing the spatial axes using the "Sum" function. The indicators that the load machinery looks for in each HDU to @@ -34,8 +34,8 @@ Jupyter notebook using an API. The Toolbar below gives you several spectroscopic display options. Right click will open a dropdown with access to different options for each button. -.. image:: ./img/cubeviztoolbar.jpg - :alt: Speciz Toolbar +.. image:: ./img/cubeviztoolbar.png + :alt: Cubeviz Toolbar .. _cubeviz-selecting-data: @@ -93,6 +93,7 @@ over the region, and the resulting spectrum will be displayed in the 1D spectrum the bottom of the UI. .. image:: img/subset_creation.png + :alt: Subset creation in Cubeviz .. _cubeviz-spectrum-at-spaxel: diff --git a/docs/cubeviz/displayspectra.rst b/docs/cubeviz/displayspectra.rst index d751d39aa2..a74ae33d55 100644 --- a/docs/cubeviz/displayspectra.rst +++ b/docs/cubeviz/displayspectra.rst @@ -3,11 +3,12 @@ Displaying Spectra ****************** A collapsed spectrum of the cube displayed in the upper-left viewer -automatically appears in the 1D spectrum viewer, using the Maximum -collapse method. The collapse method can be changed in the :guilabel:`Viewer` -tab of the |icon-settings-sliders| icon in the spectrum viewer. Additional spectra +automatically appears in the 1D spectrum viewer, using the set collapse function. +The collapse function can be changed in the :guilabel:`Line` +tab of the Plot Options plugin, which can be reached by clicking the |icon-settings-sliders| +icon in the spectrum viewer. Additional spectra can be loaded into the spectrum viewer, as detailed in the linked documentation -below. +below. .. seealso:: diff --git a/docs/cubeviz/img/cubeviztoolbar.jpg b/docs/cubeviz/img/cubeviztoolbar.jpg deleted file mode 100644 index e9f88be9bb..0000000000 Binary files a/docs/cubeviz/img/cubeviztoolbar.jpg and /dev/null differ diff --git a/docs/cubeviz/img/cubeviztoolbar.png b/docs/cubeviz/img/cubeviztoolbar.png new file mode 100644 index 0000000000..d06062b5f2 Binary files /dev/null and b/docs/cubeviz/img/cubeviztoolbar.png differ diff --git a/docs/cubeviz/img/subset_creation.png b/docs/cubeviz/img/subset_creation.png index b4501ea451..efe0f53cd9 100644 Binary files a/docs/cubeviz/img/subset_creation.png and b/docs/cubeviz/img/subset_creation.png differ diff --git a/docs/cubeviz/import_data.rst b/docs/cubeviz/import_data.rst index 33fa37fbb7..47fbe08863 100644 --- a/docs/cubeviz/import_data.rst +++ b/docs/cubeviz/import_data.rst @@ -6,7 +6,7 @@ Importing Data into Cubeviz By design, Cubeviz only supports data that can be parsed as :class:`~specutils.Spectrum1D` objects. Despite the name, :class:`~specutils.Spectrum1D` -now supports 3D cubes and allows the Python-level interface and parsing tools to +supports 3D cubes and allows the Python-level interface and parsing tools to be defined in ``specutils`` instead of being duplicated in Jdaviz. :class:`~specutils.Spectrum1D` objects are very flexible in their capabilities, however, and hence should address most astronomical spectrum use cases. @@ -139,8 +139,14 @@ object, you can load it into Cubeviz as follows: .. code-block:: python import numpy as np - import astropy.wcs as fitswcs + from astropy.wcs import wcs + import astropy.units as u + from specutils import Spectrum1D from jdaviz import Cubeviz + from jwst import datamodels + + file = "/path/to/data/file.fits" + mydatamodel = datamodels.open(file) # mydatamodel is a jwst.datamodels object # Due to current schema in jwst.datamodels, you'll need to create your own WCS object before you create your Spectrum1D object diff --git a/docs/cubeviz/index.rst b/docs/cubeviz/index.rst index 3205126deb..f5a23f7566 100644 --- a/docs/cubeviz/index.rst +++ b/docs/cubeviz/index.rst @@ -18,18 +18,17 @@ with IFU data cubes. It uses the `specutils `_ package from `Astropy `_ . -Cubeviz is a tool for visualization and quick-look analysis of 3D data cubes, -primarily from integral field units (IFUs). It incorporates visualization tools +Cubeviz incorporates visualization tools with analysis capabilities, such as Astropy regions and :ref:`specutils` packages. Users can interact with their data from within the tool. Cubeviz allows spectra of regions within the cube to be easily plotted and examined, offering all the same capabilities as :ref:`specviz`. -In addition, Cubeviz also allows users to interacting with their cube to: +In addition, Cubeviz also allows users to interact with their cube to: * view the wavelength slices (RA, DEC), -* view flux, error, and data quality cubes simultaneously, +* view flux and error or data quality cubes simultaneously, * view spectra from selected spatial (RA, DEC) regions,