lsst.meas.algorithms  20.0.0-3-gbdbfa727+3
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

def run (self, mask, seed)
 

Static Public Attributes

 ConfigClass = SkyObjectsConfig
 

Detailed Description

Definition at line 94 of file skyObjects.py.

Member Function Documentation

◆ run()

def 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`).

The algorithm for determining sky objects is random trial and error:
we try up to `nTrialSkySources` random positions to find `nSources`
sky objects.

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

Member Data Documentation

◆ ConfigClass

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

Definition at line 95 of file skyObjects.py.


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