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

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

# This file is part of ip_isr. 

# 

# Developed for the LSST Data Management System. 

# This product includes software developed by the LSST Project 

# (https://www.lsst.org). 

# See the COPYRIGHT file at the top-level directory of this distribution 

# for details of code ownership. 

# 

# 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 GNU General Public License 

# along with this program. If not, see <https://www.gnu.org/licenses/>. 

# import os 

 

from lsst.pex.config import Config, Field 

from lsst.pipe.base import Task 

 

 

class StrayLightConfig(Config): 

doRotatorAngleCorrection = Field( 

dtype=bool, 

doc="", 

default=False, 

) 

 

 

class StrayLightTask(Task): 

"""Remove stray light from instruments. 

 

This is a dummy task to be retargeted with an camera-specific version. 

""" 

ConfigClass = StrayLightConfig 

_DefaultName = "isrStrayLight" 

 

def readIsrData(self, dataRef, rawExposure): 

"""Read and return calibration products relevant for correcting 

stray light in the given exposure. 

 

Parameters 

---------- 

dataRef : `daf.persistence.butlerSubset.ButlerDataRef` 

Butler reference of the detector data to be processed 

rawExposure : `afw.image.Exposure` 

The raw exposure that will later be corrected with the 

retrieved calibration data; should not be modified in this 

method. 

 

Returns 

------- 

straylightData : `object`, optional 

An opaque object that should be passed as the second argument to 

the `run` method. If `None`, no stray light correction will be 

performed for the given image. Any other object (e.g. `True`) 

may be used to signal that stray light correction should be 

performed even if there is nothing to read. 

 

Notes 

----- 

This method will be called only when `IsrTask` is run by the Gen2 

Middleware (i.e. CmdLineTask). 

""" 

return None 

 

def run(self, exposure, strayLightData): 

"""Correct stray light. 

 

Parameters 

---------- 

exposure : `lsst.afw.image.Exposure` 

Exposure to correct. 

strayLightData : `object`, optional 

An opaque object that contains any calibration data used to 

correct for stray light. 

""" 

raise NotImplementedError("Must be implemented by subclasses.")