WIP: PSF Photometry API documentation for established functionality #721
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is part of the process for establishing the block API for PSF photometry. The documentation in this PR is unlikely to change as the four blocks here -- background estimation, source finder, source grouper, and PSF model -- are either independently used within
photutils
and thus well tested, matured and established pieces of code, or are relatively straightforward and thus leave little room for API changes. Please see #766 for an overview of the fitting process.The documentation for
background_estimator
andfinder
should be very stable to changes, as these are the external function calls to routines used significantly throughoutphotutils
. For these the primary issues are wording and formatting.group_maker
however is slightly less stable, and thus in addition to checking for clarity and formatting this block description must succinctly and clearly explain the dependency of the group maker on the scene maker (developed in parallel with the extension of PSF fitting to non-point sources, in which "groups" can include the merging of several point sources into an extended object and vice versa).psf_model
is a relatively minor documentation block, as it is primarily an external astropy class for which the PSF model must be a subclass, with specific input parameters. Thus this documentation must also explain this dependency.The issues to be discussed in this PR are therefore:
Please provide comments on any clarifications, inconsistencies, formatting changes or documentation flow changes here.