lsst.ip.isr  17.0.1-14-g2fe997d+1
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 # import os
22 
23 from lsst.pex.config import Config, Field
24 from lsst.pipe.base import Task
25 
26 
27 class StrayLightConfig(Config):
28  doRotatorAngleCorrection = Field(
29  dtype=bool,
30  doc="",
31  default=False,
32  )
33 
34 
35 class StrayLightTask(Task):
36  """Remove stray light from instruments.
37 
38  This is a dummy task to be retargeted with an camera-specific version.
39  """
40  ConfigClass = StrayLightConfig
41 
42  def readIsrData(self, dataRef, rawExposure):
43  """Read and return calibration products relevant for correcting
44  stray light in the given exposure.
45 
46  Parameters
47  ----------
48  dataRef : `daf.persistence.butlerSubset.ButlerDataRef`
49  Butler reference of the detector data to be processed
50  rawExposure : `afw.image.Exposure`
51  The raw exposure that will later be corrected with the
52  retrieved calibration data; should not be modified in this
53  method.
54 
55  Returns
56  -------
57  straylightData : `object`, optional
58  An opaque object that should be passed as the second argument to
59  the `run` method. If `None`, no stray light correction will be
60  performed for the given image. Any other object (e.g. `True`)
61  may be used to signal that stray light correction should be
62  performed even if there is nothing to read.
63 
64  Notes
65  -----
66  This method will be called only when `IsrTask` is run by the Gen2
67  Middleware (i.e. CmdLineTask).
68  """
69  return None
70 
71  def run(self, exposure, strayLightData):
72  """Correct stray light.
73 
74  Parameters
75  ----------
76  exposure : `lsst.afw.image.Exposure`
77  Exposure to correct.
78  strayLightData : `object`, optional
79  An opaque object that contains any calibration data used to
80  correct for stray light.
81  """
82  raise NotImplementedError("Must be implemented by subclasses.")
def run(self, exposure, strayLightData)
Definition: straylight.py:71
def readIsrData(self, dataRef, rawExposure)
Definition: straylight.py:42