Skip to content

Commit

Permalink
Merge pull request #1589 from camipacifici/regions-background-docs
Browse files Browse the repository at this point in the history
Disclaimer for background region
  • Loading branch information
pllim authored Aug 19, 2022
2 parents 4ee66f2 + e55f0bf commit 2c8d971
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/imviz/plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,9 @@ an interactively selected region. A typical workflow is as follows:
and :guilabel:`Annulus width`, respectively. Median of the pixels within
the annulus region will be used but the annulus shape will not be shown on display.
* Subset: Define a region for background calculation (median) using Subset draw tool
and select that region using the :guilabel:`Background` dropdown menu.
and select that region using the :guilabel:`Background` dropdown menu. Only regions
created with the :guilabel:`replace` option are acceptable as background regions
(see :ref:`imviz_defining_spatial_regions`).

6. For some JWST and HST images, pixel area in arcsec squared is automatically
populated in the :guilabel:`Pixel area` field from image metadata. If it does
Expand Down Expand Up @@ -174,7 +176,7 @@ an interactively selected region. A typical workflow is as follows:
this page.
* Radial Profile: Binned average as a function of radius from the center of the region.
* Radial Profile (Raw): Raw image data points as a function of radius from the center of the region.
Caution: having too many data points may cause performance issues with this feature.
Caution: having too many data points may cause performance issues with this feature.
The exact limitations depend on your hardware.

10. Toggle :guilabel:`Fit Gaussian` on to fit a `~astropy.modeling.functional_models.Gaussian1D`
Expand Down

0 comments on commit 2c8d971

Please sign in to comment.