lsst.ip.isr  17.0.1-7-g69836a1+9
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 run(self, exposure, **kwargs):
43  """Correct stray light.
44 
45  Parameters
46  ----------
47  exposure : `lsst.afw.image.Exposure`
48  Exposure to correct.
49 
50  """
51  self.log.info("The generic StrayLightTask does not correct anything.")
52  return
def run(self, exposure, kwargs)
Definition: straylight.py:42