lsst.meas.algorithms g728939a55c+71a2f45ad6
Loading...
Searching...
No Matches
Public Member Functions | 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

 run (self, mask, seed)
 

Static Public Attributes

 ConfigClass = SkyObjectsConfig
 

Detailed Description

Generate a list of Footprints of sky objects.

Definition at line 100 of file skyObjects.py.

Member Function Documentation

◆ run()

lsst.meas.algorithms.skyObjects.SkyObjectsTask.run (   self,
  mask,
  seed 
)
Generate a list of Footprints of sky 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.

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 105 of file skyObjects.py.

Member Data Documentation

◆ ConfigClass

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

Definition at line 103 of file skyObjects.py.


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