PsfWcsSelectImagesTask¶
- class lsst.pipe.tasks.selectImages.PsfWcsSelectImagesTask(config: Config | None = None, *, name: str | None = None, parentTask: Task | None = None, log: logging.Logger | lsst.utils.logging.LsstLogAdapter | None = None)¶
Bases:
WcsSelectImagesTask
Select images using their Wcs and cuts on the PSF properties.
The PSF quality criteria are based on the size and ellipticity residuals from the adaptive second moments of the star and the PSF.
- The criteria are:
the median of the ellipticty residuals.
the robust scatter of the size residuals (using the median absolute deviation).
the robust scatter of the size residuals scaled by the square of the median size.
Methods Summary
Empty (clear) the metadata for this Task and all sub-Tasks.
Get metadata for all tasks.
Get the task name as a hierarchical name including parent task names.
getName
()Get the name of the task.
Get a dictionary of all tasks as a shallow copy.
getValidImageCorners
(imageWcs, imageBox, ...)Return corners or
None
if bad.isValid
(visitSummary, detectorId)Should this ccd be selected based on its PSF shape information.
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, visitSummary)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
- getFullMetadata() 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.
- metadata
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”.
- fullName
- getName() str ¶
Get the name of the task.
- Returns:
- taskName
str
Name of the task.
- taskName
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:
- taskDict
dict
Dictionary containing full task name: task object for the top-level task and all subtasks, sub-subtasks, etc.
- taskDict
- getValidImageCorners(imageWcs, imageBox, patchPoly, dataId=None)¶
Return corners or
None
if bad.- Parameters:
- imageWcs
Unknown
- imageBox
Unknown
- patchPoly
Unknown
- dataId
Unknown
- imageWcs
- isValid(visitSummary, detectorId)¶
Should this ccd be selected based on its PSF shape information.
- Parameters:
- visitSummary
lsst.afw.table.ExposureCatalog
Exposure catalog with per-detector summary information.
- detectorId
int
Detector identifier.
- visitSummary
- Returns:
- valid
bool
True if selected.
- valid
- classmethod makeField(doc: str) ConfigurableField ¶
Make a
lsst.pex.config.ConfigurableField
for this task.- Parameters:
- doc
str
Help text for the field.
- doc
- Returns:
- configurableField
lsst.pex.config.ConfigurableField
A
ConfigurableField
for this task.
- configurableField
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:
- 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
.
- name
Notes
The subtask must be defined by
Task.config.name
, an instance ofConfigurableField
orRegistryField
.
- run(wcsList, bboxList, coordList, visitSummary, dataIds=None, **kwargs)¶
Return indices of provided lists that meet the selection criteria.
- Parameters:
- wcsList
list
[lsst.afw.geom.SkyWcs
] Specifying the WCS’s of the input ccds to be selected.
- bboxList
list
[lsst.geom.Box2I
] Specifying the bounding boxes of the input ccds to be selected.
- coordList
list
[lsst.geom.SpherePoint
] ICRS coordinates specifying boundary of the patch.
- visitSummary
list
[lsst.afw.table.ExposureCatalog
] containing the PSF shape information for the input ccds to be selected.
- dataIdsiterable [
lsst.daf.butler.dataId
] orNone
, optional An iterable object of dataIds which point to reference catalogs.
- **kwargs
Additional keyword arguments.
- wcsList
- Returns: