lsst.pipe.tasks.fit_coadd_multiband.CoaddMultibandFitBaseConfig Class Reference
Inheritance diagram for lsst.pipe.tasks.fit_coadd_multiband.CoaddMultibandFitBaseConfig:
Public Member Functions | |
| get_band_sets (self) | |
| adjustQuantum (self, inputs, outputs, label, data_id) | |
Static Public Attributes | |
| allow_missing_bands | |
| drop_psf_connection | |
| fit_coadd_multiband | |
| use_cell_coadds | |
| idGenerator = SkyMapIdGeneratorConfig.make_field() | |
| image_type | |
| cat_ref | |
| cats_meas | |
| coadds | |
| coadds_cell | |
| backgrounds | |
| models_psf | |
| models_scarlet | |
Detailed Description
Base class for multiband fitting.
Definition at line 301 of file fit_coadd_multiband.py.
Member Function Documentation
◆ adjustQuantum()
|
inherited |
Validates the `lsst.daf.butler.DatasetRef` bands against the
subtask's list of bands to fit and drops unnecessary bands.
Parameters
----------
inputs : `dict`
Dictionary whose keys are an input (regular or prerequisite)
connection name and whose values are a tuple of the connection
instance and a collection of associated `DatasetRef` objects.
The exact type of the nested collections is unspecified; it can be
assumed to be multi-pass iterable and support `len` and ``in``, but
it should not be mutated in place. In contrast, the outer
dictionaries are guaranteed to be temporary copies that are true
`dict` instances, and hence may be modified and even returned; this
is especially useful for delegating to `super` (see notes below).
outputs : `Mapping`
Mapping of output datasets, with the same structure as ``inputs``.
label : `str`
Label for this task in the pipeline (should be used in all
diagnostic messages).
data_id : `lsst.daf.butler.DataCoordinate`
Data ID for this quantum in the pipeline (should be used in all
diagnostic messages).
Returns
-------
adjusted_inputs : `Mapping`
Mapping of the same form as ``inputs`` with updated containers of
input `DatasetRef` objects. All inputs involving the 'band'
dimension are adjusted to put them in consistent order and remove
unneeded bands.
adjusted_outputs : `Mapping`
Mapping of updated output datasets; always empty for this task.
Raises
------
lsst.pipe.base.NoWorkFound
Raised if there are not enough of the right bands to run the task
on this quantum.
Definition at line 113 of file fit_coadd_multiband.py.
◆ get_band_sets()
| lsst.pipe.tasks.fit_coadd_multiband.CoaddMultibandFitBaseConfig.get_band_sets | ( | self | ) |
Get the set of bands required by the fit_coadd_multiband subtask.
Returns
-------
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.
Definition at line 342 of file fit_coadd_multiband.py.
Member Data Documentation
◆ allow_missing_bands
|
static |
Initial value:
= pexConfig.Field[bool](
doc="Whether to still fit even if some bands are missing",
default=True,
)
Definition at line 307 of file fit_coadd_multiband.py.
◆ backgrounds
|
staticinherited |
Initial value:
= cT.Input(
doc="Background models to subtract from the coadds_cell",
name="{name_coadd}Coadd_calexp_background",
storageClass="Background",
dimensions=("tract", "patch", "band", "skymap"),
multiple=True,
)
Definition at line 90 of file fit_coadd_multiband.py.
◆ cat_ref
|
staticinherited |
Initial value:
= cT.Input(
doc="Reference multiband source catalog",
name="{name_coadd}Coadd_ref",
storageClass="SourceCatalog",
dimensions=("tract", "patch", "skymap"),
)
Definition at line 63 of file fit_coadd_multiband.py.
◆ cats_meas
|
staticinherited |
Initial value:
= cT.Input(
doc="Deblended single-band source catalogs",
name="{name_coadd}Coadd_meas",
storageClass="SourceCatalog",
dimensions=("tract", "patch", "band", "skymap"),
multiple=True,
)
Definition at line 69 of file fit_coadd_multiband.py.
◆ coadds
|
staticinherited |
Initial value:
= cT.Input(
doc="Exposures on which to run fits",
name="{name_coadd}Coadd_calexp",
storageClass="ExposureF",
dimensions=("tract", "patch", "band", "skymap"),
multiple=True,
)
Definition at line 76 of file fit_coadd_multiband.py.
◆ coadds_cell
|
staticinherited |
Initial value:
= cT.Input(
doc="Cell-coadd exposures on which to run fits",
name="{name_coadd}CoaddCell",
storageClass="MultipleCellCoadd",
dimensions=("tract", "patch", "band", "skymap"),
multiple=True,
)
Definition at line 83 of file fit_coadd_multiband.py.
◆ drop_psf_connection
|
static |
Initial value:
= pexConfig.Field[bool](
doc="Whether to drop the PSF model connection, e.g. because PSF parameters are in the input catalog",
default=False,
)
Definition at line 311 of file fit_coadd_multiband.py.
◆ fit_coadd_multiband
|
static |
Initial value:
= pexConfig.ConfigurableField(
target=CoaddMultibandFitSubTask,
doc="Task to fit sources using multiple bands",
)
Definition at line 315 of file fit_coadd_multiband.py.
◆ idGenerator
|
static |
Definition at line 323 of file fit_coadd_multiband.py.
◆ image_type
|
static |
Initial value:
= pexConfig.ChoiceField(
"Which image type to expect for the input coadd. "
"This option only directly affects connection storage classes and hence 'runQuantum'; the 'run' "
"method behavior is determined by which type is actually passed in.",
allowed={
"legacy": (
"Read a lsst.cell_coadds.MultipleCellCoadd via 'coadds_cell` and restore 'background' "
"(if use_cell_coadd) or lsst.afw.image.Exposure via `coadds` (if not use_cell_coadd)."
),
"future": (
"Read lsst.images.cells.CellCoadd via the 'coadds' connection. use_cell_coadd is ignored."
),
},
dtype=str,
optional=False,
default="legacy",
)
Definition at line 324 of file fit_coadd_multiband.py.
◆ models_psf
|
staticinherited |
Initial value:
= cT.Input(
doc="Input PSF model parameter catalog",
# Consider allowing independent psf fit method
name="{name_coadd}Coadd_psfs_{name_method}",
storageClass="ArrowAstropy",
dimensions=("tract", "patch", "band", "skymap"),
multiple=True,
deferLoad=True,
)
Definition at line 97 of file fit_coadd_multiband.py.
◆ models_scarlet
|
staticinherited |
Initial value:
= pipeBase.connectionTypes.Input(
doc="Multiband scarlet models produced by the deblender",
name="{name_coadd}Coadd_scarletModelData",
storageClass="LsstScarletModelData",
dimensions=("tract", "patch", "skymap"),
)
Definition at line 106 of file fit_coadd_multiband.py.
◆ use_cell_coadds
|
static |
Initial value:
= pexConfig.Field[bool](
doc="Use cell coadd images for object fitting?",
default=False,
)
Definition at line 319 of file fit_coadd_multiband.py.
The documentation for this class was generated from the following file:
- python/lsst/pipe/tasks/fit_coadd_multiband.py
Generated on for lsst.pipe.tasks by
1.18.0