MaskObjectsTask¶
- class lsst.pipe.tasks.background.MaskObjectsTask(*args, **kwargs)¶
Bases:
Task
Iterative masking of objects on an Exposure
This task makes more exhaustive object mask by iteratively doing detection and background-subtraction. The purpose of this task is to get true background removing faint tails of large objects. This is useful to get a clean sky estimate from relatively small number of visits.
We deliberately use the specified
detectSigma
instead of the PSF, in order to better pick up the faint wings of objects.Methods Summary
Empty (clear) the metadata for this Task and all sub-Tasks.
findObjects
(exposure)Iteratively find objects on an exposure
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.removeObjects
(exposure[, maskPlanes])Remove objects from exposure
run
(exposure[, maskPlanes])Mask objects on Exposure
timer
(name[, logLevel])Context manager to log performance data for an arbitrary block of code.
Methods Documentation
- findObjects(exposure)¶
Iteratively find objects on an exposure
Objects are masked with the
DETECTED
mask plane.- Parameters:
- exposure
lsst.afw.image.Exposure
Exposure on which to mask objects.
- exposure
- 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
.
- removeObjects(exposure, maskPlanes=None)¶
Remove objects from exposure
We interpolate over using a background model if
doInterpolate
is set; otherwise we simply replace everything with the median.- Parameters:
- exposure
lsst.afw.image.Exposure
Exposure on which to mask objects.
- maskPlanesiterable of
str
, optional List of mask planes to remove.
DETECTED
will be added as well.
- exposure
- run(exposure, maskPlanes=None)¶
Mask objects on Exposure
Objects are found and removed.
- Parameters:
- exposure
lsst.afw.image.Exposure
Exposure on which to mask objects.
- maskPlanesiterable of
str
, optional List of mask planes to remove.
- exposure