Loading [MathJax]/extensions/tex2jax.js
LSST Applications g04a91732dc+7fec47d7bc,g07dc498a13+5ab4d22ec3,g0fba68d861+565de8e5d5,g1409bbee79+5ab4d22ec3,g1a7e361dbc+5ab4d22ec3,g1fd858c14a+11200c7927,g20f46db602+25d63fd678,g35bb328faa+fcb1d3bbc8,g4d2262a081+61302e889d,g4d39ba7253+d05e267ece,g4e0f332c67+5d362be553,g53246c7159+fcb1d3bbc8,g60b5630c4e+d05e267ece,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g7b71ed6315+fcb1d3bbc8,g8048e755c2+a1301e4c20,g8852436030+163ceb82d8,g89139ef638+5ab4d22ec3,g89e1512fd8+fbb808ebce,g8d6b6b353c+d05e267ece,g9125e01d80+fcb1d3bbc8,g989de1cb63+5ab4d22ec3,g9f33ca652e+8abe617c77,ga9baa6287d+d05e267ece,gaaedd4e678+5ab4d22ec3,gabe3b4be73+1e0a283bba,gb1101e3267+fefe9ce5b1,gb58c049af0+f03b321e39,gb90eeb9370+824c420ec4,gc741bbaa4f+77ddc33078,gcf25f946ba+163ceb82d8,gd315a588df+0f88d5218e,gd6cbbdb0b4+c8606af20c,gd9a9a58781+fcb1d3bbc8,gde0f65d7ad+e6bd566e97,ge278dab8ac+932305ba37,ge82c20c137+76d20ab76d,w.2025.10
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Exposure.cc
Go to the documentation of this file.
1// -*- LSST-C++ -*- // fixed format comment for emacs
2
3/*
4 * LSST Data Management System
5 * Copyright 2008, 2009, 2010 LSST Corporation.
6 *
7 * This product includes software developed by the
8 * LSST Project (http://www.lsst.org/).
9 *
10 * This program is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation, either version 3 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the LSST License Statement and
21 * the GNU General Public License along with this program. If not,
22 * see <http://www.lsstcorp.org/LegalNotices/>.
23 */
24
25#include <memory>
26#include <stdexcept>
27#include <sstream>
28#include <cstdint>
29
30#include "lsst/pex/exceptions.h"
36#include "lsst/afw/fits.h"
38
39namespace lsst {
40namespace afw {
41namespace image {
42
43// CLASS CONSTRUCTORS and DESTRUCTOR
44
45template <typename ImageT, typename MaskT, typename VarianceT>
46Exposure<ImageT, MaskT, VarianceT>::Exposure(unsigned int width, unsigned int height,
48 : _maskedImage(width, height), _info(new ExposureInfo(wcs)) {}
49
50template <typename ImageT, typename MaskT, typename VarianceT>
53 : _maskedImage(dimensions), _info(new ExposureInfo(wcs)) {}
54
55template <typename ImageT, typename MaskT, typename VarianceT>
59
60template <typename ImageT, typename MaskT, typename VarianceT>
63 : _maskedImage(maskedImage), _info(new ExposureInfo(wcs)) {}
64
65template <typename ImageT, typename MaskT, typename VarianceT>
67 : _maskedImage(maskedImage), _info(info ? info : std::make_shared<ExposureInfo>()) {}
68
69template <typename ImageT, typename MaskT, typename VarianceT>
71 : _maskedImage(src.getMaskedImage(), deep), _info(new ExposureInfo(*src.getInfo(), deep)) {}
72// Delegate to copy-constructor for backwards compatibility
73template <typename ImageT, typename MaskT, typename VarianceT>
75
76template <typename ImageT, typename MaskT, typename VarianceT>
78 ImageOrigin const origin, bool const deep)
79 : _maskedImage(src.getMaskedImage(), bbox, origin, deep),
80 _info(new ExposureInfo(*src.getInfo(), deep)) {}
81
82template <typename ImageT, typename MaskT, typename VarianceT>
84 ImageOrigin origin, bool conformMasks, bool allowUnsafe)
85 : _maskedImage(), _info(new ExposureInfo()) {
86 ExposureFitsReader reader(fileName);
87 *this = reader.read<ImageT, MaskT, VarianceT>(bbox, origin, conformMasks, allowUnsafe);
88}
89
90template <typename ImageT, typename MaskT, typename VarianceT>
92 ImageOrigin origin, bool conformMasks, bool allowUnsafe)
93 : _maskedImage(), _info(new ExposureInfo()) {
94 ExposureFitsReader reader(manager);
95 *this = reader.read<ImageT, MaskT, VarianceT>(bbox, origin, conformMasks, allowUnsafe);
96}
97
98template <typename ImageT, typename MaskT, typename VarianceT>
100 ImageOrigin origin, bool conformMasks, bool allowUnsafe) {
101 ExposureFitsReader reader(&fitsFile);
102 *this = reader.read<ImageT, MaskT, VarianceT>(bbox, origin, conformMasks, allowUnsafe);
103}
104
105template <typename ImageT, typename MaskT, typename VarianceT>
107
108// SET METHODS
110template <typename ImageT, typename MaskT, typename VarianceT>
112 _maskedImage = maskedImage;
113}
114
115template <typename ImageT, typename MaskT, typename VarianceT>
117 lsst::geom::Point2I old(_maskedImage.getXY0());
118 if (_info->hasWcs()) {
119 auto shift = lsst::geom::Extent2D(origin - old);
120 auto newWcs = _info->getWcs()->copyAtShiftedPixelOrigin(shift);
121 _info->setWcs(newWcs);
122 }
123 _maskedImage.setXY0(origin);
124}
125
126template <typename ImageT, typename MaskT, typename VarianceT>
127Exposure<ImageT, MaskT, VarianceT> &Exposure<ImageT, MaskT, VarianceT>::operator=(Exposure const &) = default;
128template <typename ImageT, typename MaskT, typename VarianceT>
129Exposure<ImageT, MaskT, VarianceT> &Exposure<ImageT, MaskT, VarianceT>::operator=(Exposure &&) = default;
130
131// Write FITS
133template <typename ImageT, typename MaskT, typename VarianceT>
136 writeFits(fitsfile);
137}
138
139template <typename ImageT, typename MaskT, typename VarianceT>
144
145template <typename ImageT, typename MaskT, typename VarianceT>
147 writeFits(fitsfile, fits::ImageWriteOptions(*_maskedImage.getImage()),
148 fits::ImageWriteOptions(*_maskedImage.getMask()),
149 fits::ImageWriteOptions(*_maskedImage.getVariance()));
150}
151
152template <typename ImageT, typename MaskT, typename VarianceT>
154 fits::ImageWriteOptions const &imageOptions,
155 fits::ImageWriteOptions const &maskOptions,
156 fits::ImageWriteOptions const &varianceOptions) const {
158 writeFits(fitsfile, imageOptions, maskOptions, varianceOptions);
159}
161template <typename ImageT, typename MaskT, typename VarianceT>
163 fits::ImageWriteOptions const &imageOptions,
164 fits::ImageWriteOptions const &maskOptions,
165 fits::ImageWriteOptions const &varianceOptions) const {
167 writeFits(fitsfile, imageOptions, maskOptions, varianceOptions);
170template <typename ImageT, typename MaskT, typename VarianceT>
172 fits::ImageWriteOptions const &imageOptions,
173 fits::ImageWriteOptions const &maskOptions,
174 fits::ImageWriteOptions const &varianceOptions) const {
175 ExposureInfo::FitsWriteData data = _info->_startWriteFits(getXY0());
176 _maskedImage.writeFits(fitsfile, imageOptions, maskOptions, varianceOptions, data.metadata,
177 data.imageMetadata, data.maskMetadata, data.varianceMetadata);
178 _info->_finishWriteFits(fitsfile, data);
179}
180
181namespace {
190template <class ExposureT>
191void _copyCommonPixels(ExposureT &destination, ExposureT const &source) {
192 lsst::geom::Box2I overlapBox = destination.getBBox();
193 overlapBox.clip(source.getBBox());
194
195 // MaskedImage::assign interprets empty bounding box as "whole image"
196 if (!overlapBox.isEmpty()) {
197 typename ExposureT::MaskedImageT overlapPixels(source.getMaskedImage(), overlapBox);
198 destination.getMaskedImage().assign(overlapPixels, overlapBox);
199 }
200}
201} // namespace
202
203template <typename ImageT, typename MaskT, typename VarianceT>
205 lsst::geom::SpherePoint const &center, lsst::geom::Extent2I const &size) const {
206 if (!hasWcs()) {
207 throw LSST_EXCEPT(pex::exceptions::LogicError, "Cannot look up source position without WCS.");
208 }
209 lsst::geom::Point2D pixelCenter = getWcs()->skyToPixel(center);
210
211 return getCutout(pixelCenter, size);
212}
213
214template <typename ImageT, typename MaskT, typename VarianceT>
216 lsst::geom::Point2D const &center, lsst::geom::Extent2I const &size) const {
217 if (!lsst::geom::Box2D(getBBox()).contains(center)) {
218 std::stringstream buffer;
219 buffer << "Point " << center << " lies at pixel " << center << ", which lies outside Exposure "
220 << getBBox();
222 }
223 if (size[0] <= 0 || size[1] <= 0) {
224 std::stringstream buffer;
225 buffer << "Cannot create bounding box with dimensions " << size;
227 }
229
230 // cutout must have independent ExposureInfo
231 auto copyInfo = std::make_shared<ExposureInfo>(*getInfo());
232 MaskedImageT blank(bbox); // Can't initialize Exposure with a temporary
235 Exposure cutout(blank, copyInfo);
236
237 _copyCommonPixels(cutout, *this);
238 return cutout;
239}
240
241template <typename ImageT, typename MaskT, typename VarianceT>
246
247// Explicit instantiations
249template class Exposure<std::uint16_t>;
250template class Exposure<int>;
251template class Exposure<float>;
252template class Exposure<double>;
253template class Exposure<std::uint64_t>;
255} // namespace image
256} // namespace afw
257} // namespace lsst
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition Exception.h:48
A simple struct that combines the two arguments that must be passed to most cfitsio routines and cont...
Definition fits.h:308
Lifetime-management for memory that goes into FITS memory files.
Definition fits.h:125
A FITS reader class for Exposures and their components.
Exposure< ImagePixelT, MaskPixelT, VariancePixelT > read(lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool conformMasks=false, bool allowUnsafe=false)
Read the full Exposure.
A class to contain the data, WCS, and other information needed to describe an image of the sky.
Definition Exposure.h:72
MaskedImageT getMaskedImage()
Return the MaskedImage.
Definition Exposure.h:228
bool hasWcs() const
Does this Exposure have a Wcs?
Definition Exposure.h:316
Exposure getCutout(lsst::geom::SpherePoint const &center, lsst::geom::Extent2I const &size) const
Return an Exposure that is a small cutout of the original.
Definition Exposure.cc:204
std::shared_ptr< ExposureInfo > getInfo()
Get the ExposureInfo that aggregates all the non-image components. Never null.
Definition Exposure.h:322
void writeFits(std::string const &fileName) const
Write an Exposure to a regular multi-extension FITS file.
Definition Exposure.cc:134
Exposure(unsigned int width, unsigned int height, std::shared_ptr< geom::SkyWcs const > wcs=std::shared_ptr< geom::SkyWcs const >())
Construct an Exposure with a blank MaskedImage of specified size (default 0x0) and a SkyWcs (which ma...
Definition Exposure.cc:46
std::shared_ptr< geom::SkyWcs const > getWcs() const
Definition Exposure.h:232
Exposure & operator=(Exposure const &)
lsst::geom::Point2I getXY0() const
Return the Exposure's origin.
Definition Exposure.h:273
void setXY0(lsst::geom::Point2I const &origin)
Set the Exposure's origin (including correcting the Wcs)
Definition Exposure.cc:116
void setMaskedImage(MaskedImageT &maskedImage)
Set the MaskedImage of the Exposure.
Definition Exposure.cc:111
MaskedImage< ImageT, MaskT, VarianceT > MaskedImageT
Definition Exposure.h:74
lsst::geom::Box2I getBBox(ImageOrigin const origin=PARENT) const
Definition Exposure.h:275
A collection of all the things that make an Exposure different from a MaskedImage.
A floating-point coordinate rectangle geometry.
Definition Box.h:413
An integer coordinate rectangle.
Definition Box.h:55
void clip(Box2I const &other) noexcept
Shrink this to ensure that other.contains(*this).
Definition Box.cc:189
bool isEmpty() const noexcept
Return true if the box contains no points.
Definition Box.h:213
static Box2I makeCenteredBox(Point2D const &center, Extent const &size)
Create a box centered as closely as possible on a particular point.
Definition Box.cc:97
Extent2I const getDimensions() const noexcept
Definition Box.h:186
Point2D const getCenter() const noexcept
1-d interval accessors
Definition Box.cc:93
Point in an unspecified spherical coordinate system.
Definition SpherePoint.h:57
Reports invalid arguments.
Definition Runtime.h:66
Reports errors in the logical structure of the program.
Definition Runtime.h:46
T make_shared(T... args)
ImageT::SinglePixel edgePixel(lsst::afw::image::detail::Image_tag)
Return an off-the-edge pixel appropriate for a given Image type.
Extent< double, 2 > Extent2D
Definition Extent.h:400
Point< double, 2 > Point2D
Definition Point.h:324
Extent< int, 2 > Extent2I
Definition Extent.h:397
Point< int, 2 > Point2I
Definition Point.h:321
STL namespace.
T str(T... args)
Options for writing an image to FITS.
Definition fits.h:223
typename ImageT::image_category image_category
Definition ImageBase.h:67