Skip to content

Commit

Permalink
Update docs from changes in spacetelescope#8596
Browse files Browse the repository at this point in the history
  • Loading branch information
melanieclarke committed Aug 5, 2024
1 parent 0eb8a3d commit b217ba2
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 57 deletions.
45 changes: 3 additions & 42 deletions docs/jwst/resample/arguments.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,73 +15,36 @@ image.
image. Available kernels are `square`, `gaussian`, `point`,
`turbo`, `lanczos2`, and `lanczos3`.

For spectral data, only the `square` and `point` kernels should be used.
The other kernels do not conserve spectral flux.

``--pixel_scale_ratio`` (float, default=1.0)
Ratio of input to output pixel scale.

For imaging data, a value of 0.5 means the output
image would have 4 pixels sampling each input pixel.

For spectral data, values greater than 1 indicate that the input
pixels have a larger spatial scale, so more output pixels will
sample the same input pixel. For example, a value of 2.0
means the output image would have 2 pixels sampling each input
spatial pixel. If the input data has units of flux density (MJy/pixel),
the output flux per pixel will be half the input flux per pixel.
If the input data has units of surface brightness (MJy/sr), the output
flux per pixel is not scaled.

Note that this parameter is only applied in the cross-dispersion
direction for spectral data: sampling wavelengths are not affected.

Ignored when ``pixel_scale`` or ``output_wcs`` are provided.

.. note::
If this parameter is modified for spectral data, the extraction
aperture for the :ref:`extract_1d <extract_1d_step>` step must
also be modified, since it is specified in pixels.

``--pixel_scale`` (float, default=None)
Absolute pixel scale in ``arcsec``. When provided, overrides
``pixel_scale_ratio``. Ignored when ``output_wcs`` is provided.

For spectral data, if the input data has units of flux density
(MJy/pixel), the output flux per pixel will be scaled by the ratio
of the selected output pixel scale to an average input pixel scale.
If the input data has units of surface brightness (MJy/sr),
the output flux per pixel is not scaled.

Note that this parameter is only applied in the cross-dispersion
direction for spectral data: sampling wavelengths are not affected.

.. note::
If this parameter is modified for spectral data, the extraction
aperture for the :ref:`extract_1d <extract_1d_step>` step must
also be modified, since it is specified in pixels.

``--rotation`` (float, default=None)
Position angle of output image’s Y-axis relative to North.
A value of 0.0 would orient the final output image to be North up.
The default of `None` specifies that the images will not be rotated,
but will instead be resampled in the default orientation for the camera
with the x and y axes of the resampled image corresponding
approximately to the detector axes. Ignored when ``pixel_scale``
or ``output_wcs`` are provided. Also ignored for all spectral data.
or ``output_wcs`` are provided.

``--crpix`` (tuple of float, default=None)
Position of the reference pixel in the image array in the ``x, y`` order.
If ``crpix`` is not specified, it will be set to the center of the bounding
box of the returned WCS object. When supplied from command line, it should
be a comma-separated list of floats. Ignored when ``output_wcs``
is provided. Also ignored for all spectral data.
is provided.

``--crval`` (tuple of float, default=None)
Right ascension and declination of the reference pixel. Automatically
computed if not provided. When supplied from command line, it should be a
comma-separated list of floats. Ignored when ``output_wcs`` is provided.
Also ignored for all spectral data.

``--output_shape`` (tuple of int, default=None)
Shape of the image (data array) using "standard" ``nx`` first and ``ny``
Expand Down Expand Up @@ -140,7 +103,7 @@ image.
``--single`` (bool, default=False)
If set to `True`, resample each input image into a separate output. If
`False` (the default), each input is resampled additively (with weights) to
a common output
a common output.

``--blendheaders`` (bool, default=True)
Blend metadata from all input images into the resampled output image.
Expand All @@ -155,8 +118,6 @@ image.
For example, if set to ``0.5``, only resampled images that use less than
half the available memory can be created.

This parameter is ignored for spectral data.

``--in_memory`` (boolean, default=True)
Specifies whether or not to load and create all images that are used during
processing into memory. If ``False``, input files are loaded from disk when
Expand Down
5 changes: 2 additions & 3 deletions docs/jwst/resample/resample.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
.. resample_:
Python Interface to Drizzle: ResampleData() and ResampleSpecData()
==================================================================
Python Interface to Drizzle: ResampleData()
===========================================

.. automodapi:: jwst.resample.resample
.. automodapi:: jwst.resample.resample_spec
5 changes: 2 additions & 3 deletions docs/jwst/resample/resample_step.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
.. resample_step_:
Python Step Interface: ResampleStep() and ResampleSpecStep()
============================================================
Python Step Interface: ResampleStep()
=====================================

.. automodapi:: jwst.resample.resample_step
.. automodapi:: jwst.resample.resample_spec_step
46 changes: 37 additions & 9 deletions docs/jwst/resample_spec/arguments.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,50 @@ image.

``--kernel`` (str, default='square')
The form of the kernel function used to distribute flux onto the output
image. Available kernels are `square` and `point`.
image. Available kernels for spectral data are `square` and `point`.
Other drizzle kernels, available for imaging data, do not conserve
spectral flux.

``--pixel_scale_ratio`` (float, default=1.0)
Ratio of input to output spatial pixel scale. Values greater than 1
indicate that the input pixels have a larger spatial scale, so more output
pixels will sample the same input pixel. For example, a value of 2.0
means the output image would have 4 pixels sampling each input pixel.
This parameter is only applied in the cross-dispersion
Ratio of input to output spatial pixel scale.

For spectral data, values greater than 1 indicate that the input
pixels have a larger spatial scale, so more output pixels will
sample the same input pixel. For example, a value of 2.0
means the output image would have 2 pixels sampling each input
spatial pixel. If the input data has units of flux density (MJy/pixel),
the output flux per pixel will be half the input flux per pixel.
If the input data has units of surface brightness (MJy/sr), the output
flux per pixel is not scaled.

Note that this parameter is only applied in the cross-dispersion
direction: sampling wavelengths are not affected.

Ignored when ``pixel_scale`` or ``output_wcs`` are provided.

.. note::
If this parameter is modified from the default value, the extraction
aperture for the :ref:`extract_1d <extract_1d_step>` step must
also be modified, since it is specified in pixels.

``--pixel_scale`` (float, default=None)
Absolute pixel scale in ``arcsec``. This parameter is only applied in
the cross-dispersion direction. When provided, overrides
Absolute pixel scale in ``arcsec``. When provided, overrides
``pixel_scale_ratio``. Ignored when ``output_wcs`` is provided.

For spectral data, if the input data has units of flux density
(MJy/pixel), the output flux per pixel will be scaled by the ratio
of the selected output pixel scale to an average input pixel scale.
If the input data has units of surface brightness (MJy/sr),
the output flux per pixel is not scaled.

Note that this parameter is only applied in the cross-dispersion
direction: sampling wavelengths are not affected.

.. note::
If this parameter is modified from the default value, the extraction
aperture for the :ref:`extract_1d <extract_1d_step>` step must
also be modified, since it is specified in pixels.

``--output_shape`` (tuple of int, default=None)
Shape of the image (data array) using "standard" ``nx`` first and ``ny``
second (as opposite to the ``numpy.ndarray`` convention - ``ny`` first and
Expand Down Expand Up @@ -84,7 +112,7 @@ image.
``--single`` (bool, default=False)
If set to `True`, resample each input image into a separate output. If
`False` (the default), each input is resampled additively (with weights) to
a common output
a common output.

``--blendheaders`` (bool, default=True)
Blend metadata from all input images into the resampled output image.
Expand Down

0 comments on commit b217ba2

Please sign in to comment.