LSST Applications g042eb84c57+730a74494b,g04e9c324dd+8c5ae1fdc5,g134cb467dc+1f1e3e7524,g199a45376c+0ba108daf9,g1fd858c14a+fa7d31856b,g210f2d0738+f66ac109ec,g262e1987ae+83a3acc0e5,g29ae962dfc+d856a2cb1f,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+a1e0c9f713,g47891489e3+0d594cb711,g4d44eb3520+c57ec8f3ed,g4d7b6aa1c5+f66ac109ec,g53246c7159+8c5ae1fdc5,g56a1a4eaf3+fd7ad03fde,g64539dfbff+f66ac109ec,g67b6fd64d1+0d594cb711,g67fd3c3899+f66ac109ec,g6985122a63+0d594cb711,g74acd417e5+3098891321,g786e29fd12+668abc6043,g81db2e9a8d+98e2ab9f28,g87389fa792+8856018cbb,g89139ef638+0d594cb711,g8d7436a09f+80fda9ce03,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+a8a29bda4b,g99822b682c+e3ec3c61f9,g9d5c6a246b+0d5dac0c3d,ga41d0fce20+9243b26dd2,gbf99507273+8c5ae1fdc5,gd7ef33dd92+0d594cb711,gdab6d2f7ff+3098891321,ge410e46f29+0d594cb711,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.38
LSST Data Management Base Package
Loading...
Searching...
No Matches
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
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
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
An integer coordinate rectangle.
Definition Box.h:55
const int DEFAULT_HDU
Specify that the default HDU should be read.
Point< int, 2 > Point2I
Definition Point.h:321
STL namespace.