From 03e5b4312ab4db604841824a05d44fb44138c87d Mon Sep 17 00:00:00 2001 From: Meredith Rawls Date: Fri, 8 Nov 2024 00:46:44 -0800 Subject: [PATCH] Clarify nVisitsMin docstring in good seeing selector --- python/lsst/pipe/tasks/selectImages.py | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/python/lsst/pipe/tasks/selectImages.py b/python/lsst/pipe/tasks/selectImages.py index 6274199c3..97538df9d 100644 --- a/python/lsst/pipe/tasks/selectImages.py +++ b/python/lsst/pipe/tasks/selectImages.py @@ -647,8 +647,14 @@ class BestSeeingQuantileSelectVisitsConfig(pipeBase.PipelineTaskConfig, max=1, ) nVisitsMin = pexConfig.Field( - doc="At least this number of visits selected and supercedes quantile. For example, if 10 visits " - "cover this patch, qMin=0.33, and nVisitsMin=5, the best 5 visits will be selected.", + doc="The minimum number of visits to select, if qMin and qMax alone would have " + "selected fewer. In regimes with many visits, at least this number of visits will be " + "selected, superceding quantile when necessary. " + "For example, if 10 visits cover this patch, qMin=0, qMax=0.33, and nVisitsMin=5, " + "the best 5 visits will be selected, even though 5 > 0.33*10. " + "In regimes with few visits, all available visits will be selected. " + "For example, if 2 visits cover this patch and nVisitsMin=12, " + "both visits will be selected regardless of qMin and qMax.", dtype=int, default=6, )