lsst.pipe.tasks.healSparseMapping.HealSparseInputMapTask Class Reference

Inheritance diagram for lsst.pipe.tasks.healSparseMapping.HealSparseInputMapTask:

Public Member Functions
	__init__ (self, **kwargs)
	build_ccd_input_map (self, bbox, wcs, ccds)
	mask_warp_bbox (self, bbox, visit, mask, bit_mask_value)
	finalize_ccd_input_map_mask (self)

Public Attributes
	ccd_input_map = None

Static Public Attributes
	ConfigClass = HealSparseInputMapConfig

Protected Member Functions
	_pixels_to_radec (self, wcs, pixels)

Protected Attributes
	_wcs = wcs
	_bbox = bbox
	_ccds = ccds
	_min_bad = self.config.bad_mask_min_coverage*hpix_area_arcsec2/(pixel_scale**2.)
dict	_bits_per_visit_ccd = {}
	_bits_per_visit = defaultdict(list)
	_ccd_input_bad_count_map
	_ccd_input_pixels = self.ccd_input_map.valid_pixels

Static Protected Attributes
str	_DefaultName = "healSparseInputMap"

Detailed Description

Task for making a HealSparse input map.

Definition at line 133 of file healSparseMapping.py.

Constructor & Destructor Documentation

__init__()

lsst.pipe.tasks.healSparseMapping.HealSparseInputMapTask.__init__	(		self,
		**	kwargs )

Definition at line 139 of file healSparseMapping.py.

    def __init__(self, **kwargs):
        pipeBase.Task.__init__(self, **kwargs)
 
        self.ccd_input_map = None
 

Member Function Documentation

_pixels_to_radec()

lsst.pipe.tasks.healSparseMapping.HealSparseInputMapTask._pixels_to_radec ( self, wcs, pixels )

protected

Convert pixels to ra/dec positions using a wcs.

Parameters
----------
wcs : `lsst.afw.geom.SkyWcs`
    WCS object.
pixels : `list` [`lsst.geom.Point2D`]
    List of pixels to convert.

Returns
-------
radec : `numpy.ndarray`
    Nx2 array of ra/dec positions associated with pixels.

Definition at line 312 of file healSparseMapping.py.

    def _pixels_to_radec(self, wcs, pixels):
        """Convert pixels to ra/dec positions using a wcs.
 
        Parameters
        ----------
        wcs : `lsst.afw.geom.SkyWcs`
            WCS object.
        pixels : `list` [`lsst.geom.Point2D`]
            List of pixels to convert.
 
        Returns
        -------
        radec : `numpy.ndarray`
            Nx2 array of ra/dec positions associated with pixels.
        """
        sph_pts = wcs.pixelToSky(pixels)
        return np.array([(sph.getRa().asDegrees(), sph.getDec().asDegrees())
                         for sph in sph_pts])
 
 

build_ccd_input_map()

lsst.pipe.tasks.healSparseMapping.HealSparseInputMapTask.build_ccd_input_map	(		self,
			bbox,
			wcs,
			ccds )

Build a map from ccd valid polygons or bounding boxes.

Parameters
----------
bbox : `lsst.geom.Box2I`
    Bounding box for region to build input map.
wcs : `lsst.afw.geom.SkyWcs`
    WCS object for region to build input map.
ccds : `lsst.afw.table.ExposureCatalog`
    Exposure catalog with ccd data from coadd inputs.

Definition at line 144 of file healSparseMapping.py.

    def build_ccd_input_map(self, bbox, wcs, ccds):
        """Build a map from ccd valid polygons or bounding boxes.
 
        Parameters
        ----------
        bbox : `lsst.geom.Box2I`
            Bounding box for region to build input map.
        wcs : `lsst.afw.geom.SkyWcs`
            WCS object for region to build input map.
        ccds : `lsst.afw.table.ExposureCatalog`
            Exposure catalog with ccd data from coadd inputs.
        """
        with warnings.catch_warnings():
            # Healsparse will emit a warning if nside coverage is greater than
            # 128.  In the case of generating patch input maps, and not global
            # maps, high nside coverage works fine, so we can suppress this
            # warning.
            warnings.simplefilter("ignore")
            self.ccd_input_map = hsp.HealSparseMap.make_empty(nside_coverage=self.config.nside_coverage,
                                                              nside_sparse=self.config.nside,
                                                              dtype=hsp.WIDE_MASK,
                                                              wide_mask_maxbits=len(ccds))
        self._wcs = wcs
        self._bbox = bbox
        self._ccds = ccds
 
        pixel_scale = wcs.getPixelScale(bbox.getCenter()).asArcseconds()
        hpix_area_arcsec2 = hpg.nside_to_pixel_area(self.config.nside, degrees=True)*(3600.**2.)
        self._min_bad = self.config.bad_mask_min_coverage*hpix_area_arcsec2/(pixel_scale**2.)
 
        metadata = {}
        self._bits_per_visit_ccd = {}
        self._bits_per_visit = defaultdict(list)
        for bit, ccd_row in enumerate(ccds):
            metadata[f"B{bit:04d}CCD"] = ccd_row["ccd"]
            metadata[f"B{bit:04d}VIS"] = ccd_row["visit"]
            metadata[f"B{bit:04d}WT"] = ccd_row["weight"]
 
            self._bits_per_visit_ccd[(ccd_row["visit"], ccd_row["ccd"])] = bit
            self._bits_per_visit[ccd_row["visit"]].append(bit)
 
            ccd_poly = ccd_row.getValidPolygon()
            if ccd_poly is None:
                ccd_poly = afwGeom.Polygon(lsst.geom.Box2D(ccd_row.getBBox()))
            # Detectors need to be rendered with their own wcs.
            ccd_poly_radec = self._pixels_to_radec(ccd_row.getWcs(), ccd_poly.convexHull().getVertices())
 
            # Create a ccd healsparse polygon
            poly = hsp.Polygon(ra=ccd_poly_radec[: -1, 0],
                               dec=ccd_poly_radec[: -1, 1],
                               value=[bit])
            self.ccd_input_map.set_bits_pix(poly.get_pixels(nside=self.ccd_input_map.nside_sparse),
                                            [bit])
 
        # Cut down to the overall bounding box with associated wcs.
        bbox_afw_poly = afwGeom.Polygon(lsst.geom.Box2D(bbox))
        bbox_poly_radec = self._pixels_to_radec(self._wcs,
                                                bbox_afw_poly.convexHull().getVertices())
        bbox_poly = hsp.Polygon(ra=bbox_poly_radec[: -1, 0], dec=bbox_poly_radec[: -1, 1],
                                value=np.arange(self.ccd_input_map.wide_mask_maxbits))
        with warnings.catch_warnings():
            warnings.simplefilter("ignore")
            bbox_poly_map = bbox_poly.get_map_like(self.ccd_input_map)
            self.ccd_input_map = hsp.and_intersection([self.ccd_input_map, bbox_poly_map])
        self.ccd_input_map.metadata = metadata
 
        # Create a temporary map to hold the count of bad pixels in each healpix pixel
        dtype = [(f"v{visit}", np.int64) for visit in self._bits_per_visit.keys()]
 
        with warnings.catch_warnings():
            # Healsparse will emit a warning if nside coverage is greater than
            # 128.  In the case of generating patch input maps, and not global
            # maps, high nside coverage works fine, so we can suppress this
            # warning.
            warnings.simplefilter("ignore")
            self._ccd_input_bad_count_map = hsp.HealSparseMap.make_empty(
                nside_coverage=self.config.nside_coverage,
                nside_sparse=self.config.nside,
                dtype=dtype,
                primary=dtype[0][0])
 
        self._ccd_input_pixels = self.ccd_input_map.valid_pixels
 
        # Don't set input bad map if there are no ccds which overlap the bbox.
        if len(self._ccd_input_pixels) > 0:
            # Ensure these are sorted.
            self._ccd_input_pixels = np.sort(self._ccd_input_pixels)
 
            self._ccd_input_bad_count_map[self._ccd_input_pixels] = np.zeros(1, dtype=dtype)
 

finalize_ccd_input_map_mask()

lsst.pipe.tasks.healSparseMapping.HealSparseInputMapTask.finalize_ccd_input_map_mask

(

self

)

Use accumulated mask information to finalize the masking of
ccd_input_map.

Raises
------
RuntimeError : Raised if build_ccd_input_map was not run first.

Definition at line 290 of file healSparseMapping.py.

    def finalize_ccd_input_map_mask(self):
        """Use accumulated mask information to finalize the masking of
        ccd_input_map.
 
        Raises
        ------
        RuntimeError : Raised if build_ccd_input_map was not run first.
        """
        if self.ccd_input_map is None:
            raise RuntimeError("Must run build_ccd_input_map before finalize_ccd_input_map_mask.")
 
        count_map_arr = self._ccd_input_bad_count_map[self._ccd_input_pixels]
        for visit in self._bits_per_visit:
            to_mask, = np.where(count_map_arr[f"v{visit}"] > self._min_bad)
            if to_mask.size == 0:
                continue
            self.ccd_input_map.clear_bits_pix(self._ccd_input_pixels[to_mask],
                                              self._bits_per_visit[visit])
 
        # Clear memory
        self._ccd_input_bad_count_map = None
 

mask_warp_bbox()

lsst.pipe.tasks.healSparseMapping.HealSparseInputMapTask.mask_warp_bbox	(		self,
			bbox,
			visit,
			mask,
			bit_mask_value )

Mask a subregion from a visit.
This must be run after build_ccd_input_map initializes
the overall map.

Parameters
----------
bbox : `lsst.geom.Box2I`
    Bounding box from region to mask.
visit : `int`
    Visit number corresponding to warp with mask.
mask : `lsst.afw.image.MaskX`
    Mask plane from warp exposure.
bit_mask_value : `int`
    Bit mask to check for bad pixels.

Raises
------
RuntimeError : Raised if build_ccd_input_map was not run first.

Definition at line 234 of file healSparseMapping.py.

    def mask_warp_bbox(self, bbox, visit, mask, bit_mask_value):
        """Mask a subregion from a visit.
        This must be run after build_ccd_input_map initializes
        the overall map.
 
        Parameters
        ----------
        bbox : `lsst.geom.Box2I`
            Bounding box from region to mask.
        visit : `int`
            Visit number corresponding to warp with mask.
        mask : `lsst.afw.image.MaskX`
            Mask plane from warp exposure.
        bit_mask_value : `int`
            Bit mask to check for bad pixels.
 
        Raises
        ------
        RuntimeError : Raised if build_ccd_input_map was not run first.
        """
        if self.ccd_input_map is None:
            raise RuntimeError("Must run build_ccd_input_map before mask_warp_bbox")
 
        if len(self._ccd_input_pixels) == 0:
            # This tract has no coverage, so there is nothing to do.
            return
 
        # Find the bad pixels and convert to healpix
        bad_pixels = np.where(mask.array & bit_mask_value)
        if len(bad_pixels[0]) == 0:
            # No bad pixels
            return
 
        # Bad pixels come from warps which use the overall wcs.
        bad_ra, bad_dec = self._wcs.pixelToSkyArray(
            bad_pixels[1].astype(np.float64) + bbox.getMinX(),
            bad_pixels[0].astype(np.float64) + bbox.getMinY(),
            degrees=True,
        )
        bad_hpix = hpg.angle_to_pixel(self.config.nside, bad_ra, bad_dec)
 
        # Check if any of these "bad" pixels are in the valid footprint.
        match_input, match_bad = esutil.numpy_util.match(self._ccd_input_pixels, bad_hpix, presorted=True)
        if len(match_bad) == 0:
            return
 
        bad_hpix = bad_hpix[match_bad]
 
        # Create a view of the column we need to add to.
        count_map_visit = self._ccd_input_bad_count_map[f"v{visit}"]
        # Add the bad pixels to the accumulator. Note that the view
        # cannot append pixels, but the match above ensures we are
        # only adding to pixels that are already in the coverage
        # map and initialized.
        count_map_visit.update_values_pix(bad_hpix, 1, operation="add")
 

Member Data Documentation

_bbox

lsst.pipe.tasks.healSparseMapping.HealSparseInputMapTask._bbox = bbox

protected

Definition at line 167 of file healSparseMapping.py.

_bits_per_visit

lsst.pipe.tasks.healSparseMapping.HealSparseInputMapTask._bits_per_visit = defaultdict(list)

protected

Definition at line 176 of file healSparseMapping.py.

_bits_per_visit_ccd

dict lsst.pipe.tasks.healSparseMapping.HealSparseInputMapTask._bits_per_visit_ccd = {}

protected

Definition at line 175 of file healSparseMapping.py.

_ccd_input_bad_count_map

lsst.pipe.tasks.healSparseMapping.HealSparseInputMapTask._ccd_input_bad_count_map

protected

Initial value:

=  hsp.HealSparseMap.make_empty(
                nside_coverage=self.config.nside_coverage,
                nside_sparse=self.config.nside,
                dtype=dtype,
                primary=dtype[0][0])

Definition at line 219 of file healSparseMapping.py.

_ccd_input_pixels

lsst.pipe.tasks.healSparseMapping.HealSparseInputMapTask._ccd_input_pixels = self.ccd_input_map.valid_pixels

protected

Definition at line 225 of file healSparseMapping.py.

_ccds

lsst.pipe.tasks.healSparseMapping.HealSparseInputMapTask._ccds = ccds

protected

Definition at line 168 of file healSparseMapping.py.

_DefaultName

str lsst.pipe.tasks.healSparseMapping.HealSparseInputMapTask._DefaultName = "healSparseInputMap"

staticprotected

Definition at line 137 of file healSparseMapping.py.

_min_bad

lsst.pipe.tasks.healSparseMapping.HealSparseInputMapTask._min_bad = self.config.bad_mask_min_coverage*hpix_area_arcsec2/(pixel_scale**2.)

protected

Definition at line 172 of file healSparseMapping.py.

_wcs

lsst.pipe.tasks.healSparseMapping.HealSparseInputMapTask._wcs = wcs

protected

Definition at line 166 of file healSparseMapping.py.

ccd_input_map

lsst.pipe.tasks.healSparseMapping.HealSparseInputMapTask.ccd_input_map = None

Definition at line 142 of file healSparseMapping.py.

ConfigClass

lsst.pipe.tasks.healSparseMapping.HealSparseInputMapTask.ConfigClass = HealSparseInputMapConfig

static

Definition at line 136 of file healSparseMapping.py.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/pipe_tasks/g99af87f6a8+b0f4ad7b8d/python/lsst/pipe/tasks/healSparseMapping.py