Skip to content

Commit

Permalink
Update docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
taranu committed Mar 11, 2021
1 parent 25c8169 commit 1dda923
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions python/lsst/pipe/tasks/fit_multiband.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,11 @@

@dataclass(frozen=True)
class CatalogExposure:
"""A class to store a catalog, exposure, and metadata for a given dataId.
This class is intended to store an exposure and an associated measurement
catalog. There are no checks to ensure this, so repurpose responsibly.
"""
@property
def band(self) -> str:
return self.dataId['band']
Expand Down Expand Up @@ -243,8 +248,7 @@ class MultibandFitConfig(
pipeBase.PipelineTaskConfig,
pipelineConnections=MultibandFitConnections,
):
"""Configuration class for the MultibandFitTask, containing a
configurable subtask that does all fitting.
"""Configure a MultibandFitTask, including a configurable fitting subtask.
"""
fit_multiband = pexConfig.ConfigurableField(
target=MultibandFitSubTask,
Expand All @@ -259,7 +263,8 @@ def get_band_sets(self):
bands_fit : `set`
The set of bands that the subtask will fit.
bands_read_only : `set`
The set of bands that the subtask will only read data (measurement catalog and exposure) for.
The set of bands that the subtask will only read data
(measurement catalog and exposure) for.
"""
try:
bands_fit = self.fit_multiband.bands_fit
Expand All @@ -270,6 +275,12 @@ def get_band_sets(self):


class MultibandFitTask(pipeBase.PipelineTask):
"""Fit deblended exposures in multiple bands simultaneously.
It is generally assumed but not enforced (except optionally by the
configurable `fit_multiband` subtask) that there is only one exposure
per band, presumably a coadd.
"""
ConfigClass = MultibandFitConfig
_DefaultName = "multibandFit"

Expand Down

0 comments on commit 1dda923

Please sign in to comment.