lsst.meas.algorithms g0603fd7c41+022847dfd1
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.meas.algorithms.skyObjects.SkyObjectsTask Class Reference
Inheritance diagram for lsst.meas.algorithms.skyObjects.SkyObjectsTask:

Public Member Functions

 __init__ (self, schema=None, **kwargs)
 
 run (self, mask, seed, catalog=None)
 

Public Attributes

 skySourceKey
 

Static Public Attributes

 ConfigClass = SkyObjectsConfig
 

Detailed Description

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 `~lsst.afw.table.SourceCatalog`,
    updated with fields that will be written by this task.

Definition at line 140 of file skyObjects.py.

Constructor & Destructor Documentation

◆ __init__()

lsst.meas.algorithms.skyObjects.SkyObjectsTask.__init__ ( self,
schema = None,
** kwargs )

Definition at line 153 of file skyObjects.py.

Member Function Documentation

◆ run()

lsst.meas.algorithms.skyObjects.SkyObjectsTask.run ( self,
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
as `DETECTED`).

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 first `nSources` 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.

Returns
-------
skyFootprints : `list` of `lsst.afw.detection.Footprint`
    Footprints of sky objects. Each will have a peak at the center
    of the sky object.

Definition at line 161 of file skyObjects.py.

Member Data Documentation

◆ ConfigClass

lsst.meas.algorithms.skyObjects.SkyObjectsTask.ConfigClass = SkyObjectsConfig
static

Definition at line 151 of file skyObjects.py.

◆ skySourceKey

lsst.meas.algorithms.skyObjects.SkyObjectsTask.skySourceKey

Definition at line 156 of file skyObjects.py.


The documentation for this class was generated from the following file: