PropagateSourceFlagsTask

class lsst.pipe.tasks.propagateSourceFlags.PropagateSourceFlagsTask(schema, **kwargs)

Bases: Task

Task to propagate source flags to coadd objects.

Flagged sources may come from a mix of two different types of source catalogs. The source_table catalogs from CalibrateTask contain flags for the first round of astromety/photometry/psf fits. The finalized_source_table catalogs from FinalizeCalibrationTask contain flags from the second round of psf fitting.

Methods Summary

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(coadd_object_cat, ccd_inputs[, ...])	Propagate flags from single-frame sources to coadd objects.
timer(name[, logLevel])	Context manager to log performance data for an arbitrary block of code.

Methods Documentation

emptyMetadata() → None

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

getFullMetadata() → TaskMetadata

Get metadata for all tasks.

Returns:

metadataTaskMetadata

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:

fullNamestr

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:

taskNamestr

Name of the task.

See also

getFullName

Get the full name of the task.

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

Get a dictionary of all tasks as a shallow copy.

Returns:

taskDictdict

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

classmethod makeField(doc: str) → ConfigurableField

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

Parameters:

docstr

Help text for the field.

Returns:

configurableFieldlsst.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: Any) → None

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

Parameters:

namestr

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(coadd_object_cat, ccd_inputs, source_table_handle_dict=None, finalized_source_table_handle_dict=None)

Propagate flags from single-frame sources to coadd objects.

Flags are only propagated if a configurable percentage of the sources are matched to the coadd objects. This task will match both “plain” source flags and “finalized” source flags.

Parameters:

coadd_object_catlsst.afw.table.SourceCatalog

Table of coadd objects.

ccd_inputslsst.afw.table.ExposureCatalog

Table of single-frame inputs to coadd.

source_table_handle_dictdict [int: lsst.daf.butler.DeferredDatasetHandle]

Dict for sourceTable_visit handles (key is visit). May be None if config.source_flags has no entries.

finalized_source_table_handle_dictdict [int:

lsst.daf.butler.DeferredDatasetHandle]

Dict for finalized_src_table handles (key is visit). May be None if config.finalized_source_flags has no entries.

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

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

Parameters:

namestr

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

logLevelint

A logging level constant.

See also

lsst.utils.timer.logInfo

Implementation function.

Examples

Creating a timer context:

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