Skip to content

Commit

Permalink
Fix docs for area method
Browse files Browse the repository at this point in the history
  • Loading branch information
larrybradley committed Jan 23, 2015
1 parent fb6dcf2 commit c203fcb
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/photutils/aperture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -242,12 +242,12 @@ To calculate the mean local background within the circular annulus
aperture, we need to divide its sum by its area, which can be
calculated using the :meth:`~photutils.CircularAnnulus.area` method::

>>> bkg_mean = phot_table['aperture_sum_bkg'] / annulus_apertures.area
>>> bkg_mean = phot_table['aperture_sum_bkg'] / annulus_apertures.area()

The background sum within the circular aperture is then the mean local
background times the circular aperture area::

>>> bkg_sum = bkg_mean * apertures.area
>>> bkg_sum = bkg_mean * apertures.area()
>>> final_sum = phot_table['aperture_sum_raw'] - bkg_sum
>>> phot_table['residual_aperture_sum'] = final_sum
>>> print(phot_table['residual_aperture_sum']) # doctest: +FLOAT_CMP
Expand Down

0 comments on commit c203fcb

Please sign in to comment.