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
warpAndPsfMatch.py
Go to the documentation of this file.
1# This file is part of pipe_tasks.
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__ = ["WarpAndPsfMatchTask"]
23
24import lsst.pex.config as pexConfig
25import lsst.afw.math as afwMath
26import lsst.geom as geom
27import lsst.afw.geom as afwGeom
28import lsst.pipe.base as pipeBase
29from lsst.ip.diffim import ModelPsfMatchTask
30from lsst.meas.algorithms import WarpedPsf
31
32
33class WarpAndPsfMatchConfig(pexConfig.Config):
34 """Config for WarpAndPsfMatchTask
35 """
36 psfMatch = pexConfig.ConfigurableField(
37 target=ModelPsfMatchTask,
38 doc="PSF matching model to model task",
39 )
40 warp = pexConfig.ConfigField(
41 dtype=afwMath.Warper.ConfigClass,
42 doc="warper configuration",
43 )
44
45
46class WarpAndPsfMatchTask(pipeBase.Task):
47 """A task to warp and PSF-match an exposure
48 """
49 ConfigClass = WarpAndPsfMatchConfig
50
51 def __init__(self, *args, **kwargs):
52 pipeBase.Task.__init__(self, *args, **kwargs)
53 self.makeSubtask("psfMatch")
54 self.warper = afwMath.Warper.fromConfig(self.config.warp)
55
56 def run(self, exposure, wcs, modelPsf=None, maxBBox=None, destBBox=None,
57 makeDirect=True, makePsfMatched=False):
58 """Warp and optionally PSF-match exposure
59
60 Parameters
61 ----------
62 exposure : :cpp:class: `lsst::afw::image::Exposure`
63 Exposure to preprocess.
64 wcs : :cpp:class:`lsst::afw::image::Wcs`
65 Desired WCS of temporary images.
66 modelPsf : :cpp:class: `lsst::meas::algorithms::KernelPsf` or None
67 Target PSF to which to match.
68 maxBBox : :cpp:class:`lsst::afw::geom::Box2I` or None
69 Maximum allowed parent bbox of warped exposure.
70 If None then the warped exposure will be just big enough to contain all warped pixels;
71 if provided then the warped exposure may be smaller, and so missing some warped pixels;
72 ignored if destBBox is not None.
73 destBBox: :cpp:class: `lsst::afw::geom::Box2I` or None
74 Exact parent bbox of warped exposure.
75 If None then maxBBox is used to determine the bbox, otherwise maxBBox is ignored.
76 makeDirect : bool
77 Return an exposure that has been only warped?
78 makePsfMatched : bool
79 Return an exposure that has been warped and PSF-matched?
80
81 Returns
82 -------
83 An lsst.pipe.base.Struct with the following fields:
84
85 direct : :cpp:class:`lsst::afw::image::Exposure`
86 warped exposure
87 psfMatched : :cpp:class: `lsst::afw::image::Exposure`
88 warped and psf-Matched temporary exposure
89 """
90 if makePsfMatched and modelPsf is None:
91 raise RuntimeError("makePsfMatched=True, but no model PSF was provided")
92
93 if not makePsfMatched and not makeDirect:
94 self.log.warning("Neither makeDirect nor makePsfMatched requested")
95
96 # Warp PSF before overwriting exposure
97 xyTransform = afwGeom.makeWcsPairTransform(exposure.getWcs(), wcs)
98 psfWarped = WarpedPsf(exposure.getPsf(), xyTransform)
99
100 if makePsfMatched and maxBBox is not None:
101 # grow warped region to provide sufficient area for PSF-matching
102 pixToGrow = 2 * max(self.psfMatch.kConfig.sizeCellX,
103 self.psfMatch.kConfig.sizeCellY)
104 # replace with copy
105 maxBBox = geom.Box2I(maxBBox)
106 maxBBox.grow(pixToGrow)
107
108 with self.timer("warp"):
109 exposure = self.warper.warpExposure(wcs, exposure, maxBBox=maxBBox, destBBox=destBBox)
110 exposure.setPsf(psfWarped)
111
112 if makePsfMatched:
113 try:
114 exposurePsfMatched = self.psfMatch.run(exposure, modelPsf).psfMatchedExposure
115 except Exception as e:
116 exposurePsfMatched = None
117 self.log.info("Cannot PSF-Match: %s", e)
118
119 return pipeBase.Struct(
120 direct=exposure if makeDirect else None,
121 psfMatched=exposurePsfMatched if makePsfMatched else None
122 )
int max
An integer coordinate rectangle.
Definition Box.h:55
A Psf class that maps an arbitrary Psf through a coordinate transformation.
Definition WarpedPsf.h:52
run(self, exposure, wcs, modelPsf=None, maxBBox=None, destBBox=None, makeDirect=True, makePsfMatched=False)
std::shared_ptr< TransformPoint2ToPoint2 > makeWcsPairTransform(SkyWcs const &src, SkyWcs const &dst)
A Transform obtained by putting two SkyWcs objects "back to back".
Definition SkyWcs.cc:146