LSST Applications g063fba187b+eddd1b24d7,g0f08755f38+4a855ab515,g1653933729+a8ce1bb630,g168dd56ebc+a8ce1bb630,g1a2382251a+062a45aee3,g1dcb35cd9c+45d3fa5522,g20f6ffc8e0+4a855ab515,g217e2c1bcf+f55e51b560,g28da252d5a+7d8e536cc7,g2bbee38e9b+2d92fc7d83,g2bc492864f+2d92fc7d83,g3156d2b45e+6e55a43351,g32e5bea42b+625186cc6b,g347aa1857d+2d92fc7d83,g35bb328faa+a8ce1bb630,g3a166c0a6a+2d92fc7d83,g3e281a1b8c+c5dd892a6c,g3e8969e208+a8ce1bb630,g414038480c+5927e1bc1e,g41af890bb2+1af189bab1,g7af13505b9+7b6a50a2f8,g80478fca09+6174b7f182,g82479be7b0+5b71efbaf0,g858d7b2824+4a855ab515,g9125e01d80+a8ce1bb630,ga5288a1d22+61618a97c4,gb58c049af0+d64f4d3760,gc28159a63d+2d92fc7d83,gc5452a3dca+f4add4ffd5,gcab2d0539d+d9f5af7f69,gcf0d15dbbd+6c7e0a19ec,gda6a2b7d83+6c7e0a19ec,gdaeeff99f8+1711a396fd,ge79ae78c31+2d92fc7d83,gef2f8181fd+55fff6f525,gf0baf85859+c1f95f4921,gfa517265be+4a855ab515,gfa999e8aa5+17cd334064,w.2024.51
LSST Data Management Base Package
Loading...
Searching...
No Matches
Classes | Functions
lsst.meas.algorithms.skyObjects Namespace Reference

Classes

class  SkyObjectsConfig
 
class  SkyObjectsTask
 

Functions

 generateSkyObjects (mask, seed, config)
 

Function Documentation

◆ generateSkyObjects()

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

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

71def generateSkyObjects(mask, seed, config):
72 """Generate a list of Footprints of sky objects
73
74 Sky objects don't overlap with other objects. This is determined
75 through the provided `mask` (in which objects are typically flagged
76 as `DETECTED`).
77
78 Sky objects are positioned using a quasi-random Halton sequence number
79 generator. This is a deterministic sequence that mimics a random trial and
80 error approach whilst acting to minimize clustering of points for a given
81 field of view. Up to `nTrialSources` points are generated, returning the
82 first `nSources` that do not overlap with the mask.
83
84 Parameters
85 ----------
86 mask : `lsst.afw.image.Mask`
87 Input mask plane, which identifies pixels to avoid for the sky
88 objects.
89 seed : `int`
90 Random number generator seed.
91 config : `SkyObjectsConfig`
92 Configuration for finding sky objects.
93
94 Returns
95 -------
96 skyFootprints : `list` of `lsst.afw.detection.Footprint`
97 Footprints of sky objects. Each will have a peak at the center
98 of the sky object.
99 """
100 if config.nSources <= 0:
101 return []
102
103 skySourceRadius = config.sourceRadius
104 nSkySources = config.nSources
105 nTrialSkySources = config.nTrialSources
106 if nTrialSkySources is None:
107 nTrialSkySources = config.nTrialSourcesMultiplier*nSkySources
108
109 box = mask.getBBox()
110 box.grow(-(int(skySourceRadius) + 1)) # Avoid objects partially off the image
111 xMin, yMin = box.getMin()
112 xMax, yMax = box.getMax()
113
114 avoid = lsst.afw.geom.SpanSet.fromMask(mask, mask.getPlaneBitMask(config.avoidMask))
115 if config.growMask > 0:
116 avoid = avoid.dilated(config.growMask)
117
118 sampler = qmc.Halton(d=2, seed=seed).random(nTrialSkySources)
119 sample = qmc.scale(sampler, [xMin, yMin], [xMax, yMax])
120
121 skyFootprints = []
122 for x, y in zip(sample[:, 0].astype(int), sample[:, 1].astype(int)):
123 if len(skyFootprints) == nSkySources:
124 break
125
126 spans = lsst.afw.geom.SpanSet.fromShape(int(skySourceRadius), offset=(x, y))
127 if spans.overlaps(avoid):
128 continue
129
130 fp = lsst.afw.detection.Footprint(spans, mask.getBBox())
131 fp.addPeak(x, y, 0)
132 skyFootprints.append(fp)
133
134 # Add doubled-in-size sky object spanSet to the avoid mask.
135 avoid = avoid.union(spans.dilated(int(skySourceRadius)))
136
137 return skyFootprints
138
139
Class to describe the properties of a detected object from an image.
Definition Footprint.h:63
static std::shared_ptr< geom::SpanSet > fromMask(image::Mask< T > const &mask, UnaryPredicate comparator=details::AnyBitSetFunctor< T >())
Create a SpanSet from a mask.
Definition SpanSet.h:644
static std::shared_ptr< geom::SpanSet > fromShape(int r, Stencil s=Stencil::CIRCLE, lsst::geom::Point2I offset=lsst::geom::Point2I())
Factory function for creating SpanSets from a Stencil.
Definition SpanSet.cc:688