ScarletDeblendTask

class lsst.meas.extensions.scarlet.ScarletDeblendTask(schema, peakSchema=None, **kwargs)

Bases: lsst.pipe.base.Task

Split blended sources into individual sources.

This task has no return value; it only modifies the SourceCatalog in-place.

Methods Summary

deblend(mExposure, catalog) Deblend a data cube of multiband images
emptyMetadata() Empty (clear) the metadata for this Task and all sub-Tasks.
getFullMetadata() Get metadata for all tasks.
getFullName() Get the task name as a hierarchical name including parent task names.
getName() Get the name of the task.
getTaskDict() Get a dictionary of all tasks as a shallow copy.
makeField(doc) Make a lsst.pex.config.ConfigurableField for this task.
makeSubtask(name, **keyArgs) Create a subtask as a new instance as the name attribute of this task.
run(mExposure, mergedSources) Get the psf from each exposure and then run deblend().
setSkipFlags(mExposure, catalog) Set the skip flags for all of the parent sources
timer(name, logLevel) Context manager to log performance data for an arbitrary block of code.

Methods Documentation

deblend(mExposure, catalog)

Deblend a data cube of multiband images

Parameters:
mExposure : MultibandExposure

The exposures should be co-added images of the same shape and region of the sky.

catalog : SourceCatalog

The merged SourceCatalog that contains parent footprints to (potentially) deblend. The new deblended sources are appended to this catalog in place.

Returns:
catalogs : dict or None

Keys are the names of the filters and the values are lsst.afw.table.source.source.SourceCatalog’s. These are catalogs with heavy footprints that are the templates created by the multiband templates.

emptyMetadata() → None

Empty (clear) the metadata for this Task and all sub-Tasks.

getFullMetadata() → lsst.pipe.base._task_metadata.TaskMetadata

Get metadata for all tasks.

Returns:
metadata : TaskMetadata

The keys are the full task name. Values are metadata for the top-level task and all subtasks, sub-subtasks, etc.

Notes

The returned metadata includes timing information (if @timer.timeMethod is used) and any metadata set by the task. The name of each item consists of the full task name with . replaced by :, followed by . and the name of the item, e.g.:

topLevelTaskName:subtaskName:subsubtaskName.itemName

using : in the full task name disambiguates the rare situation that a task has a subtask and a metadata item with the same name.

getFullName() → str

Get the task name as a hierarchical name including parent task names.

Returns:
fullName : str

The full name consists of the name of the parent task and each subtask separated by periods. For example:

  • The full name of top-level task “top” is simply “top”.
  • The full name of subtask “sub” of top-level task “top” is “top.sub”.
  • The full name of subtask “sub2” of subtask “sub” of top-level task “top” is “top.sub.sub2”.
getName() → str

Get the name of the task.

Returns:
taskName : str

Name of the task.

See also

getFullName
getTaskDict() → Dict[str, weakref.ReferenceType[lsst.pipe.base.task.Task]]

Get a dictionary of all tasks as a shallow copy.

Returns:
taskDict : dict

Dictionary containing full task name: task object for the top-level task and all subtasks, sub-subtasks, etc.

classmethod makeField(doc: str) → lsst.pex.config.configurableField.ConfigurableField

Make a lsst.pex.config.ConfigurableField for this task.

Parameters:
doc : str

Help text for the field.

Returns:
configurableField : lsst.pex.config.ConfigurableField

A ConfigurableField for this task.

Examples

Provides a convenient way to specify this task is a subtask of another task.

Here is an example of use:

class OtherTaskConfig(lsst.pex.config.Config):
    aSubtask = ATaskClass.makeField("brief description of task")
makeSubtask(name: str, **keyArgs) → None

Create a subtask as a new instance as the name attribute of this task.

Parameters:
name : str

Brief name of the subtask.

keyArgs

Extra keyword arguments used to construct the task. The following arguments are automatically provided and cannot be overridden:

  • “config”.
  • “parentTask”.

Notes

The subtask must be defined by Task.config.name, an instance of ConfigurableField or RegistryField.

run(mExposure, mergedSources)

Get the psf from each exposure and then run deblend().

Parameters:
mExposure : MultibandExposure

The exposures should be co-added images of the same shape and region of the sky.

mergedSources : SourceCatalog

The merged SourceCatalog that contains parent footprints to (potentially) deblend.

Returns:
templateCatalogs: dict

Keys are the names of the filters and the values are lsst.afw.table.source.source.SourceCatalog’s. These are catalogs with heavy footprints that are the templates created by the multiband templates.

setSkipFlags(mExposure, catalog)

Set the skip flags for all of the parent sources

This is mostly used for testing which parent sources will be deblended and which will be skipped based on the current configuration options. Skipped sources will have the appropriate flags set in place in the catalog.

Parameters:
mExposure : MultibandExposure

The exposures should be co-added images of the same shape and region of the sky.

catalog : SourceCatalog

The merged SourceCatalog that contains parent footprints to (potentially) deblend. The new deblended sources are appended to this catalog in place.

timer(name: str, logLevel: int = 10) → Iterator[None]

Context manager to log performance data for an arbitrary block of code.

Parameters:
name : str

Name of code being timed; data will be logged using item name: Start and End.

logLevel

A logging level constant.

See also

timer.logInfo

Examples

Creating a timer context:

with self.timer("someCodeToTime"):
    pass  # code to time