Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

# 

# LSST Data Management System 

# Copyright 2008, 2009, 2010 LSST Corporation. 

# 

# This product includes software developed by the 

# LSST Project (http://www.lsst.org/). 

# 

# This program is free software: you can redistribute it and/or modify 

# it under the terms of the GNU General Public License as published by 

# the Free Software Foundation, either version 3 of the License, or 

# (at your option) any later version. 

# 

# This program is distributed in the hope that it will be useful, 

# but WITHOUT ANY WARRANTY; without even the implied warranty of 

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

# GNU General Public License for more details. 

# 

# You should have received a copy of the LSST License Statement and 

# the GNU General Public License along with this program. If not, 

# see <http://www.lsstcorp.org/LegalNotices/>. 

# 

 

import lsst.afw.image as afwImage 

 

__all__ = ["makeBitMask"] 

 

 

def makeBitMask(maskPlaneNameList, doInvert=False): 

"""Generate a bit mask consisting of ORed together Mask bit planes 

 

@deprecated use afwImage.Mask.getPlaneBitMask(maskPlaneNameList) instead. 

 

@input[in] maskPlaneNameList: list of mask plane names 

@input[in] doInvert: if True then invert the result 

 

@return a bit mask consisting of the named bit planes ORed together (with the result possibly inverted) 

""" 

bitMask = afwImage.Mask.getPlaneBitMask(maskPlaneNameList) 

if doInvert: 

bitMask = (2**afwImage.Mask.getNumPlanesMax() - 1) - bitMask 

return bitMask