WcsSelectImagesTask

class lsst.pipe.tasks.selectImages.WcsSelectImagesTask(config: Config | None = None, *, name: str | None = None, parentTask: Task | None = None, log: logging.Logger | lsst.utils.logging.LsstLogAdapter | None = None)

Bases: BaseSelectImagesTask

Select images using their Wcs.

We use the “convexHull” method of lsst.sphgeom.ConvexPolygon to define polygons on the celestial sphere, and test the polygon of the patch for overlap with the polygon of the image.

We use “convexHull” instead of generating a ConvexPolygon directly because the standard for the inputs to ConvexPolygon are pretty high and we don’t want to be responsible for reaching them.

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.
getValidImageCorners(imageWcs, imageBox, ...)	Return corners or None if bad.
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(wcsList, bboxList, coordList[, dataIds])	Return indices of provided lists that meet the selection criteria.
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

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.

getValidImageCorners(imageWcs, imageBox, patchPoly, dataId=None)

Return corners or None if bad.

Parameters:

imageWcsUnknown

imageBoxUnknown

patchPolyUnknown

dataIdUnknown

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(wcsList, bboxList, coordList, dataIds=None, **kwargs)

Return indices of provided lists that meet the selection criteria.

Parameters:

wcsListlist [lsst.afw.geom.SkyWcs]

Specifying the WCS’s of the input ccds to be selected.

bboxListlist [lsst.geom.Box2I]

Specifying the bounding boxes of the input ccds to be selected.

coordListlist [lsst.geom.SpherePoint]

ICRS coordinates specifying boundary of the patch.

dataIdsiterable [lsst.daf.butler.dataId] or None, optional

An iterable object of dataIds which point to reference catalogs.

**kwargs

Additional keyword arguments.

Returns:

resultlist [int]

The indices of selected ccds.

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.

logLevel

A logging level constant.

See also

lsst.utils.timer.logInfo

Examples

Creating a timer context:

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