BestSeeingQuantileSelectVisitsTask¶

class lsst.pipe.tasks.selectImages.BestSeeingQuantileSelectVisitsTask(*, config: PipelineTaskConfig | None = None, log: logging.Logger | LsstLogAdapter | None = None, initInputs: Dict[str, Any] | None = None, **kwargs: Any)¶

Bases: BestSeeingSelectVisitsTask

Select a quantile of the best-seeing visits.

Selects the best (for example, third) full visits based on the average PSF width in the entire visit. It can also be used for difference imaging experiments that require templates with the worst seeing visits. For example, selecting the worst third can be acheived by changing the config parameters qMin to 0.66 and qMax to 1.

Attributes Summary

canMultiprocess

Methods Summary

`doesIntersectPolygon`(visitSummary, polygon)	Return True if sky polygon overlaps visit.
`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.
`getResourceConfig`()	Return resource configuration for this task.
`getTaskDict`()	Get a dictionary of all tasks as a shallow copy.
`makeField`(doc)	Make a `lsst.pex.config.ConfigurableField` for this task.
`makePatchPolygon`(skyMap, dataId)	Return True if sky polygon overlaps visit.
`makeSubtask`(name, **keyArgs)	Create a subtask as a new instance as the `name` attribute of this task.
`run`(visitSummaries, skyMap, dataId)	Run task.
`runQuantum`(butlerQC, inputRefs, outputRefs)	Method to do butler IO and or transforms 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

canMultiprocess: ClassVar[bool] = True¶

Methods Documentation

doesIntersectPolygon(visitSummary, polygon)¶

Return True if sky polygon overlaps visit.

Parameters:

visitSummarylsst.afw.table.ExposureCatalog: Exposure catalog with per-detector geometry.
polygon :` lsst.sphgeom.ConvexPolygon.convexHull`: Polygon to check overlap.

Returns:

doesIntersectbool: True if the visit overlaps the polygon.

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

getResourceConfig() → ResourceConfig | None¶

Return resource configuration for this task.

Returns:

Object of type ResourceConfig or None if resource
configuration is not defined for this task.

getTaskDict() → Dict[str, ReferenceType[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")

makePatchPolygon(skyMap, dataId)¶

Return True if sky polygon overlaps visit.

Parameters:

skyMaplsst.afw.table.ExposureCatalog: Exposure catalog with per-detector geometry.
dataIddict of dataId keys: For retrieving patch info.

Returns:

resultlsst.sphgeom.ConvexPolygon.convexHull: Polygon of patch’s outer bbox.

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(visitSummaries, skyMap, dataId)¶

Run task.

Parameters:

visitSummarylist [lsst.pipe.base.connections.DeferredDatasetRef]: List of lsst.pipe.base.connections.DeferredDatasetRef of visitSummary tables of type lsst.afw.table.ExposureCatalog.
skyMaplsst.skyMap.SkyMap: SkyMap for checking visits overlap patch.
dataIddict of dataId keys: For retrieving patch info for checking visits overlap patch.

Returns:

resultlsst.pipe.base.Struct

Results as a struct with attributes:

goodVisits: A dict with selected visit ids as keys, so that it can be be saved as a StructuredDataDict. StructuredDataList’s are currently limited.

runQuantum(butlerQC, inputRefs, outputRefs)¶

Method to do butler IO and or transforms to provide in memory objects for tasks run method

Parameters:

butlerQCButlerQuantumContext: A butler which is specialized to operate in the context of a lsst.daf.butler.Quantum.
inputRefsInputQuantizedConnection: Datastructure whose attribute names are the names that identify connections defined in corresponding PipelineTaskConnections class. The values of these attributes are the lsst.daf.butler.DatasetRef objects associated with the defined input/prerequisite connections.
outputRefsOutputQuantizedConnection: Datastructure whose attribute names are the names that identify connections defined in corresponding PipelineTaskConnections class. The values of these attributes are the lsst.daf.butler.DatasetRef objects associated with the defined output connections.

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.

Navigation

BestSeeingQuantileSelectVisitsTask¶