DM-29242: Numpydoc conversion of meas_algorithms through psfSelectionFromMatchList.py #235
Conversation
| ## @ref ObjectSizeStarSelectorTask_ "ObjectSizeStarSelectorTask" | ||
| ## @copybrief ObjectSizeStarSelectorTask | ||
| ## @} | ||
|
|
||
|
|
||
| @pexConfig.registerConfigurable("objectSize", sourceSelectorRegistry) | ||
| class ObjectSizeStarSelectorTask(BaseSourceSelectorTask): | ||
| r"""!A star selector that looks for a cluster of small objects in a size-magnitude plot |
There was a problem hiding this comment.
You forgot a few exclamation points!
And please add a period at the end.
| @@ -227,7 +229,8 @@ def _kcenters(yvec, nCluster, useMedian=False, widthStdAllowed=0.15): | |||
|
|
|||
|
|
|||
| def _improveCluster(yvec, centers, clusterId, nsigma=2.0, nIteration=10, clusterNum=0, widthStdAllowed=0.15): | |||
| """Improve our estimate of one of the clusters (clusterNum) by sigma-clipping around its median""" | |||
| """Improve our estimate of one of the clusters (clusterNum) by sigma-clipping around its median | |||
There was a problem hiding this comment.
Please add a period here.
| @@ -155,7 +156,8 @@ def __call__(self, ev): | |||
|
|
|||
|
|
|||
| def _assignClusters(yvec, centers): | |||
| """Return a vector of centerIds based on their distance to the centers""" | |||
| """Return a vector of centerIds based on their distance to the centers | |||
There was a problem hiding this comment.
Please add a period here.
| @@ -122,7 +122,8 @@ def validate(self): | |||
|
|
|||
|
|
|||
| class EventHandler: | |||
| """A class to handle key strokes with matplotlib displays""" | |||
| """A class to handle key strokes with matplotlib displays | |||
There was a problem hiding this comment.
Please add a period here.
| BasePsfDeterminerTask | ||
| ##################### | ||
|
|
||
| ``BasePsfDeterminerTask`` registers all PSF determiners with the `psfDeterminerRegistry`. |
There was a problem hiding this comment.
Ah, I see where you got that description from. Unfortunately, that comment is for people writing new PSF determiners, not the description of this one. Try this:
``BasePsfDeterminerTask`` is the base class for PSF determiners: override ``determinePsf`` to implement your algorithm, and register your new Task with ``psfDeterminerRegistry`` to allow it to be used in a pipeline.
| ObjectSizeStarSelectorTask has a debug dictionary with the following boolean keys: | ||
|
|
||
| display | ||
| display = lsstDebug.Info(__name__).display |
There was a problem hiding this comment.
These keys should have the text from the doxygen here instead of the lsstDebug.Info line, e.g. bool; if True display debug information for this one.
| PcaPsfDeterminerTask | ||
| #################### | ||
|
|
||
| ``PcaPsfDeterminerTask`` estimates psf based off of `measurePsfTask`. |
There was a problem hiding this comment.
Try this:
``PcaPsfDeterminerTask`` estimates PSFs of pre-selected likely stars using a PCA decomposition approach.
| ---------- | ||
| exposure : `lsst.afw.Exposure` | ||
| Exposure containing the psf candidates | ||
| psdCandidateList : `lsst.meas.algorithms.PsfCandidate` |
There was a problem hiding this comment.
Type of this is:
`list` [`lsst.meas.algorithms.PsfCandidate`]
| detecting sources and then running them through a star | ||
| selector | ||
| metadata : `str` | ||
| A place to save interesting items |
There was a problem hiding this comment.
Here and above, please end these descriptive sentences with a period (I know they were missing in the original).
|
|
||
| Returns | ||
| ------- | ||
| psf : `lsst.afw.detection.Psf |
There was a problem hiding this comment.
You're missing a backtick at the end, and the description should be "The fit PSF."
| schema : `lsst.afw.table.Schema` | ||
| Schema used for sources; passing a schema allows the determiner | ||
| to reserve a flag field to mark stars used in PSF measurement, | ||
| but some PSF determiners ignore this argument. |
There was a problem hiding this comment.
Oh, I forgot: the __init__ parameters should go in the class docstring, and __init__ has no docstring.
https://developer.lsst.io/python/numpydoc.html#placement-of-class-docstrings
|
Thanks, this looks good. One comment above. Can you please fix Here's the original text for that Task's And you can just reuse the text from the |
No description provided.