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.

    def __reduce__(self):
        from lsst.afw.fits import reduceToFits
        return reduceToFits(self)
 

__repr__()

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

(

self

)

Definition at line 46 of file _mask.py.

    def __repr__(self):
        return "{}.{}={}".format(self.__module__, self.__class__.__name__, str(self))
 

__str__()

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

(

self

)

Definition at line 43 of file _mask.py.

    def __str__(self):
        return "{}, bbox={}, maskPlaneDict={}".format(self.array, self.getBBox(), self.getMaskPlaneDict())
 

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 : `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.

    def 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.
        """
        if item is None:
            # Fallback to "image" if "mask" is missing. This allows older
            # code that assumed "image" to still function.
            item = "mask" if "mask" in options else "image"
        return imageWriteFitsWithOptions(self, dest, options, item=item)
 
 

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:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+53520f316c/python/lsst/afw/image/_image/_mask.py