UpdateVisitSummaryTask¶
- class lsst.drp.tasks.update_visit_summary.UpdateVisitSummaryTask(*, initInputs: dict[str, Any] | None = None, **kwargs: Any)¶
Bases:
PipelineTask
A pipeline task that creates a new visit-summary table after all
lsst.afw.image.Exposure
components have been finalized.Notes
This task is designed to be run just prior to making warps for coaddition, as it aggregates all inputs other than the images and backgrounds into a single
ExposureCatalog
dataset and recomputes summary statistics that are useful in selecting which images should go into a coadd. Its output can also be used to reconstruct a final processed visit image when combined with a post-ISR image, the background model, and the final mask.Attributes Summary
Methods Summary
Empty (clear) the metadata for this Task and all sub-Tasks.
Get metadata for all tasks.
Get the task name as a hierarchical name including parent task names.
getName
()Get the name of the task.
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
(input_summary_catalog, input_exposures)Build an updated version of a visit summary catalog.
runQuantum
(butlerQC, inputRefs, outputRefs)Do butler IO and transform to provide in memory objects for tasks
run
method.timer
(name[, logLevel])Context manager to log performance data for an arbitrary block of code.
Attributes Documentation
Methods Documentation
- getFullMetadata() 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.
- metadata
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”.
- fullName
- getName() str ¶
Get the name of the task.
- Returns:
- taskName
str
Name of the task.
- taskName
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:
- taskDict
dict
Dictionary containing full task name: task object for the top-level task and all subtasks, sub-subtasks, etc.
- taskDict
- classmethod makeField(doc: str) ConfigurableField ¶
Make a
lsst.pex.config.ConfigurableField
for this task.- Parameters:
- doc
str
Help text for the field.
- doc
- Returns:
- configurableField
lsst.pex.config.ConfigurableField
A
ConfigurableField
for this task.
- configurableField
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:
- 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
.
- name
Notes
The subtask must be defined by
Task.config.name
, an instance ofConfigurableField
orRegistryField
.
- run(input_summary_catalog: ExposureCatalog, input_exposures: Mapping[int, DeferredDatasetHandle], psf_overrides: ExposureCatalog | None = None, psf_star_catalog: Table | None = None, ap_corr_overrides: ExposureCatalog | None = None, photo_calib_overrides: PossiblyMultipleInput | None = None, wcs_overrides: PossiblyMultipleInput | None = None, background_originals: Mapping[int, DeferredDatasetHandle] | None = None, background_overrides: Mapping[int, DeferredDatasetHandle] | None = None)¶
Build an updated version of a visit summary catalog.
- Parameters:
- input_summary_catalog
lsst.afw.table.ExposureCatalog
Input catalog. Each row in this catalog will be used to produce a row in the output catalog. Any override parameter that is
None
will leave the corresponding values unchanged from those in this input catalog.- input_exposures
collections.abc.Mapping
[int
, Deferred-load objects that fetch
lsst.afw.image.Exposure
instances. Only the image, mask, and variance are used; all other components are assumed to be superceded by at leastinput_summary_catalog
and probably some_overrides
arguments as well. This usually corresponds to thecalexp
dataset.- psf_overrides
lsst.afw.table.ExposureCatalog
, optional Catalog with attached
lsst.afw.detection.Psf
objects that supersede the input catalog’s PSFs.- psf_star_catalog
astropy.table.Table
, optional Table containing PSF stars for use in computing PSF summary statistics. Must be provided if
psf_overrides
is.- ap_corr_overrides
lsst.afw.table.ExposureCatalog
, optional Catalog with attached
lsst.afw.image.ApCorrMap
objects that supersede the input catalog’s aperture corrections.- photo_calib_overrides
PossiblyMultipleInput
, optional Catalog wrappers with attached
lsst.afw.image.PhotoCalib
objects that supersede the input catalog’s photometric calibrations.- wcs_overrides
PossiblyMultipleInput
, optional Catalog wrappers with attached
lsst.afw.geom.SkyWcs
objects that supersede the input catalog’s astrometric calibrations.- background_originals
collections.abc.Mapping
[int
, lsst.daf.butler.DeferredDatasetHandle
], optionalDeferred-load objects that fetch
lsst.afw.math.BackgroundList
instances. These should correspond to the background already subtracted frominput_exposures
. If not provided andbackground_overrides
is, it is assumed that the background ininput_exposures
has not been subtracted. If provided, all keys inbackground_overrides
must also be present inbackground_originals
.- background_overrides
collections.abc.Mapping
[int
, lsst.daf.butler.DeferredDatasetHandle
], optionalDeferred-load objects that fetch
lsst.afw.math.BackgroundList
instances. These should correspond to the background that should now be subtracted from``input_exposures`` to yield the final background-subtracted image.
- input_summary_catalog
- Returns:
- output_summary_catalog
lsst.afw.table.ExposureCatalog
Output visit summary catalog.
- output_summary_catalog
Notes
If any override parameter is provided but does not have a value for a particular detector, that component will be set to
None
in the returned catalog for that detector and all summary statistics derived from that component will be reset (usually toNaN
) as well. Not passing an override parameter at all will instead pass through the original component and values from the input catalog unchanged.
- runQuantum(butlerQC: QuantumContext, inputRefs: InputQuantizedConnection, outputRefs: OutputQuantizedConnection) None ¶
Do butler IO and transform to provide in memory objects for tasks
run
method.- Parameters:
- butlerQC
QuantumContext
A butler which is specialized to operate in the context of a
lsst.daf.butler.Quantum
.- inputRefs
InputQuantizedConnection
Datastructure whose attribute names are the names that identify connections defined in corresponding
PipelineTaskConnections
class. The values of these attributes are thelsst.daf.butler.DatasetRef
objects associated with the defined input/prerequisite connections.- outputRefs
OutputQuantizedConnection
Datastructure whose attribute names are the names that identify connections defined in corresponding
PipelineTaskConnections
class. The values of these attributes are thelsst.daf.butler.DatasetRef
objects associated with the defined output connections.
- butlerQC