lsst.meas.algorithms  22.0.1-30-gce6e836d+2b30200b45
Classes | Functions
lsst.meas.algorithms.skyObjects Namespace Reference

Classes

class  SkyObjectsConfig
 
class  SkyObjectsTask
 

Functions

def generateSkyObjects (mask, seed, config)
 

Function Documentation

◆ generateSkyObjects()

def lsst.meas.algorithms.skyObjects.generateSkyObjects (   mask,
  seed,
  config 
)
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.
config : `SkyObjectsConfig`
    Configuration for finding sky objects.

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