You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/jwst/cube_build/arguments.rst
+25-16Lines changed: 25 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,17 +14,19 @@ each band will be created.
14
14
If the ``channel`` argument is given, then only data corresponding to that channel will be used in
15
15
constructing the cube. A comma-separated list can be used to designate multiple channels.
16
16
For example, to create a cube with data from channels 1 and 2, specify the
17
-
list as ``--channel='1,2'``. If this argument is not specified, the output will be a set of IFU cubes, one for each
18
-
channel/sub-channel combination contained in the input data.
17
+
list as ``--channel='1,2'``. All the sub-channels (bands) for the chosen channel(s) will
18
+
be used to create the IFU cube, unless the ``band`` argument is used to select specific bands. This parameter can be combined
19
+
with the ``output_type`` parameter to fully control the type of IFU cubes to make.
19
20
20
21
``band [string]``
21
22
This is a MIRI only option and the valid values are SHORT, MEDIUM, LONG, and ALL.
22
23
If the ``band`` argument is given, then only data corresponding
23
-
to that sub-channel will be used in constructing the cube. Only one value can be specified, so IFU cubes are
24
-
created either per sub-channel or using all the sub-channels of the data. If this argument is not specified,
25
-
a set of IFU cubes is created, one for each band. Note we use the name ``band`` for this argument instead of
24
+
to that sub-channel will be used in constructing the cube. Only one value can be specified.
25
+
Note we use the name ``band`` for this argument instead of
26
26
``subchannel``, because the keyword ``band`` in the input images is used to indicate which MIRI subchannel the
27
-
data covers.
27
+
data cover. This parameter can be combined
28
+
with the ``output_type`` parameter to fully control the type of IFU
29
+
cubes to make.
28
30
29
31
``grating [string]``
30
32
This is a NIRSpec only option with valid values PRISM, G140M, G140H, G235M, G235H, G395M, G395H, and ALL.
@@ -44,26 +46,26 @@ each band will be created.
44
46
with the options above [band, channel, grating, filter] to fully control the type of IFU
45
47
cubes to make.
46
48
47
-
- ``output_type = band`` is the default mode for calspec3 and creates IFU cubes containing only one band
49
+
- ``output_type = band`` creates IFU cubes containing only one band
48
50
(channel/sub-channel for MIRI or grating/filter combination for NIRSpec).
49
51
50
52
- ``output_type = channel`` creates a single IFU cube from each unique channel of MIRI data
51
-
(or just those channels set by the 'channel' option).
53
+
(or just those channels set by the 'channel' option). This is the default mode for the
54
+
:ref:`calwebb_spec3 <calwebb_spec3>` pipeline for MIRI data.
52
55
53
56
- ``output_type = grating`` combines all the gratings in the NIRSpec data or set by the
54
-
grating option into a single IFU cube.
57
+
grating option into a single IFU cube. The is the default mode for the
58
+
:ref:`calwebb_spec3 <calwebb_spec3>` pipeline for NIRSpec data.
55
59
56
-
- ``output_type = multi`` combines data into a single "uber" IFU cube, this the default mode for calspec2. If in addition,
57
-
channel, band, grating, or filter are also set, then only the data set by those
60
+
- ``output_type = multi`` combines data into a single "uber" IFU cube, this the default mode for
61
+
:ref:`calwebb_spec2 <calwebb_spec2>` pipeline.
62
+
If in addition, channel, band, grating, or filter are also set, then only the data set by those
58
63
parameters will be combined into an "uber" cube.
59
64
60
65
The following arguments control the size and sampling characteristics of the output IFU cube.
61
66
62
-
``scale1``
63
-
The output cube's spaxel size in axis 1 (spatial).
64
-
65
-
``scale2``
66
-
The output cube's spaxel size in axis 2 (spatial).
67
+
``scalexy``
68
+
The output cube's spaxel size for axis 1 and 2 (spatial).
67
69
68
70
``scalew``
69
71
The output cube's spaxel size in axis 3 (wavelength).
@@ -98,3 +100,10 @@ The arguments related to region of interest and how the fluxes are combined toge
98
100
99
101
For more details on how the weighting of the detector pixel fluxes are used in determining the final spaxel flux see
100
102
the :ref:`weighting` section.
103
+
104
+
A parameter only used for investigating which detector pixels contributed to a cube spaxel is ``debug_spaxel``. This option is only valid if the ``weighting`` parameter is set to ``drizzle`` (default).
105
+
106
+
``debug_spaxel [string]``
107
+
108
+
The string is the x,y,z value of the cube spaxel that is being investigated. The numbering starts counting at 0.
109
+
To print information to the screeen about the x = 10, y = 20, z = 35 spaxel the parameter string value is '10 20 35'.
0 commit comments