SkyObjectsTask#
- class lsst.meas.algorithms.SkyObjectsTask(schema=None, **kwargs)#
Bases:
TaskGenerate 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
SourceCatalog, updated with fields that will be written by this task.
Methods Summary
run(mask, seed[, catalog])Generate a list of Footprints of sky sources/objects.
Methods Documentation
- run(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 asDETECTED).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
nTrialSourcespoints are generated, returning the firstnSourcesthat 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
listoflsst.afw.detection.Footprint Footprints of sky objects. Each will have a peak at the center of the sky object.
- mask
- schema