Skip to content

Commit

Permalink
Update documentation (#6077)
Browse files Browse the repository at this point in the history
* Update documentation

* Add PR # to CHANGES.rst

* Move change entry to correct section

* Missing )

Co-authored-by: Howard Bushouse <[email protected]>
  • Loading branch information
drlaw1558 and hbushouse authored May 28, 2021
1 parent e4f1b84 commit 22a204e
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 5 deletions.
5 changes: 5 additions & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@ combine_1d
- Added SRCTYPE to COMBINE1D output extension headers, propagated from
EXTRACT1D inputs [#6079]

cube_build
----------

- Fix some typos in the the arguments documentation. [#6077]

datamodels
----------

Expand Down
10 changes: 5 additions & 5 deletions docs/jwst/cube_build/arguments.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,16 +44,16 @@ each band will be created.
with the options above [band, channel, grating, filter] to fully control the type of IFU
cubes to make.

- ``output_type = band`` is the default mode for calspec2 and creates IFU cubes containing only one band
(channel/sub-channel or grating/filter combination).
- ``output_type = band`` is the default mode for calspec3 and creates IFU cubes containing only one band
(channel/sub-channel for MIRI or grating/filter combination for NIRSpec).

- ``output_type = channel`` combines all the MIRI channels in the data or set by the
channel option into a single IFU cube.
- ``output_type = channel`` creates a single IFU cube from each unique channel of MIRI data
(or just those channels set by the 'channel' option).

- ``output_type = grating`` combines all the gratings in the NIRSpec data or set by the
grating option into a single IFU cube.

- ``output_type = multi`` combines data into a single "uber" IFU cube, this the default mode for calspec3. If in addition,
- ``output_type = multi`` combines data into a single "uber" IFU cube, this the default mode for calspec2. If in addition,
channel, band, grating, or filter are also set, then only the data set by those
parameters will be combined into an "uber" cube.

Expand Down

0 comments on commit 22a204e

Please sign in to comment.