lsst.coadd.utils  14.0+3
makeBitMask.py
Go to the documentation of this file.
1 #
2 # LSST Data Management System
3 # Copyright 2008, 2009, 2010 LSST Corporation.
4 #
5 # This product includes software developed by the
6 # LSST Project (http://www.lsst.org/).
7 #
8 # This program is free software: you can redistribute it and/or modify
9 # it under the terms of the GNU General Public License as published by
10 # the Free Software Foundation, either version 3 of the License, or
11 # (at your option) any later version.
12 #
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
17 #
18 # You should have received a copy of the LSST License Statement and
19 # the GNU General Public License along with this program. If not,
20 # see <http://www.lsstcorp.org/LegalNotices/>.
21 #
22 
23 import lsst.afw.image as afwImage
24 
25 __all__ = ["makeBitMask"]
26 
27 
28 def makeBitMask(maskPlaneNameList, doInvert=False):
29  """Generate a bit mask consisting of ORed together Mask bit planes
30 
31  @deprecated use afwImage.Mask.getPlaneBitMask(maskPlaneNameList) instead.
32 
33  @input[in] maskPlaneNameList: list of mask plane names
34  @input[in] doInvert: if True then invert the result
35 
36  @return a bit mask consisting of the named bit planes ORed together (with the result possibly inverted)
37  """
38  bitMask = afwImage.Mask.getPlaneBitMask(maskPlaneNameList)
39  if doInvert:
40  bitMask = (2**afwImage.Mask.getNumPlanesMax() - 1) - bitMask
41  return bitMask
def makeBitMask(maskPlaneNameList, doInvert=False)
Definition: makeBitMask.py:28