lsst.pipe.tasks.fit_multiband.MultibandFitConfig Class Reference

Inheritance diagram for lsst.pipe.tasks.fit_multiband.MultibandFitConfig:

Public Member Functions
def	get_band_sets (self)
def	adjustQuantum (self, datasetRefMap)

Static Public Attributes
	fit_multiband
	cat_ref
	cats_meas
	coadds
	cat_output
	cat_ref_schema
	cat_output_schema

Detailed Description

Configure a MultibandFitTask, including a configurable fitting subtask.

Definition at line 247 of file fit_multiband.py.

Member Function Documentation

adjustQuantum()

def lsst.pipe.tasks.fit_multiband.MultibandFitConnections.adjustQuantum (   self,   datasetRefMap  )

inherited

Validates the `lsst.daf.butler.DatasetRef` bands against the
subtask's list of bands to fit and drops unnecessary bands.

Parameters
----------
datasetRefMap : `NamedKeyDict`
    Mapping from dataset type to a `set` of
    `lsst.daf.butler.DatasetRef` objects

Returns
-------
datasetRefMap : `NamedKeyDict`
    Modified mapping of input with possibly adjusted
    `lsst.daf.butler.DatasetRef` objects.

Raises
------
ValueError
    Raised if any of the per-band datasets have an inconsistent band
    set, or if the band set to fit is not a subset of the data bands.

Definition at line 114 of file fit_multiband.py.

    def adjustQuantum(self, datasetRefMap):
        """Validates the `lsst.daf.butler.DatasetRef` bands against the
        subtask's list of bands to fit and drops unnecessary bands.
 
        Parameters
        ----------
        datasetRefMap : `NamedKeyDict`
            Mapping from dataset type to a `set` of
            `lsst.daf.butler.DatasetRef` objects
 
        Returns
        -------
        datasetRefMap : `NamedKeyDict`
            Modified mapping of input with possibly adjusted
            `lsst.daf.butler.DatasetRef` objects.
 
        Raises
        ------
        ValueError
            Raised if any of the per-band datasets have an inconsistent band
            set, or if the band set to fit is not a subset of the data bands.
 
        """
        datasetRefMap = super().adjustQuantum(datasetRefMap)
        # Check which bands are going to be fit
        bands_fit, bands_read_only = self.config.get_band_sets()
        bands_needed = bands_fit.union(bands_read_only)
 
        bands_data = None
        bands_extra = set()
 
        for type_d, ref_d in datasetRefMap.items():
            # Datasets without bands in their dimensions should be fine
            if 'band' in type_d.dimensions:
                bands_set = {dref.dataId['band'] for dref in ref_d}
                if bands_data is None:
                    bands_data = bands_set
                    if bands_needed != bands_data:
                        if not bands_needed.issubset(bands_data):
                            raise ValueError(
                                f'Datarefs={ref_d} have data with bands in the set={bands_set},'
                                f'which is not a subset of the required bands={bands_needed} defined by '
                                f'{self.config.__class__}.fit_multiband='
                                f'{self.config.fit_multiband._value.__class__}\'s attributes'
                                f' bands_fit={bands_fit} and bands_read_only()={bands_read_only}.'
                                f' Add the required bands={bands_needed.difference(bands_data)}.'
                            )
                        else:
                            bands_extra = bands_data.difference(bands_needed)
                elif bands_set != bands_data:
                    raise ValueError(
                        f'Datarefs={ref_d} have data with bands in the set={bands_set}'
                        f' which differs from the previous={bands_data}); bandsets must be identical.'
                    )
                if bands_extra:
                    for dref in ref_d:
                        if dref.dataId['band'] in bands_extra:
                            ref_d.remove(dref)
        return datasetRefMap
 
 

get_band_sets()

def lsst.pipe.tasks.fit_multiband.MultibandFitConfig.get_band_sets

(

self

)

Get the set of bands required by the fit_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 258 of file fit_multiband.py.

    def get_band_sets(self):
        """Get the set of bands required by the fit_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.
        """
        try:
            bands_fit = self.fit_multiband.bands_fit
        except AttributeError:
            raise RuntimeError(f'{__class__}.fit_multiband must have bands_fit attribute') from None
        bands_read_only = self.fit_multiband.bands_read_only()
        return set(bands_fit), set(bands_read_only)
 
 

Member Data Documentation

cat_output

lsst.pipe.tasks.fit_multiband.MultibandFitConnections.cat_output

staticinherited

Initial value:

=  cT.Output(
        doc="Measurement multi-band catalog",
        name="{name_output_coadd}Coadd_{name_output_cat}",
        storageClass="SourceCatalog",
        dimensions=("tract", "patch", "skymap"),
    )

Definition at line 97 of file fit_multiband.py.

cat_output_schema

lsst.pipe.tasks.fit_multiband.MultibandFitConnections.cat_output_schema

staticinherited

Initial value:

=  cT.InitOutput(
        doc="Output of the schema used in deblending task",
        name="{name_output_coadd}Coadd_{name_output_cat}_schema",
        storageClass="SourceCatalog"
    )

Definition at line 108 of file fit_multiband.py.

cat_ref

lsst.pipe.tasks.fit_multiband.MultibandFitConnections.cat_ref

staticinherited

Initial value:

=  cT.Input(
        doc="Reference multiband source catalog",
        name="{name_input_coadd}Coadd_ref",
        storageClass="SourceCatalog",
        dimensions=("tract", "patch", "skymap"),
    )

Definition at line 77 of file fit_multiband.py.

cat_ref_schema

lsst.pipe.tasks.fit_multiband.MultibandFitConnections.cat_ref_schema

staticinherited

Initial value:

=  cT.InitInput(
        doc="Schema associated with a ref source catalog",
        storageClass="SourceCatalog",
        name="{name_input_coadd}Coadd_ref_schema",
    )

Definition at line 103 of file fit_multiband.py.

cats_meas

lsst.pipe.tasks.fit_multiband.MultibandFitConnections.cats_meas

staticinherited

Initial value:

=  cT.Input(
        doc="Deblended single-band source catalogs",
        name="{name_input_coadd}Coadd_meas",
        storageClass="SourceCatalog",
        multiple=True,
        dimensions=("tract", "patch", "band", "skymap"),
    )

Definition at line 83 of file fit_multiband.py.

coadds

lsst.pipe.tasks.fit_multiband.MultibandFitConnections.coadds

staticinherited

Initial value:

=  cT.Input(
        doc="Exposures on which to run fits",
        name="{name_input_coadd}Coadd_calexp",
        storageClass="ExposureF",
        multiple=True,
        dimensions=("tract", "patch", "band", "skymap"),
    )

Definition at line 90 of file fit_multiband.py.

fit_multiband

lsst.pipe.tasks.fit_multiband.MultibandFitConfig.fit_multiband

static

Initial value:

=  pexConfig.ConfigurableField(
        target=MultibandFitSubTask,
        doc="Task to fit sources using multiple bands",
    )

Definition at line 253 of file fit_multiband.py.

---

The documentation for this class was generated from the following file:

• /j/snowflake/release/lsstsw/stack/0.4.3/Linux64/pipe_tasks/21.0.0-64-g1122c245+4fb2b8f86e/python/lsst/pipe/tasks/fit_multiband.py