BaseStarSelectorTask¶
- class lsst.meas.algorithms.BaseStarSelectorTask(schema, **kwds)¶
Bases:
Task
Base class for star selectors
- Register all star selectors with the starSelectorRegistry using:
starSelectorRegistry.register(name, class)
Attributes Summary
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
(exposure, sourceCat[, matches, isStarField])Select stars and set a flag field True for stars in the input catalog.
selectStars
(exposure, sourceCat[, matches])Return a catalog of stars: a subset of sourceCat whose records are shallow copies
timer
(name[, logLevel])Context manager to log performance data for an arbitrary block of code.
Attributes Documentation
- usesMatches = False¶
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(exposure, sourceCat, matches=None, isStarField=None)¶
Select stars and set a flag field True for stars in the input catalog.
- Parameters:
- exposure
lsst.afw.image.Exposure
the exposure containing the sources
- sourceCat
lsst.afw.table.SourceCatalog
catalog of sources that may be stars
- matches
lsst.afw.table.ReferenceMatchVector
or None astrometric matches; ignored by this star selector. Some star selectors will ignore this argument, others may require it. See the usesMatches class variable.
- isStarField
str
name of flag field to set True for stars, or None to not set a field; the field is left unchanged for non-stars
- exposure
- Returns:
- struct
lsst.pipe.base.Struct
- Result struct containing:
- starCat catalog of stars that were selected as stars and successfuly made into PSF candidates
(a subset of sourceCat whose records are shallow copies)
- struct
- abstract selectStars(exposure, sourceCat, matches=None)¶
Return a catalog of stars: a subset of sourceCat whose records are shallow copies
- Parameters:
- exposure
lsst.afw.image.Exposure
The exposure containing the sources.
- sourceCat
lsst.afw.table.SourceCatalog
Catalog of sources that may be stars.
- matches
lsst.afw.table.ReferenceMatchVector
or None astrometric matches; ignored by this star selector. Some star selectors will ignore this argument, others may require it. See the usesMatches class variable.
- exposure
- Returns:
- struct
lsst.pipe.base.Struct
Result
Struct
containing:starCat
Catalog of stars that were selected as stars and successfuly made into PSF candidates (a subset of sourceCat whose records are shallow copies). (
lsst.afw.table.SourceCatalog
)
- struct
Notes
Warning: The returned catalog must have records that are shallow copies (fortunately this is the default behavior when you add a record from one catalog to another); otherwise the run method cannot set the isStarField flag in the original source catalog.