SkyObjectsTask¶
- class lsst.meas.algorithms.SkyObjectsTask(schema=None, **kwargs)¶
Bases:
Task
Generate a list of Footprints of sky sources/objects (regions on the sky that do not otherwise have detections).
- Parameters:
- schema
lsst.afw.table.Schema
Schema used to create the output
SourceCatalog
, updated with fields that will be written by this task.
- schema
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.
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
(mask, seed[, catalog])Generate a list of Footprints of sky sources/objects.
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
- 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(mask, seed, catalog=None)¶
Generate a list of Footprints of sky sources/objects.
Sky objects don’t overlap with other objects. This is determined through the provided
mask
(in which objects are typically flagged asDETECTED
).Sky objects are positioned using a quasi-random Halton sequence number generator. This is a deterministic sequence that mimics a random trial and error approach whilst acting to minimize clustering of points for a given field of view. Up to
nTrialSources
points are generated, returning the firstnSources
that do not overlap with the mask.- Parameters:
- mask
lsst.afw.image.Mask
Input mask plane, which identifies pixels to avoid for the sky objects.
- seed
int
Random number generator seed.
- catalog
lsst.afw.table.SourceCatalog
, optional Catalog to add detected footprints to; modified in-place if any sky source/object footprints are created.
- mask
- Returns:
- skyFootprints
list
oflsst.afw.detection.Footprint
Footprints of sky objects. Each will have a peak at the center of the sky object.
- skyFootprints