lsst.meas.extensions.multiprofit

lsst.meas.extensions.multiprofit implements separate tasks for PSF and source model fitting using lsst.multiprofit. The tasks depend on more generic lsst.pipe.tasks.PipelineTask classes defined in lsst.pipe.tasks.fit_coadd_psf and lsst.pipe.tasks.fit_coadd_multiband. Both of the PSF and source model-fitting tasks operate row-by-row on single deblended objects from direct coadds. Tickets such as DM-42968 may add additional functionality like multi-object fitting and initializing models from previous fit parameters.

Because these tasks produce per-patch Arrow/Astropy tables, a generic task to consolidate the results into a single multiband tract-based table is provided in lsst.meas.extensions.multiprofit.consolidate_astropy_table. It is anticipated that some of this functionality will be folded into the tasks producing objectTable_tract outputs in lsst.pipe.tasks.postprocess.

Using lsst.meas.extensions.multiprofit

Besides the tasks classes themselves, various conveniently configured subclasses are provided in lsst.meas.extensions.multiprofit.pipetasks_fit, lsst.meas.extensions.multiprofit.pipetasks_match, and lsst.meas.extensions.multiprofit.pipetasks_merge.

Note

While use of these classes is not mandatory, it is recommended since they are standard configurations used in DRP pipelines and, amongst other things, set consistent dataset type names for commonly-used models.

To analyze the outputs, lsst.meas.extensions.multiprofit.analysis_tools provides subclasses of lsst.analysis.tools tools for producing plots and metrics.

lsst.meas.extensions.multiprofit.plots provides functions and classes for visualizing individual blends. lsst.meas.extensions.multiprofit.rebuild_coadd_multiband expands on this functionality with classes that can load and plot images from an entire patch while overlaying relevant model parameters.

Contributing

lsst.meas.extensions.multiprofit is developed at https://github.com/lsst/meas_extensions_multiprofit. You can find Jira issues for this module under the meas_extensions_multiprofit component.

Task reference

Pipeline tasks

No topics.

Command-line tasks

No topics.

Tasks

No topics.

Configurations

No topics.

Python API reference

lsst.meas.extensions.multiprofit.consolidate_astropy_table Module

Classes

CatalogAction(*args, **kw)	Configurable action to return a catalog.
ConfigurableAction(*args, **kw)	A ConfigurableAction is an interface that extends a lsst.pex.config.Config class to include a __call__ method.
ConfigurableActionField(doc[, dtype, ...])	ConfigurableActionField is a subclass of Field that allows a single ConfigurableAction (or a subclass) to be assigned to it.
ConsolidateAstropyTableConfig(*args, **kw)	PipelineTaskConfig for ConsolidateAstropyTableTask.
ConsolidateAstropyTableConfigBase(*args, **kw)	Config for ConsolidateAstropyTableTask.
ConsolidateAstropyTableConnections(*[, config])	Connections for ConsolidateAstropyTableTask.
ConsolidateAstropyTableTask(*[, config, ...])	Write patch-merged astropy tables to a tract-level astropy table.
InputConfig(*args, **kw)	Config for inputs to ConsolidateAstropyTableTask.
MergeMultibandFluxes(*args, **kw)	Configurable action to merge single-band flux tables into one.
defaultdict	defaultdict(default_factory=None, /, [...]) --> dict with default factory

lsst.meas.extensions.multiprofit.fit_coadd_multiband Module

Classes

Any(*args, **kwargs)	Special type indicating an unconstrained type.
CatalogExposurePsfs(*, dataId, catalog, ...)	Input data from lsst pipelines, parsed for MultiProFit.
CatalogExposureSourcesABC()	Interface for a CatalogExposure for source modelling.
CatalogPsfFitterConfig(*args, **kw)	Configuration for MultiProFit PSF image fitter.
CatalogPsfFitterConfigData(*, config)	A PSF fit configuration that can initialize models and images thereof.
CatalogSourceFitterABC(*, errors_expected, ...)	Fit a Gaussian mixture source model to an image with a PSF model.
CatalogSourceFitterConfig(*args, **kw)	Configuration for the MultiProFit profile fitter.
CatalogSourceFitterConfigData(*, channels, ...)	Configuration data for a fitter that can initialize lsst.gauss2d.fit models and images thereof.
ConfigurableAction(*args, **kw)	A ConfigurableAction is an interface that extends a lsst.pex.config.Config class to include a __call__ method.
ConfigurableActionField(doc[, dtype, ...])	ConfigurableActionField is a subclass of Field that allows a single ConfigurableAction (or a subclass) to be assigned to it.
IsParentError	RuntimeError for objects that are parents and shouldn't be fit.
MultiProFitSourceConfig(*args, **kw)	Configuration for the MultiProFit profile fitter.
MultiProFitSourceFitter(wcs, ...)	A MultiProFit source fitter.
MultiProFitSourceTask(**kwargs)	Run MultiProFit on Exposure/SourceCatalog pairs in multiple bands.
NoDataError	RuntimeError for when there is no data to fit.
NotPrimaryError	RuntimeError for objects that are not primary and shouldn't be fit.
PsfComponentsActionBase(*args, **kw)	Base action to return a list of Gaussians from a source mapping.
PsfFitSuccessActionBase(*args, **kw)	Base action to return whether a source had a succesful PSF fit.
PsfRebuildFitFlagError	RuntimeError for when a PSF can't be rebuilt because the fit failed.
SourceTablePsfComponentsAction(*args, **kw)	Action to return PSF components from a SourceTable.
SourceTablePsfFitSuccessAction(*args, **kw)	Action to return PSF fit status from a SourceTable row.
Table([data, masked, names, dtype, meta, ...])	A class to represent tables of heterogeneous data.
cached_property(func)

lsst.meas.extensions.multiprofit.fit_coadd_psf Module

Classes

CatalogPsfFitter([modeller, errors_expected])	Fit a Gaussian mixture model to a pixelated PSF image.
CatalogPsfFitterConfig(*args, **kw)	Configuration for MultiProFit PSF image fitter.
CatalogPsfFitterConfigData(*, config)	A PSF fit configuration that can initialize models and images thereof.
ComponentGroupConfig(*args, **kw)	Configuration for a group of lsst.gauss2d.fit Components.
FluxFractionParameterConfig(*args, **kw)	Configuration for flux fraction parameters (ProperFractionParameterD).
FluxParameterConfig(*args, **kw)	Configuration for flux parameters (IntegralParameterD).
GaussianComponentConfig(*args, **kw)	Configuration for an lsst.gauss2d.fit Gaussian component.
InvalidPsfError(arg, *args, **kwds)
IsParentError	RuntimeError for objects that are parents and shouldn't be fit.
MultiProFitPsfConfig(*args, **kw)	Configuration for the MultiProFit Gaussian mixture PSF fitter.
MultiProFitPsfTask(**kwargs)	Fit a Gaussian mixture PSF model at cataloged locations.
ParameterConfig(*args, **kw)	Configuration for a parameter.
SourceConfig(*args, **kw)	Configuration for an lsst.gauss2d.fit Source.