lsst.afw g9b27d6183c+80279584a1
basicUtils.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__ = ["makeImageFromArray", "makeMaskFromArray", "makeMaskedImageFromArrays"]
23
24from .image import Image, Mask
25from .maskedImage import MaskedImage
26
27
29 """Construct an Image from a NumPy array, inferring the Image type from
30 the NumPy type. Return None if input is None.
31 """
32 if array is None:
33 return None
34 return Image(array, dtype=array.dtype.type)
35
36
38 """Construct an Mask from a NumPy array, inferring the Mask type from the
39 NumPy type. Return None if input is None.
40 """
41 if array is None:
42 return None
43 return Mask(array, dtype=array.dtype.type)
44
45
46def makeMaskedImageFromArrays(image, mask=None, variance=None):
47 """Construct a MaskedImage from three NumPy arrays, inferring the
48 MaskedImage types from the NumPy types.
49 """
51 makeImageFromArray(variance), dtype=image.dtype.type)
A class to represent a 2-dimensional array of pixels.
Definition: Image.h:51
Represent a 2-dimensional array of bitmask pixels.
Definition: Mask.h:77
def makeMaskedImageFromArrays(image, mask=None, variance=None)
Definition: basicUtils.py:46