lsst.afw g9029821c7d+808890523f
Public Member Functions | Static Public Attributes | List of all members
lsst.afw.image.image._mask.Mask Class Reference
Inheritance diagram for lsst.afw.image.image._mask.Mask:

Public Member Functions

def __reduce__ (self)
 
def __str__ (self)
 
def __repr__ (self)
 
def writeFitsWithOptions (self, dest, options, item=None)
 

Static Public Attributes

tuple TEMPLATE_PARAMS = ("dtype",)
 
tuple TEMPLATE_DEFAULTS = (MaskPixel,)
 
 readFitsWithOptions = classmethod(imageReadFitsWithOptions)
 

Detailed Description

Definition at line 35 of file _mask.py.

Member Function Documentation

◆ __reduce__()

def lsst.afw.image.image._mask.Mask.__reduce__ (   self)

Definition at line 39 of file _mask.py.

◆ __repr__()

def lsst.afw.image.image._mask.Mask.__repr__ (   self)

Definition at line 46 of file _mask.py.

◆ __str__()

def lsst.afw.image.image._mask.Mask.__str__ (   self)

Definition at line 43 of file _mask.py.

◆ writeFitsWithOptions()

def lsst.afw.image.image._mask.Mask.writeFitsWithOptions (   self,
  dest,
  options,
  item = None 
)
Write an Mask to FITS, with options

Parameters
----------
dest : `str`
    Fits file path to which to write the mask.
options : `lsst.daf.base.PropertySet`
    Write options. The item ``item`` is read.
    It must contain an `lsst.daf.base.PropertySet` with data for
    ``lsst.afw.fits.ImageWriteOptions``.
item : `str`, optional
    Item to read from the ``options`` parameter.
    If not specified it will default to "mask" if present, else
    will fallback to the generic "image" options.

Definition at line 51 of file _mask.py.

Member Data Documentation

◆ readFitsWithOptions

lsst.afw.image.image._mask.Mask.readFitsWithOptions = classmethod(imageReadFitsWithOptions)
static

Definition at line 49 of file _mask.py.

◆ TEMPLATE_DEFAULTS

tuple lsst.afw.image.image._mask.Mask.TEMPLATE_DEFAULTS = (MaskPixel,)
static

Definition at line 37 of file _mask.py.

◆ TEMPLATE_PARAMS

tuple lsst.afw.image.image._mask.Mask.TEMPLATE_PARAMS = ("dtype",)
static

Definition at line 36 of file _mask.py.


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