lsst.pipe.tasks  21.0.0-138-gbb2e3e44+39392cd645
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
lsst.pipe.tasks.healSparseMapping.HealSparseInputMapTask Class Reference
Inheritance diagram for lsst.pipe.tasks.healSparseMapping.HealSparseInputMapTask:

Public Member Functions

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

Public Attributes

 ccd_input_map
 

Static Public Attributes

 ConfigClass = HealSparseInputMapConfig
 

Detailed Description

Task for making a HealSparse input map.

Definition at line 128 of file healSparseMapping.py.

Constructor & Destructor Documentation

◆ __init__()

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

Definition at line 134 of file healSparseMapping.py.

Member Function Documentation

◆ build_ccd_input_map()

def 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 139 of file healSparseMapping.py.

◆ finalize_ccd_input_map_mask()

def 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 266 of file healSparseMapping.py.

◆ mask_warp_bbox()

def 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 212 of file healSparseMapping.py.

Member Data Documentation

◆ ccd_input_map

lsst.pipe.tasks.healSparseMapping.HealSparseInputMapTask.ccd_input_map

Definition at line 137 of file healSparseMapping.py.

◆ ConfigClass

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

Definition at line 131 of file healSparseMapping.py.


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