Skip to content

Commit

Permalink
DOC: Add warning about surface brightness in Simple Aperture Photomet…
Browse files Browse the repository at this point in the history
…ry plugin (#2261)

* DOC: Add warning about surface brightness
in Simple Aperture Photometry plugin.

I am beginning to think the Simple in plugin name no longer applies.

* DOC: Improve verbiage.

Co-authored-by: Camilla Pacifici <camilla.pacifici@gmail.com>

---------

Co-authored-by: Camilla Pacifici <camilla.pacifici@gmail.com>
  • Loading branch information
pllim and camipacifici authored Jun 23, 2023
1 parent 0fdb3bd commit d5fbd70
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/imviz/plugins.rst
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

0 comments on commit d5fbd70

Please sign in to comment.