LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
Loading...
Searching...
No Matches
straylight.py
Go to the documentation of this file.
1# This file is part of ip_isr.
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__ = ["StrayLightConfig", "StrayLightTask", "StrayLightData"]
23
24from abc import abstractmethod
25from typing import Optional
26
27from lsst.pex.config import Config, Field, ListField
28from lsst.pipe.base import Task
29from lsst.geom import Angle
30from .isrFunctions import checkFilter
31from .calibType import IsrCalib
32
33
35 doRotatorAngleCorrection = Field(
36 dtype=bool,
37 doc="Rotator angle correction configuration.",
38 default=False,
39 )
40 # TODO DM-28093: change the doc to specify that these are physical labels
41 filters = ListField(
42 dtype=str,
43 doc="Filters that need straylight correction.",
44 default=[],
45 )
46
47
48class StrayLightTask(Task):
49 """Remove stray light from instruments.
50
51 This is a dummy task to be retargeted with an camera-specific version.
52 """
53 ConfigClass = StrayLightConfig
54 _DefaultName = "isrStrayLight"
55
56 def check(self, exposure):
57 """Check if stray light correction should be run.
58
59 Parameters
60 ----------
61 exposure : `lsst.afw.image.Exposure`
62 Exposure to correct.
63 """
64 return False
65
66 def run(self, exposure, strayLightData):
67 """Correct stray light.
68
69 Parameters
70 ----------
71 exposure : `lsst.afw.image.Exposure`
72 Exposure to correct.
73 strayLightData : `object`, optional
74 An opaque object that contains any calibration data used to
75 correct for stray light.
76 """
77 raise NotImplementedError("Must be implemented by subclasses.")
78
79 def checkFilter(self, exposure):
80 """Check whether we should fringe-subtract the science exposure.
81
82 Parameters
83 ----------
84 exposure : `lsst.afw.image.Exposure`
85 Exposure to check the filter of.
86
87 Returns
88 -------
89 needsFringe : `bool`
90 If True, then the exposure has a filter listed in the
91 configuration, and should have the fringe applied.
92 """
93 return checkFilter(exposure, self.config.filters, log=self.log)
94
95
97 """An abstract base class for rotator-dependent stray light information.
98 """
99
100 @abstractmethod
101 def evaluate(self, angle_start: Angle, angle_end: Optional[Angle] = None):
102 """Get a stray light array for a range of rotator angles.
103
104 Parameters
105 ----------
106 angle_begin : `float`
107 Instrument rotation angle at the start of the exposure.
108 angle_end : `float`, optional
109 Instrument rotation angle at the end of the exposure.
110 If not provided, the returned array will reflect a snapshot at
111 `angle_start`.
112
113 Returns
114 -------
115 array : `numpy.ndarray`
116 A stray-light background image for this exposure.
117 """
118 raise NotImplementedError("Must be implemented by subclasses.")
evaluate(self, Angle angle_start, Optional[Angle] angle_end=None)
run(self, exposure, strayLightData)
Definition straylight.py:66