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

usesMatches

Methods Summary

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.

getTaskDict()

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

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
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")
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(exposure, sourceCat, matches=None, isStarField=None)

Select stars and set a flag field True for stars in the input catalog.

Parameters:
exposurelsst.afw.image.Exposure

the exposure containing the sources

sourceCatlsst.afw.table.SourceCatalog

catalog of sources that may be stars

matcheslsst.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.

isStarFieldstr

name of flag field to set True for stars, or None to not set a field; the field is left unchanged for non-stars

Returns:
structlsst.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)

abstract selectStars(exposure, sourceCat, matches=None)

Return a catalog of stars: a subset of sourceCat whose records are shallow copies

Parameters:
exposurelsst.afw.image.Exposure

The exposure containing the sources.

sourceCatlsst.afw.table.SourceCatalog

Catalog of sources that may be stars.

matcheslsst.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.

Returns:
structlsst.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)

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.

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.

See also

timer.logInfo

Examples

Creating a timer context:

with self.timer("someCodeToTime"):
    pass  # code to time