lsst.afw  22.0.1-36-g99137b0eb+ec953d57b4
DecoratedImage.cc
Go to the documentation of this file.
1 /*
2  * LSST Data Management System
3  * Copyright 2008, 2009, 2010 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  */
22 
23 /*
24  * An Image with associated metadata
25  */
26 #include <cstdint>
27 #include <iostream>
28 #include "lsst/afw/fits.h"
29 #include "lsst/afw/image/Image.h"
30 
31 namespace lsst {
32 namespace afw {
33 namespace image {
34 
35 template <typename PixelT>
36 void DecoratedImage<PixelT>::init() {
37  // safer to initialize a smart pointer as a named variable
38  std::shared_ptr<daf::base::PropertySet> metadata(new daf::base::PropertyList);
39  setMetadata(metadata);
40  _gain = 0;
41 }
42 
43 template <typename PixelT>
45  : _image(new Image<PixelT>(dimensions)) {
46  init();
47 }
48 template <typename PixelT>
50  init();
51 }
52 template <typename PixelT>
54  init();
55 }
56 template <typename PixelT>
58  : _image(new Image<PixelT>(*src._image, deep)), _gain(src._gain) {
59  setMetadata(src.getMetadata());
60 }
61 template <typename PixelT>
63  DecoratedImage tmp(src);
64  swap(tmp); // See Meyers, Effective C++, Item 11
65 
66  return *this;
67 }
68 
69 template <typename PixelT>
71  using std::swap; // See Meyers, Effective C++, Item 25
72 
73  swap(_image, rhs._image); // just swapping the pointers
74  swap(_gain, rhs._gain);
75 }
76 
77 template <typename PixelT>
79  a.swap(b);
80 }
81 
82 //
83 // FITS code
84 //
85 template <typename PixelT>
86 DecoratedImage<PixelT>::DecoratedImage(const std::string& fileName, const int hdu,
87  lsst::geom::Box2I const& bbox, ImageOrigin const origin,
88  bool allowUnsafe) {
89  init();
91  new Image<PixelT>(fileName, hdu, getMetadata(), bbox, origin, allowUnsafe));
92 }
93 
94 template <typename PixelT>
97  std::string const& mode) const {
98  fits::ImageWriteOptions const options;
99  writeFits(fileName, options, metadata, mode);
100 }
101 
102 template <typename PixelT>
105  std::string const& mode) const {
107 
108  if (metadata_i) {
109  metadata = getMetadata()->deepCopy();
110  metadata->combine(metadata_i);
111  } else {
112  metadata = getMetadata();
113  }
114 
115  getImage()->writeFits(fileName, options, mode, metadata);
116 }
117 
118 //
119 // Explicit instantiations
120 //
121 template class DecoratedImage<std::uint16_t>;
122 template class DecoratedImage<int>;
123 template class DecoratedImage<float>;
124 template class DecoratedImage<double>;
125 template class DecoratedImage<std::uint64_t>;
126 } // namespace image
127 } // namespace afw
128 } // namespace lsst
AmpInfoBoxKey bbox
Definition: Amplifier.cc:117
afw::table::PointKey< int > dimensions
Definition: GaussianPsf.cc:48
std::shared_ptr< RecordT > src
Definition: Match.cc:48
table::Key< int > b
table::Key< int > a
A container for an Image and its associated metadata.
Definition: Image.h:397
void writeFits(std::string const &fileName, std::shared_ptr< lsst::daf::base::PropertySet const > metadata=std::shared_ptr< lsst::daf::base::PropertySet const >(), std::string const &mode="w") const
Write a FITS file.
DecoratedImage(const lsst::geom::Extent2I &dimensions=lsst::geom::Extent2I())
Create an image of the specified size.
DecoratedImage & operator=(const DecoratedImage &image)
Assignment operator.
void swap(DecoratedImage &rhs)
void setMetadata(std::shared_ptr< lsst::daf::base::PropertySet > metadata)
Definition: Image.h:453
A class to represent a 2-dimensional array of pixels.
Definition: Image.h:51
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.
void swap(Image< PixelT > &a, Image< PixelT > &b)
Definition: Image.cc:442
A base class for image defects.
Options for writing an image to FITS.
Definition: fits.h:219
T swap(T... args)