LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
MaskedImageFitsReader.h
Go to the documentation of this file.
1 /*
2  * Developed for the LSST Data Management System.
3  * This product includes software developed by the LSST Project
4  * (https://www.lsst.org).
5  * See the COPYRIGHT file at the top-level directory of this distribution
6  * for details of code ownership.
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 GNU General Public License
19  * along with this program. If not, see <https://www.gnu.org/licenses/>.
20  */
21 
22 #ifndef LSST_AFW_IMAGE_MASKEDIMAGEFITSREADER_H
23 #define LSST_AFW_IMAGE_MASKEDIMAGEFITSREADER_H
24 
25 
29 
30 namespace lsst { namespace afw { namespace image {
31 
42 public:
43 
51  explicit MaskedImageFitsReader(std::string const& fileName, int hdu=fits::DEFAULT_HDU);
52 
61 
68  explicit MaskedImageFitsReader(fits::Fits * fitsFile);
69 
70  // FITS readers are not copyable, movable, or assignable.
75 
77 
79 
85  std::string readImageDType() const;
86  std::string readMaskDType() const;
87  std::string readVarianceDType() const;
89 
98 
108  lsst::geom::Box2I const & bbox=lsst::geom::Box2I(),
109  ImageOrigin origin=PARENT
110  );
111 
113 
116  std::shared_ptr<daf::base::PropertyList> readPrimaryMetadata();
117  std::shared_ptr<daf::base::PropertyList> readImageMetadata();
118  std::shared_ptr<daf::base::PropertyList> readMaskMetadata();
119  std::shared_ptr<daf::base::PropertyList> readVarianceMetadata();
121 
123 
136  template <typename ImagePixelT>
137  Image<ImagePixelT> readImage(lsst::geom::Box2I const & bbox=lsst::geom::Box2I(),
138  ImageOrigin origin=PARENT, bool allowUnsafe=false);
139  template <typename ImagePixelT>
140  ndarray::Array<ImagePixelT, 2, 2> readImageArray(lsst::geom::Box2I const & bbox=lsst::geom::Box2I(),
141  ImageOrigin origin=PARENT, bool allowUnsafe=false);
143 
159  template <typename MaskPixelT>
160  Mask<MaskPixelT> readMask(lsst::geom::Box2I const & bbox=lsst::geom::Box2I(),
161  ImageOrigin origin=PARENT, bool conformMasks=false,
162  bool allowUnsafe=false);
163 
177  template <typename MaskPixelT>
178  ndarray::Array<MaskPixelT, 2, 2> readMaskArray(lsst::geom::Box2I const & bbox=lsst::geom::Box2I(),
179  ImageOrigin origin=PARENT, bool allowUnsafe=false);
180 
182 
195  template <typename VariancePixelT>
196  Image<VariancePixelT> readVariance(lsst::geom::Box2I const & bbox=lsst::geom::Box2I(),
197  ImageOrigin origin=PARENT, bool allowUnsafe=false);
198  template <typename VariancePixelT>
199  ndarray::Array<VariancePixelT, 2, 2> readVarianceArray(lsst::geom::Box2I const & bbox=lsst::geom::Box2I(),
200  ImageOrigin origin=PARENT, bool allowUnsafe=false);
202 
221  template <typename ImagePixelT, typename MaskPixelT=MaskPixel, typename VariancePixelT=VariancePixel>
222  MaskedImage<ImagePixelT, MaskPixelT, VariancePixelT> read(
223  lsst::geom::Box2I const & bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT,
224  bool conformMasks=false, bool needAllHdus=false, bool allowUnsafe=false
225  );
226 
230  std::string getFileName() const { return _imageReader.getFileName(); }
231 
232 private:
233 
234  friend class ExposureFitsReader;
235 
236  fits::Fits * _getFitsFile() { return _imageReader._fitsFile; }
237 
241  ImageFitsReader _imageReader;
242  MaskFitsReader _maskReader;
243  ImageFitsReader _varianceReader;
244 };
245 
246 }}} // namespace lsst::afw::image
247 
248 #endif // !LSST_AFW_IMAGE_MASKEDIMAGEFITSREADER_H
AmpInfoBoxKey bbox
Definition: Amplifier.cc:117
A simple struct that combines the two arguments that must be passed to most cfitsio routines and cont...
Definition: fits.h:297
Lifetime-management for memory that goes into FITS memory files.
Definition: fits.h:121
A FITS reader class for Exposures and their components.
std::string getFileName() const
Return the name of the file this reader targets.
A FITS reader class for regular Images.
A class to represent a 2-dimensional array of pixels.
Definition: Image.h:51
A FITS reader class for Masks.
Represent a 2-dimensional array of bitmask pixels.
Definition: Mask.h:77
A FITS reader class for MaskedImages and their components.
std::string getFileName() const
Return the name of the file this reader targets.
std::string readMaskDType() const
Read a string describing the pixel type of the on-disk image plane.
std::shared_ptr< daf::base::PropertyList > readImageMetadata()
Read the FITS header of one of the HDUs.
std::shared_ptr< daf::base::PropertyList > readPrimaryMetadata()
Read the FITS header of one of the HDUs.
std::string readVarianceDType() const
Read a string describing the pixel type of the on-disk image plane.
MaskedImageFitsReader & operator=(MaskedImageFitsReader &&)=delete
ndarray::Array< MaskPixelT, 2, 2 > readMaskArray(lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false)
Read the mask plane.
MaskedImageFitsReader(std::string const &fileName, int hdu=fits::DEFAULT_HDU)
Construct a FITS reader object.
std::shared_ptr< daf::base::PropertyList > readMaskMetadata()
Read the FITS header of one of the HDUs.
std::string readImageDType() const
Read a string describing the pixel type of the on-disk image plane.
ndarray::Array< ImagePixelT, 2, 2 > readImageArray(lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false)
Read the image plane.
std::shared_ptr< daf::base::PropertyList > readVarianceMetadata()
Read the FITS header of one of the HDUs.
MaskedImageFitsReader(MaskedImageFitsReader &&)=delete
ndarray::Array< VariancePixelT, 2, 2 > readVarianceArray(lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false)
Read the variance plane.
Mask< MaskPixelT > readMask(lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool conformMasks=false, bool allowUnsafe=false)
Read the mask plane.
MaskedImageFitsReader(MaskedImageFitsReader const &)=delete
lsst::geom::Box2I readBBox(ImageOrigin origin=PARENT)
Read the bounding box of the on-disk image.
MaskedImageFitsReader & operator=(MaskedImageFitsReader const &)=delete
MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > read(lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool conformMasks=false, bool needAllHdus=false, bool allowUnsafe=false)
Read the full MaskedImage.
Image< ImagePixelT > readImage(lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false)
Read the image plane.
Image< VariancePixelT > readVariance(lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false)
Read the variance plane.
lsst::geom::Point2I readXY0(lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT)
Read the image origin from the on-disk image or a subimage thereof.
A class to manipulate images, masks, and variance as a single object.
Definition: MaskedImage.h:73
An integer coordinate rectangle.
Definition: Box.h:55
const int DEFAULT_HDU
Specify that the default HDU should be read.
Definition: fitsDefaults.h:18
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.
float VariancePixel
default type for MaskedImage variance images
class[[deprecated("Removed with no replacement (but see lsst::afw::image::TransmissionCurve). Will be " "removed after v22.")]] FilterProperty final
Describe the properties of a Filter (e.g.
Definition: Filter.h:53
Point< int, 2 > Point2I
Definition: Point.h:321
A base class for image defects.
STL namespace.