LSST Applications g04e9c324dd+8c5ae1fdc5,g134cb467dc+1b3060144d,g18429d2f64+f642bf4753,g199a45376c+0ba108daf9,g1fd858c14a+2dcf163641,g262e1987ae+7b8c96d2ca,g29ae962dfc+3bd6ecb08a,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53e1a9e7c5,g4595892280+fef73a337f,g47891489e3+2efcf17695,g4d44eb3520+642b70b07e,g53246c7159+8c5ae1fdc5,g67b6fd64d1+2efcf17695,g67fd3c3899+b70e05ef52,g74acd417e5+317eb4c7d4,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+2efcf17695,g8d7436a09f+3be3c13596,g8ea07a8fe4+9f5ccc88ac,g90f42f885a+a4e7b16d9b,g97be763408+ad77d7208f,g9dd6db0277+b70e05ef52,ga681d05dcb+a3f46e7fff,gabf8522325+735880ea63,gac2eed3f23+2efcf17695,gb89ab40317+2efcf17695,gbf99507273+8c5ae1fdc5,gd8ff7fe66e+b70e05ef52,gdab6d2f7ff+317eb4c7d4,gdc713202bf+b70e05ef52,gdfd2d52018+b10e285e0f,ge365c994fd+310e8507c4,ge410e46f29+2efcf17695,geaed405ab2+562b3308c0,gffca2db377+8c5ae1fdc5,w.2025.35
LSST Data Management Base Package
Loading...
Searching...
No Matches
_mask.py
Go to the documentation of this file.
1# This file is part of afw.
2#
3# Developed for the LSST Data Management System.
4# This product includes software developed by the LSST Project
5# (https://www.lsst.org).
6# See the COPYRIGHT file at the top-level directory of this distribution
7# for details of code ownership.
8#
9# This program is free software: you can redistribute it and/or modify
10# it under the terms of the GNU General Public License as published by
11# the Free Software Foundation, either version 3 of the License, or
12# (at your option) any later version.
13#
14# This program is distributed in the hope that it will be useful,
15# but WITHOUT ANY WARRANTY; without even the implied warranty of
16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17# GNU General Public License for more details.
18#
19# You should have received a copy of the GNU General Public License
20# along with this program. If not, see <https://www.gnu.org/licenses/>.
21
22__all__ = ["Mask", "MaskPixel"]
23
24import numpy as np
25
26from lsst.utils import TemplateMeta
27from ._fitsIoWithOptions import imageReadFitsWithOptions, imageWriteFitsWithOptions
28from ._imageLib import MaskX
29from ._slicing import supportSlicing
30from ._disableArithmetic import disableMaskArithmetic
31
32MaskPixel = np.int32
33
34
35class Mask(metaclass=TemplateMeta):
36 TEMPLATE_PARAMS = ("dtype",)
37 TEMPLATE_DEFAULTS = (MaskPixel,)
38
39 def __reduce__(self):
40 from lsst.afw.fits import reduceToFits
41 return reduceToFits(self)
42
43 def __str__(self):
44 return "{}, bbox={}, maskPlaneDict={}".format(self.array, self.getBBox(), self.getMaskPlaneDict())
45
46 def __repr__(self):
47 return "{}.{}={}".format(self.__module__, self.__class__.__name__, str(self))
48
49 readFitsWithOptions = classmethod(imageReadFitsWithOptions)
50
51 def writeFitsWithOptions(self, dest, options, item=None):
52 """Write an Mask to FITS, with options
53
54 Parameters
55 ----------
56 dest : `str`
57 Fits file path to which to write the mask.
58 options : `lsst.daf.base.PropertySet`
59 Write options. The item ``item`` is read.
60 It must contain an `lsst.daf.base.PropertySet` with data for
61 ``lsst.afw.fits.ImageWriteOptions``.
62 item : `str`, optional
63 Item to read from the ``options`` parameter.
64 If not specified it will default to "mask" if present, else
65 will fallback to the generic "image" options.
66 """
67 if item is None:
68 # Fallback to "image" if "mask" is missing. This allows older
69 # code that assumed "image" to still function.
70 item = "mask" if "mask" in options else "image"
71 return imageWriteFitsWithOptions(self, dest, options, item=item)
72
73
74Mask.register(MaskPixel, MaskX)
75Mask.alias("X", MaskX)
76
77for cls in (MaskX, ):
78 supportSlicing(cls)
79 disableMaskArithmetic(cls)
writeFitsWithOptions(self, dest, options, item=None)
Definition _mask.py:51