HealSparseInputMapTask

class lsst.pipe.tasks.healSparseMapping.HealSparseInputMapTask(**kwargs)

Bases: lsst.pipe.base.Task

Task for making a HealSparse input map.

Methods Summary

build_ccd_input_map(bbox, wcs, ccds)	Build a map from ccd valid polygons or bounding boxes.
emptyMetadata()	Empty (clear) the metadata for this Task and all sub-Tasks.
finalize_ccd_input_map_mask()	Use accumulated mask information to finalize the masking of ccd_input_map.
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.
mask_warp_bbox(bbox, visit, mask, bit_mask_value)	Mask a subregion from a visit.
timer(name, logLevel)	Context manager to log performance data for an arbitrary block of code.

Methods Documentation

build_ccd_input_map(bbox, wcs, ccds)

Build a map from ccd valid polygons or bounding boxes.

Parameters:

bbox : lsst.geom.Box2I

Bounding box for region to build input map.

wcs : lsst.afw.geom.SkyWcs

WCS object for region to build input map.

ccds : lsst.afw.table.ExposureCatalog

Exposure catalog with ccd data from coadd inputs.

emptyMetadata() → None

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

finalize_ccd_input_map_mask()

Use accumulated mask information to finalize the masking of ccd_input_map.

Raises:

RuntimeError : Raised if build_ccd_input_map was not run first.

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.

mask_warp_bbox(bbox, visit, mask, bit_mask_value)

Mask a subregion from a visit. This must be run after build_ccd_input_map initializes the overall map.

Parameters:

bbox : lsst.geom.Box2I

Bounding box from region to mask.

visit : int

Visit number corresponding to warp with mask.

mask : lsst.afw.image.MaskX

Mask plane from warp exposure.

bit_mask_value : int

Bit mask to check for bad pixels.

Raises:

RuntimeError : Raised if build_ccd_input_map was not run first.

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