lsst.afw.image._image._mask.Mask Class Reference

Inheritance diagram for lsst.afw.image._image._mask.Mask:

Public Member Functions
	__reduce__ (self)
	__str__ (self)
	__repr__ (self)
	writeFitsWithOptions (self, dest, options, item=None)

Public Attributes
	array

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__()

lsst.afw.image._image._mask.Mask.__reduce__

(

self

)

Definition at line 39 of file _mask.py.

__repr__()

lsst.afw.image._image._mask.Mask.__repr__

(

self

)

Definition at line 46 of file _mask.py.

__str__()

lsst.afw.image._image._mask.Mask.__str__

(

self

)

Definition at line 43 of file _mask.py.

writeFitsWithOptions()

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 : `collections.abc.Mappoing`
    Write options. The item ``item`` is accessed. It must contain a
    mapping with data for
    `lsst.afw.fits.CompressionOptions.from_mapping`, or `None` for no
    compression.
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

array

lsst.afw.image._image._mask.Mask.array

Definition at line 44 of file _mask.py.

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:

• python/lsst/afw/image/_image/_mask.py