RepairTask

class lsst.pipe.tasks.repair.RepairTask(**kwargs)

Bases: lsst.pipe.base.Task

Repair an exposures defects and cosmic rays via interpolation.

This task operates on an lsst.afw.image.Exposure in place to interpolate over a set of Defect objects.

It will also, optionally, find and interpolate any cosmic rays in the lsst.afw.image.Exposure.

Notes

Debugging: The available debug variables in RepairTask are:

display :
A dictionary containing debug point names as keys with frame number as value. Valid keys are:
repair.before :
display image before any repair is done
repair.after :
display image after cosmic ray and defect correction
displayCR :
If True, display the exposure on ds9’s frame 1 and overlay bounding boxes around detects CRs.

To investigate the pipe_tasks_repair_Debug, put something like

import lsstDebug
def DebugInfo(name):
    di = lsstDebug.getInfo(name)        # N.b. lsstDebug.Info(name) would call us recursively
    if name == "lsst.pipe.tasks.repair":
        di.display = {'repair.before':2, 'repair.after':3}
        di.displayCR = True
    return di

lsstDebug.Info = DebugInfo into your debug.py file and run runRepair.py with the –debug flag.

Conversion notes:
Display code should be updated once we settle on a standard way of controlling what is displayed.

Methods Summary

cosmicRay(exposure[, keepCRs]) Mask cosmic rays.
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(exposure[, defects, keepCRs]) Repair an Exposure’s defects and cosmic rays.
timer(name, logLevel) Context manager to log performance data for an arbitrary block of code.

Methods Documentation

cosmicRay(exposure, keepCRs=None)

Mask cosmic rays.

Parameters:
exposure : lsst.afw.image.Exposure

Exposure to process.

keepCRs : Unknown or None, optional

Don’t interpolate over the CR pixels (defer to pex_config if None).

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(exposure, defects=None, keepCRs=None)

Repair an Exposure’s defects and cosmic rays.

Parameters:
exposure : lsst.afw.image.Exposure

Exposure must have a valid Psf. Modified in place.

defects : lsst.meas.algorithms.DefectListT or None, optional

If None, do no defect correction.

keepCRs : Unknown or None, optional

Don’t interpolate over the CR pixels (defer to RepairConfig if None).

Raises:
AssertionError

Raised if any of the following occur: - No exposure provided. - The object provided as exposure evaluates to False. - No PSF provided. - The Exposure has no associated Psf.

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