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

Generate a list of Footprints of sky objects.

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

    def 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.
        """
        skyFootprints = generateSkyObjects(mask, seed, self.config)
        self.log.info("Added %d of %d requested sky sources (%.0f%%)", len(skyFootprints),
                      self.config.nSources, 100*len(skyFootprints)/self.config.nSources)
        return skyFootprints

Member Data Documentation

ConfigClass

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

static

Definition at line 97 of file skyObjects.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/meas_algorithms/22.0.1-32-gf62ce7b1+aa4237961e/python/lsst/meas/algorithms/skyObjects.py