CloughTocher2DInterpolateTask¶

Bases: Task

Interpolated over bad pixels using CloughTocher2DInterpolator.

Pixels with mask bits set to any of those listed badMaskPlanes config are considered bad and are interpolated over. All good (non-bad) pixels within interpLength pixels of a bad pixel in either direction are used to construct the interpolant. An extended streak of bad pixels at an edge, longer than interpLength, is set to fillValue` specified in config.

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`(maskedImage[, badpix, goodpix])	Interpolate over bad pixels in a masked image.
`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(maskedImage, badpix: set[tuple[int, int]] | None = None, goodpix: dict | None = None)¶

Interpolate over bad pixels in a masked image.

This modifies the image attribute of the maskedImage in place. This method returns, and accepts, the coordinates of the bad pixels that were interpolated over, and the coordinates and values of the good pixels that were used to construct the interpolant. This avoids having to search for the bad and the good pixels repeatedly when the mask plane is shared among many images, as would be the case with noise realizations.

Parameters:

maskedImageMaskedImage: Image on which to perform interpolation (and modify in-place).
badpix: `set` [`tuple` [`int`, `int`]], optional: The coordinates of the bad pixels to interpolate over. If None, then the coordinates of the bad pixels are determined by an exhaustive search over the image.
goodpix: `dict` [`tuple` [`int`, `int`], `float`], optional: A mapping whose keys are the coordinates of the good pixels around badpix that must be included when constructing the interpolant. If badpix is provided, then the pixels in goodpix are used as to construct the interpolatant. If not, any additional good pixels around internally determined badpix are added to goodpix and used to construct the interpolant. In all cases, the values are populated from the image plane of the maskedImage (provided values will be ignored.

Returns:

badpix: set [tuple [int, int]]: The coordinates of the bad pixels that were interpolated over.
goodpix: dict [tuple [int, int], float]: Mapping of the coordinates of the good pixels around badpix to their values that were included when constructing the interpolant.

Raises:

RuntimeError: If a pixel passed in as goodpix is found to be bad as specified by maskPlanes.
ValueError: If an input badpix is not found to be bad as specified by maskPlanes.

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.

Navigation

CloughTocher2DInterpolateTask¶