Coverage for python/lsst/pipe/tasks/fakes.py: 75%
16 statements
« prev ^ index » next coverage.py v6.5.0, created at 2022-12-01 21:12 +0000
« prev ^ index » next coverage.py v6.5.0, created at 2022-12-01 21:12 +0000
1#
2# LSST Data Management System
3# Copyright 2008-2014 LSST Corporation.
4#
5# This product includes software developed by the
6# LSST Project (http://www.lsst.org/).
7#
8# This program is free software: you can redistribute it and/or modify
9# it under the terms of the GNU General Public License as published by
10# the Free Software Foundation, either version 3 of the License, or
11# (at your option) any later version.
12#
13# This program is distributed in the hope that it will be useful,
14# but WITHOUT ANY WARRANTY; without even the implied warranty of
15# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16# GNU General Public License for more details.
17#
18# You should have received a copy of the LSST License Statement and
19# the GNU General Public License along with this program. If not,
20# see <http://www.lsstcorp.org/LegalNotices/>.
21#
22import abc
24import lsst.pex.config
25import lsst.pipe.base
26import lsst.afw.image
29class BaseFakeSourcesConfig(lsst.pex.config.Config):
30 maskPlaneName = lsst.pex.config.Field(
31 dtype=str, default="FAKE",
32 doc="Mask plane to set on pixels affected by fakes. Will be added if not already present."
33 )
36class BaseFakeSourcesTask(lsst.pipe.base.Task, metaclass=abc.ABCMeta):
37 """An abstract base class for subtasks that inject fake sources into images to test completeness and
38 other aspects of the processing.
40 This class simply adds a mask plane that subclasses should use to mark pixels that have been touched.
42 This is an abstract base class (abc) and is not intended to be directly used. To create a fake sources
43 injector, create a child class and re-implement the required methods.
44 """
46 ConfigClass = BaseFakeSourcesConfig
47 _DefaultName = "baseFakeSources"
49 def __init__(self, **kwargs):
50 """Initialize the Task.
52 Subclasses that define their own __init__ should simply forward all arguments to the base
53 class constructor. They can then assume self.config is an instance of their ConfigClass.
55 If an external catalog is used to add sources consistently to multiple overlapping images,
56 that catalog should generally be loaded and attached to self here, so it can be used
57 multiple times by the run() method.
58 """
59 lsst.pipe.base.Task.__init__(self, **kwargs)
60 lsst.afw.image.Mask[lsst.afw.image.MaskPixel].addMaskPlane(self.config.maskPlaneName)
61 self.bitmask = lsst.afw.image.Mask[lsst.afw.image.MaskPixel]\
62 .getPlaneBitMask(self.config.maskPlaneName)
64 @abc.abstractmethod
65 def run(self, exposure, background):
66 """Add fake sources to the given Exposure, making use of the given BackgroundList if desired.
68 If pixels in the Exposure are replaced, not added to, extra care should be taken with the background,
69 mask, and variance planes. The Exposure as given is background-subtracted (using the supplied
70 background model) and should be returned in the same state.
71 """
72 raise NotImplementedError("FakeSourcesTask is abstract, create a child class to use this method")