LSSTApplications  19.0.0+10,19.0.0+80,19.0.0-1-g20d9b18+31,19.0.0-1-g49a97f9+4,19.0.0-1-g8c57eb9+31,19.0.0-1-g9a028c0+13,19.0.0-1-ga72da6b+3,19.0.0-1-gb77924a+15,19.0.0-1-gbfe0924+66,19.0.0-1-gc3516c3,19.0.0-1-gefe1d0d+49,19.0.0-1-gf8cb8b4+3,19.0.0-14-g7511ce4+6,19.0.0-16-g3dc1a33c+6,19.0.0-17-g59f0e8a+4,19.0.0-17-g9c22e3c+9,19.0.0-18-g35bb99870+2,19.0.0-19-g2772d4a+9,19.0.0-2-g260436e+53,19.0.0-2-g31cdcee,19.0.0-2-g9675b69+3,19.0.0-2-gaa2795f,19.0.0-2-gbcc4de1,19.0.0-2-gd6f004e+6,19.0.0-2-gde8e5e3+5,19.0.0-2-gff6972b+15,19.0.0-21-ge306cd8,19.0.0-21-gf122e69+2,19.0.0-3-g2d43a51+2,19.0.0-3-gf3b1435+6,19.0.0-4-g56feb96,19.0.0-4-gac56cce+17,19.0.0-49-gce872c1+1,19.0.0-5-g66946eb+6,19.0.0-5-gd8897ba+6,19.0.0-51-gfc4a647e,19.0.0-7-g686a884+5,19.0.0-7-g886f805+5,19.0.0-8-g305ff64,w.2020.17
LSSTDataManagementBasePackage
Image.h
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
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 /*
26  * 2-D images
27  *
28  * This file contains the 2-d image support for LSST
29  */
30 #ifndef LSST_AFW_IMAGE_IMAGE_H
31 #define LSST_AFW_IMAGE_IMAGE_H
32 
33 #include <string>
34 #include <utility>
35 #include <functional>
36 
37 #include "boost/mpl/bool.hpp"
38 #include <climits>
39 #include <memory>
40 
41 #include "lsst/geom.h"
43 #include "lsst/afw/image/lsstGil.h"
45 #include "lsst/afw/image/Mask.h"
46 #include "lsst/afw/math/Function.h"
47 #include "lsst/afw/fitsDefaults.h"
49 #include "lsst/pex/exceptions.h"
50 #include "ndarray.h"
51 
52 namespace lsst {
53 namespace afw {
54 namespace image {
55 
57 template <typename PixelT>
58 class Image : public ImageBase<PixelT> {
59 public:
60  template <typename, typename, typename>
61  friend class MaskedImage;
62 
64 
66  template <typename ImagePT = PixelT>
70  };
71  template <typename OtherPixelT>
72  friend class Image; // needed by generalised copy constructors
73 
84  explicit Image(unsigned int width, unsigned int height, PixelT initialValue = 0);
94  explicit Image(lsst::geom::Extent2I const& dimensions = lsst::geom::Extent2I(), PixelT initialValue = 0);
101  explicit Image(lsst::geom::Box2I const& bbox, PixelT initialValue = 0);
102 
116  explicit Image(Image const& rhs, lsst::geom::Box2I const& bbox, ImageOrigin const origin = PARENT,
117  const bool deep = false);
127  Image(const Image& rhs, const bool deep = false);
128  Image(Image&& rhs);
129 
144  explicit Image(std::string const& fileName, int hdu = fits::DEFAULT_HDU,
148  bool allowUnsafe = false);
149 
164  explicit Image(fits::MemFileManager& manager, int hdu = fits::DEFAULT_HDU,
168  bool allowUnsafe = false);
169 
181  explicit Image(fits::Fits& fitsfile,
185  bool allowUnsafe = false);
186 
187  // generalised copy constructor
188  template <typename OtherPixelT>
189  Image(Image<OtherPixelT> const& rhs, const bool deep) : image::ImageBase<PixelT>(rhs, deep) {}
190 
191  explicit Image(ndarray::Array<PixelT, 2, 1> const& array, bool deep = false,
193  : image::ImageBase<PixelT>(array, deep, xy0) {}
194 
195  ~Image() override = default;
196  //
197  // Assignment operators are not inherited
198  //
200  Image& operator=(const PixelT rhs);
210  Image& operator=(const Image& rhs);
211  Image& operator=(Image&& rhs);
212 
227  return Image(*this, bbox, origin, false);
228  }
229 
231  Image operator[](lsst::geom::Box2I const& bbox) const { return subset(bbox); }
232 
234 
242  void writeFits(std::string const& fileName,
245  std::string const& mode = "w") const;
246 
254  void writeFits(fits::MemFileManager& manager,
257  std::string const& mode = "w") const;
258 
267 
277  void writeFits(std::string const& filename, fits::ImageWriteOptions const& options,
278  std::string const& mode = "w",
280  std::shared_ptr<Mask<MaskPixel> const> mask = nullptr) const;
281 
291  void writeFits(fits::MemFileManager& manager, fits::ImageWriteOptions const& options,
292  std::string const& mode = "w",
294  std::shared_ptr<Mask<MaskPixel> const> mask = nullptr) const;
295 
304  void writeFits(fits::Fits& fitsfile, fits::ImageWriteOptions const& options,
306  std::shared_ptr<Mask<MaskPixel> const> mask = nullptr) const;
307 
316  static Image readFits(std::string const& filename, int hdu = fits::DEFAULT_HDU) {
317  return Image<PixelT>(filename, hdu);
318  }
319 
328  static Image readFits(fits::MemFileManager& manager, int hdu = fits::DEFAULT_HDU) {
329  return Image<PixelT>(manager, hdu);
330  }
331 
332  void swap(Image& rhs);
333  //
334  // Operators etc.
335  //
337  Image& operator+=(PixelT const rhs);
339  virtual Image& operator+=(Image<PixelT> const& rhs);
347  void scaledPlus(double const c, Image<PixelT> const& rhs);
349  Image& operator-=(PixelT const rhs);
351  Image& operator-=(Image<PixelT> const& rhs);
359  void scaledMinus(double const c, Image<PixelT> const& rhs);
361  Image& operator*=(PixelT const rhs);
363  Image& operator*=(Image<PixelT> const& rhs);
365  void scaledMultiplies(double const c, Image<PixelT> const& rhs);
371  Image& operator/=(PixelT const rhs);
373  Image& operator/=(Image<PixelT> const& rhs);
375  void scaledDivides(double const c, Image<PixelT> const& rhs);
376 
377  // In-place per-pixel sqrt(). Useful when handling variance planes.
378  void sqrt();
379 
380 protected:
382 };
383 
385 template <typename LhsPixelT, typename RhsPixelT>
388 template <typename LhsPixelT, typename RhsPixelT>
391 template <typename LhsPixelT, typename RhsPixelT>
394 template <typename LhsPixelT, typename RhsPixelT>
396 
397 template <typename PixelT>
399 
403 template <typename PixelT>
405 public:
420  explicit DecoratedImage(const lsst::geom::Box2I& bbox);
437  DecoratedImage(DecoratedImage const& rhs, const bool deep = false);
448  explicit DecoratedImage(std::string const& fileName, const int hdu = fits::DEFAULT_HDU,
449  lsst::geom::Box2I const& bbox = lsst::geom::Box2I(),
450  ImageOrigin const origin = PARENT, bool allowUnsafe = false);
451 
458 
460  void setMetadata(std::shared_ptr<lsst::daf::base::PropertySet> metadata) { _metadata = metadata; }
461 
463  int getWidth() const { return _image->getWidth(); }
465  int getHeight() const { return _image->getHeight(); }
466 
468  int getX0() const { return _image->getX0(); }
470  int getY0() const { return _image->getY0(); }
471 
473  const lsst::geom::Extent2I getDimensions() const { return _image->getDimensions(); }
474 
475  void swap(DecoratedImage& rhs);
476 
484  void writeFits(std::string const& fileName,
487  std::string const& mode = "w") const;
488 
497  void writeFits(std::string const& fileName, fits::ImageWriteOptions const& options,
500  std::string const& mode = "w") const;
501 
505  std::shared_ptr<Image<PixelT> const> getImage() const { return _image; }
506 
512  double getGain() const { return _gain; }
514  void setGain(double gain) { _gain = gain; }
515 
516 private:
519 
520  double _gain;
521 
522  void init();
523 };
524 
525 template <typename PixelT>
527 
533 
537 template <typename T1, typename T2>
538 bool imagesOverlap(ImageBase<T1> const& image1, ImageBase<T2> const& image2);
539 
540 } // namespace image
541 } // namespace afw
542 } // namespace lsst
543 
544 #endif
AmpInfoBoxKey bbox
Definition: Amplifier.cc:117
std::shared_ptr< Image< PixelT > > getImage()
Return a shared_ptr to the DecoratedImage&#39;s Image.
Definition: Image.h:503
Image operator[](lsst::geom::Box2I const &bbox) const
Return a subimage corresponding to the given box (interpreted as PARENT coordinates).
Definition: Image.h:231
std::shared_ptr< Image< PixelT > const > getImage() const
Return a shared_ptr to the DecoratedImage&#39;s Image as const.
Definition: Image.h:505
A templated class to return this classes&#39; type (present in Image/Mask/MaskedImage) ...
Definition: Image.h:67
Image & operator=(const PixelT rhs)
Set the image&#39;s pixels to rhs.
Definition: Image.cc:350
Image & operator*=(PixelT const rhs)
Multiply lhs by scalar rhs.
Definition: Image.cc:558
std::shared_ptr< lsst::daf::base::PropertySet > getMetadata() const
Definition: Image.h:459
int getWidth() const
Return the number of columns in the image.
Definition: Image.h:463
int getHeight() const
Return the number of rows in the image.
Definition: Image.h:465
afw::table::Key< afw::table::Array< MaskPixelT > > mask
def init()
Definition: tests.py:65
table::Key< int > b
Options for writing an image to FITS.
Definition: fits.h:219
Image & operator/=(PixelT const rhs)
Divide lhs by scalar rhs.
Definition: Image.cc:590
table::Key< int > a
void scaledDivides(double const c, Image< PixelT > const &rhs)
Divide lhs by Image c*rhs (i.e. pixel-by-pixel division)
Definition: Image.cc:625
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 an image to a regular FITS file.
void setMetadata(std::shared_ptr< lsst::daf::base::PropertySet > metadata)
Definition: Image.h:460
A simple struct that combines the two arguments that must be passed to most cfitsio routines and cont...
Definition: fits.h:297
The base class for all image classed (Image, Mask, MaskedImage, ...)
Definition: ImageBase.h:102
Image subset(lsst::geom::Box2I const &bbox, ImageOrigin origin=PARENT) const
Return a subimage corresponding to the given box.
Definition: Image.h:226
A Function taking two arguments.
Definition: Function.h:259
STL class.
Image & operator-=(PixelT const rhs)
Subtract scalar rhs from lhs.
Definition: Image.cc:513
afw::table::PointKey< int > dimensions
Definition: GaussianPsf.cc:49
A base class for image defects.
table::Key< double > gain
Definition: Amplifier.cc:118
Represent a 2-dimensional array of bitmask pixels.
Definition: Mask.h:77
Image(ndarray::Array< PixelT, 2, 1 > const &array, bool deep=false, lsst::geom::Point2I const &xy0=lsst::geom::Point2I())
Definition: Image.h:191
Lifetime-management for memory that goes into FITS memory files.
Definition: fits.h:121
A class to manipulate images, masks, and variance as a single object.
Definition: MaskedImage.h:73
Image & operator+=(PixelT const rhs)
Add scalar rhs to lhs.
Definition: Image.cc:468
bool imagesOverlap(ImageBase< T1 > const &image1, ImageBase< T2 > const &image2)
Return true if the pixels for two images or masks overlap in memory.
Definition: Image.cc:706
void setGain(double gain)
Set the DecoratedImage&#39;s gain.
Definition: Image.h:514
void scaledPlus(double const c, Image< PixelT > const &rhs)
Add Image c*rhs to lhs.
Definition: Image.cc:500
~Image() override=default
friend class DecoratedImage
Definition: ImageBase.h:166
void scaledMultiplies(double const c, Image< PixelT > const &rhs)
Multiply lhs by Image c*rhs (i.e. pixel-by-pixel multiplication)
Definition: Image.cc:577
Class for storing generic metadata.
Definition: PropertySet.h:67
int getX0() const
Return the image&#39;s column-origin.
Definition: Image.h:468
const lsst::geom::Extent2I getDimensions() const
Return the image&#39;s size; useful for passing to constructors.
Definition: Image.h:473
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects...
friend class Image
Definition: Image.h:72
Image(Image< OtherPixelT > const &rhs, const bool deep)
Definition: Image.h:189
static Image readFits(std::string const &filename, int hdu=fits::DEFAULT_HDU)
Read an Image from a regular FITS file.
Definition: Image.h:316
An integer coordinate rectangle.
Definition: Box.h:55
void swap(Image &rhs)
Definition: Image.cc:449
static Image readFits(fits::MemFileManager &manager, int hdu=fits::DEFAULT_HDU)
Read an Image from a FITS RAM file.
Definition: Image.h:328
lsst::geom::Box2I bboxFromMetadata(daf::base::PropertySet &metadata)
Determine the image bounding box from its metadata (FITS header)
Definition: Image.cc:694
int getY0() const
Return the image&#39;s row-origin.
Definition: Image.h:470
A class to represent a 2-dimensional array of pixels.
Definition: Image.h:58
detail::Image_tag image_category
Definition: Image.h:63
double getGain() const
Return the DecoratedImage&#39;s gain.
Definition: Image.h:512
Image< ImagePT > type
Return the desired type.
Definition: Image.h:69
A container for an Image and its associated metadata.
Definition: Image.h:404
void scaledMinus(double const c, Image< PixelT > const &rhs)
Subtract Image c*rhs from lhs.
Definition: Image.cc:532
const int DEFAULT_HDU
Specify that the default HDU should be read.
Definition: fitsDefaults.h:18