WIP: Culler and Ender Future PSF Photometry API #753
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 pull request is set up for the discussion of the forward-looking additions to PSF photometry and should not be merged until after the discussion is finished. In this case the issue is the 'culler and ender' aspect of the block diagram. This API documentation complements that in #721 where the documentation for those blocks implemented, with solid APIs unlikely to change in future releases. Please see #766 for an overview of the fitting process and a revised block diagram.
The structure of the blocks input and output parameters is described in detail in the documentation, but the main three stages are summarised below:
CullerAndEnder
data
(~astropy.table.Table
),psf_model
(~astropy.modeling.Fittable2DModel
), andnew_sources
(~astropy.table.Table
) and returnsnew_data
(~astropy.table.Table
) andend_flag
(boolean).cull_data
data
andpsf_model
and returnsnew_data
(~astropy.table.Table
)end_loop
new_data
,data
andnew_sources
, returningend_flag
(boolean)Please provide any feedback on the API for this PSF photometry fitting routine block you may have, such that the implementation meets all of the requirements of all users and is as clear as possible going forward. A simple example for this block, maintaining "do nothing" backwards-compatibility can be found here, with example implementation in
IterativelySubtractedPSFPhotometry
. Please also provide simpler formatting or grammatical changes to improve the readability and professional look of the document. The function's primary goals are to remove poor quality fits from the list of sources returned to the user, and break the iterative process if certain criteria are met.