lsst.afw g44befd6440+dd219f3bc1
ImageBaseFitsReader.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_IMAGEBASEFITSREADER_H
23#define LSST_AFW_IMAGE_IMAGEBASEFITSREADER_H
24
25#include <string>
26#include <memory>
27
28#include "lsst/geom/Box.h"
30#include "lsst/afw/fits.h"
31
32namespace lsst { namespace afw { namespace image {
33
48public:
49
57 explicit ImageBaseFitsReader(std::string const& fileName, int hdu=fits::DEFAULT_HDU);
58
67
74 explicit ImageBaseFitsReader(fits::Fits * fitsFile);
75
76 // FITS readers are not copyable, movable, or assignable.
81
88 std::string readDType() const;
89
98
109 ImageOrigin origin=PARENT
110 );
111
116
126 template <typename T>
127 ndarray::Array<T, 2, 2> readArray(
128 lsst::geom::Box2I const & bbox,
129 ImageOrigin origin=PARENT,
130 bool allowUnsafe=false
131 );
132
136 int getHdu() const noexcept { return _hdu; }
137
141 std::string getFileName() const { return _fitsFile->getFileName(); }
142
143protected:
144
145 // This class should never be directly instantiated, and should never
146 // be deleted through a base-class pointer.
147 ~ImageBaseFitsReader() noexcept;
148
149private:
150
152
153 bool _ownsFitsFile;
154 int _hdu;
155 fits::Fits * _fitsFile;
156 lsst::geom::Box2I _bbox;
157 std::shared_ptr<daf::base::PropertyList> _metadata;
158};
159
160}}} // namespace lsst::afw::image
161
162#endif // !LSST_AFW_IMAGE_IMAGEBASEFITSREADER_H
AmpInfoBoxKey bbox
Definition: Amplifier.cc:117
Fits * fits
Definition: FitsWriter.cc:90
A simple struct that combines the two arguments that must be passed to most cfitsio routines and cont...
Definition: fits.h:297
std::string getFileName() const
Return the file name associated with the FITS object or "<unknown>" if there is none.
Definition: fits.cc:498
Lifetime-management for memory that goes into FITS memory files.
Definition: fits.h:121
Base class for image FITS readers.
ImageBaseFitsReader(ImageBaseFitsReader &&)=delete
ImageBaseFitsReader & operator=(ImageBaseFitsReader const &)=delete
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.
std::shared_ptr< daf::base::PropertyList > readMetadata()
Read the image's FITS header.
ImageBaseFitsReader & operator=(ImageBaseFitsReader &&)=delete
ndarray::Array< T, 2, 2 > readArray(lsst::geom::Box2I const &bbox, ImageOrigin origin=PARENT, bool allowUnsafe=false)
Read the image's data array.
std::string getFileName() const
Return the name of the file this reader targets.
int getHdu() const noexcept
Return the HDU this reader targets.
lsst::geom::Box2I readBBox(ImageOrigin origin=PARENT)
Read the bounding box of the on-disk image.
std::string readDType() const
Read a string describing the pixel type of the on-disk image.
ImageBaseFitsReader(std::string const &fileName, int hdu=fits::DEFAULT_HDU)
Construct a FITS reader object.
ImageBaseFitsReader(ImageBaseFitsReader const &)=delete
A FITS reader class for MaskedImages and their components.
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.
A base class for image defects.
STL namespace.