lsst.meas.algorithms.sourceSelector.CullFromMaskedRegion Class Reference

Inheritance diagram for lsst.meas.algorithms.sourceSelector.CullFromMaskedRegion:

Public Member Functions
	apply (self, catalog, exposure)

Static Public Attributes
	badMaskNames
	xColName
	yColName

Detailed Description

Deselect sources that lie in a "bad" mask plane.

This will select against objects whose image coordinates lie in a region
with any of the mask bits in the `badMaskNames` list set. Namely used for
a reference catalog for which the flag columns we would get from the
measurement plugins do not exist.

NOTE: In the context of reference objects, it is recommended NOT to include
EDGE in the `badMaskNames` list as that will remove all the reference objects
outside the detector but within the pixelMargin (thus nulling the pixelMargin
padding all together!)

Definition at line 566 of file sourceSelector.py.

Member Function Documentation

apply()

lsst.meas.algorithms.sourceSelector.CullFromMaskedRegion.apply	(		self,
			catalog,
			exposure )

Apply the mask plane requirements to a catalog.

Returns whether the sources were selected.

Parameters
----------
catalog : `lsst.afw.table.SourceCatalog` or `pandas.DataFrame`
          or `astropy.table.Table`
    Catalog of sources to which the requirements will be applied.
exposure : `lsst.afw.image.Exposure` or None
    The exposure whose mask plane is to be respected.


Returns
-------
selected : `numpy.ndarray`
    Boolean array indicating for each source whether it is selected
    (True means selected).

Raises
------
RuntimeError
    Raised if exposure passed is `None`.

Definition at line 595 of file sourceSelector.py.

    def apply(self, catalog, exposure):
        """Apply the mask plane requirements to a catalog.
 
        Returns whether the sources were selected.
 
        Parameters
        ----------
        catalog : `lsst.afw.table.SourceCatalog` or `pandas.DataFrame`
                  or `astropy.table.Table`
            Catalog of sources to which the requirements will be applied.
        exposure : `lsst.afw.image.Exposure` or None
            The exposure whose mask plane is to be respected.
 
 
        Returns
        -------
        selected : `numpy.ndarray`
            Boolean array indicating for each source whether it is selected
            (True means selected).
 
        Raises
        ------
        RuntimeError
            Raised if exposure passed is `None`.
        """
        if exposure is None:
            raise RuntimeError("Must provide an exposure to CullFromMaskedRegion selection.")
        xRefList = catalog[self.xColName]
        yRefList = catalog[self.yColName]
        # Convert x, y coords to integers to map to indices in mask plane.
        # If reference object nominally lies outside the exposure, consider
        # it to be at the edge (and thus obeys those mask planes).
        x0, y0 = exposure.getXY0()
        xMax, yMax = exposure.getDimensions()
        xRefList = [int(min(max(0, xRef - x0), xMax - 1)) for xRef in xRefList]
        yRefList = [int(min(max(0, yRef - y0), yMax - 1)) for yRef in yRefList]
        badMaskNames = []
        maskPlaneDict = exposure.getMask().getMaskPlaneDict()
        for badName in self.badMaskNames:
            if badName in maskPlaneDict:
                badMaskNames.append(badName)
        bitmask = exposure.mask.getPlaneBitMask(badMaskNames)
        toKeep = ((exposure.mask.array & bitmask) == 0)
        selected = toKeep[yRefList, xRefList]  # x & y flipped for numpy arrays
 
        return selected
 
 

Member Data Documentation

badMaskNames

lsst.meas.algorithms.sourceSelector.CullFromMaskedRegion.badMaskNames

static

Initial value:

=  pexConfig.ListField(
        dtype=str,
        default=["NO_DATA", "NOT_DEBLENDED"],
        doc="List of mask planes for which sources should be removed if a bit is set.",
    )

Definition at line 579 of file sourceSelector.py.

xColName

lsst.meas.algorithms.sourceSelector.CullFromMaskedRegion.xColName

static

Initial value:

=  pexConfig.Field(
        dtype=str,
        default="centroid_x",
        doc="Name of column for image x coordinate."
    )

Definition at line 584 of file sourceSelector.py.

yColName

lsst.meas.algorithms.sourceSelector.CullFromMaskedRegion.yColName

static

Initial value:

=  pexConfig.Field(
        dtype=str,
        default="centroid_y",
        doc="Name of column for image y coordinate."
    )

Definition at line 589 of file sourceSelector.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/meas_algorithms/gcc769fe2a4+97d0256649/python/lsst/meas/algorithms/sourceSelector.py