Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Add warning about surface brightness in Simple Aperture Photometry plugin #2261

Merged
merged 2 commits into from
Jun 23, 2023
Merged

DOC: Add warning about surface brightness in Simple Aperture Photometry plugin #2261

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
98b74ef
DOC: Add warning about surface brightness
pllim Jun 21, 2023
5b97fc5
DOC: Improve verbiage.
pllim Jun 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/imviz/plugins.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,15 @@ an interactively selected region. A typical workflow is as follows:
in display data unit. Otherwise, it is only informational.
If this field is not applicable for you, leave it at 0.
**This field resets every time Data selection changes if auto-population not possible.**

.. warning::

If your data is in surface brightness units and pixels on the image
have varying sky area, you should first convert your data from
surface brightness to flux units before using this plugin.
This is because, for performance reasons, the plugin multiplies
by the area after the aperture sum is calculated.

7. If you also want photometry result in the unit of counts, you can enter a
conversion factor in the :guilabel:`Counts conversion factor` field. The value
must be in the unit of display data unit per counts. This is used to convert linear
Expand Down