lsst.afw g28e9080985+60ce4897b0
ExposureFitsReader.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_EXPOSUREFITSREADER_H
23#define LSST_AFW_IMAGE_EXPOSUREFITSREADER_H
24
28
29namespace lsst {
30namespace afw {
31namespace image {
32
43public:
49 explicit ExposureFitsReader(std::string const &fileName);
50
57
64 explicit ExposureFitsReader(fits::Fits *fitsFile);
65
66 // FITS readers are not copyable, movable, or assignable.
71
73
75
81 std::string readImageDType() const;
82 std::string readMaskDType() const;
83 std::string readVarianceDType() const;
85
93 lsst::geom::Box2I readBBox(ImageOrigin origin = PARENT);
94
102 lsst::geom::Point2I readXY0(lsst::geom::Box2I const &bbox = lsst::geom::Box2I(),
103 ImageOrigin origin = PARENT);
104
105
110
117 std::shared_ptr<daf::base::PropertyList> readMetadata();
118
120 std::shared_ptr<afw::geom::SkyWcs> readWcs();
121
123 // TODO: remove in DM-27177
124 [[deprecated("Replaced with readFilterLabel. Will be removed after v22.")]] Filter readFilter();
125
129 // TODO: deprecate in DM-27177, remove in DM-27811
130 std::shared_ptr<FilterLabel> readFilterLabel();
131
133 std::shared_ptr<PhotoCalib> readPhotoCalib();
134
136 std::shared_ptr<detection::Psf> readPsf();
137
139 std::shared_ptr<afw::geom::polygon::Polygon> readValidPolygon();
140
142 std::shared_ptr<ApCorrMap> readApCorrMap();
143
145 std::shared_ptr<CoaddInputs> readCoaddInputs();
146
148 std::shared_ptr<VisitInfo> readVisitInfo();
149
152
154 std::shared_ptr<cameraGeom::Detector> readDetector();
155
157 std::shared_ptr<typehandling::Storable> readComponent(std::string const &componentName);
158
160 std::map<std::string, std::shared_ptr<table::io::Persistable>> readExtraComponents();
161
163 std::shared_ptr<ExposureInfo> readExposureInfo();
164
166
179 template <typename ImagePixelT>
180 Image<ImagePixelT> readImage(lsst::geom::Box2I const &bbox = lsst::geom::Box2I(),
181 ImageOrigin origin = PARENT, bool allowUnsafe = false);
182 template <typename ImagePixelT>
183 ndarray::Array<ImagePixelT, 2, 2> readImageArray(lsst::geom::Box2I const &bbox = lsst::geom::Box2I(),
184 ImageOrigin origin = PARENT, bool allowUnsafe = false);
186
202 template <typename MaskPixelT>
203 Mask<MaskPixelT> readMask(lsst::geom::Box2I const &bbox = lsst::geom::Box2I(),
204 ImageOrigin origin = PARENT, bool conformMasks = false,
205 bool allowUnsafe = false);
206
220 template <typename MaskPixelT>
221 ndarray::Array<MaskPixelT, 2, 2> readMaskArray(lsst::geom::Box2I const &bbox = lsst::geom::Box2I(),
222 ImageOrigin origin = PARENT, bool allowUnsafe = false);
223
225
238 template <typename VariancePixelT>
239 Image<VariancePixelT> readVariance(lsst::geom::Box2I const &bbox = lsst::geom::Box2I(),
240 ImageOrigin origin = PARENT, bool allowUnsafe = false);
241 template <typename VariancePixelT>
242 ndarray::Array<VariancePixelT, 2, 2> readVarianceArray(
243 lsst::geom::Box2I const &bbox = lsst::geom::Box2I(), ImageOrigin origin = PARENT,
244 bool allowUnsafe = false);
246
262 template <typename ImagePixelT, typename MaskPixelT = MaskPixel, typename VariancePixelT = VariancePixel>
263 MaskedImage<ImagePixelT, MaskPixelT, VariancePixelT> readMaskedImage(
264 lsst::geom::Box2I const &bbox = lsst::geom::Box2I(), ImageOrigin origin = PARENT,
265 bool conformMasks = false, bool allowUnsafe = false);
266
282 template <typename ImagePixelT, typename MaskPixelT = MaskPixel, typename VariancePixelT = VariancePixel>
283 Exposure<ImagePixelT, MaskPixelT, VariancePixelT> read(
284 lsst::geom::Box2I const &bbox = lsst::geom::Box2I(), ImageOrigin origin = PARENT,
285 bool conformMasks = false, bool allowUnsafe = false);
286
290 std::string getFileName() const { return _maskedImageReader.getFileName(); }
291
292private:
293 class MetadataReader;
294 class ArchiveReader;
295
296 void _ensureReaders();
297
298 fits::Fits *_getFitsFile() { return _maskedImageReader._getFitsFile(); }
299
300 MaskedImageFitsReader _maskedImageReader;
301 std::unique_ptr<MetadataReader> _metadataReader;
302 std::unique_ptr<ArchiveReader> _archiveReader;
303};
304
305} // namespace image
306} // namespace afw
307} // namespace lsst
308
309#endif // !LSST_AFW_IMAGE_EXPOSUREFITSREADER_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 thin wrapper around std::map to allow aperture corrections to be attached to Exposures.
Definition: ApCorrMap.h:45
A simple Persistable struct containing ExposureCatalogs that record the inputs to a coadd.
Definition: CoaddInputs.h:49
A FITS reader class for Exposures and their components.
std::shared_ptr< TransmissionCurve > readTransmissionCurve()
Read the Exposure's transmission curve.
std::string readMaskDType() const
Read a string describing the pixel type of the on-disk image plane.
Exposure< ImagePixelT, MaskPixelT, VariancePixelT > read(lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool conformMasks=false, bool allowUnsafe=false)
Read the full Exposure.
std::shared_ptr< typehandling::Storable > readComponent(std::string const &componentName)
Read an arbitrary non-standard component by name.
std::string getFileName() const
Return the name of the file this reader targets.
std::shared_ptr< afw::geom::SkyWcs > readWcs()
Read the Exposure's world coordinate system.
std::shared_ptr< FilterLabel > readFilterLabel()
Read the Exposure's filter information.
MaskedImage< ImagePixelT, MaskPixelT, VariancePixelT > readMaskedImage(lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool conformMasks=false, bool allowUnsafe=false)
Read the MaskedImage.
ExposureFitsReader & operator=(ExposureFitsReader const &)=delete
std::map< std::string, std::shared_ptr< table::io::Persistable > > readExtraComponents()
Read the Exposure's non-standard components.
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.
ndarray::Array< VariancePixelT, 2, 2 > readVarianceArray(lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false)
Read the variance plane.
int readSerializationVersion()
Read the serialization version number from the header.
ExposureFitsReader(std::string const &fileName)
Construct a FITS reader object.
std::shared_ptr< detection::Psf > readPsf()
Read the Exposure's point-spread function.
std::shared_ptr< afw::geom::polygon::Polygon > readValidPolygon()
Read the polygon describing the region of validity for the Exposure.
Filter readFilter()
Read the Exposure's filter.
Image< ImagePixelT > readImage(lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false)
Read the image plane.
ExposureFitsReader(ExposureFitsReader const &)=delete
std::string readVarianceDType() 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.
lsst::geom::Box2I readBBox(ImageOrigin origin=PARENT)
Read the bounding box of the on-disk image.
Image< VariancePixelT > readVariance(lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false)
Read the variance plane.
std::shared_ptr< daf::base::PropertyList > readMetadata()
Read the flexible metadata associated with the Exposure.
std::shared_ptr< PhotoCalib > readPhotoCalib()
Read the Exposure's photometric calibration.
ExposureFitsReader & operator=(ExposureFitsReader &&)=delete
std::shared_ptr< ApCorrMap > readApCorrMap()
Read the Exposure's aperture correction map.
ndarray::Array< MaskPixelT, 2, 2 > readMaskArray(lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool allowUnsafe=false)
Read the mask plane.
std::string readImageDType() const
Read a string describing the pixel type of the on-disk image plane.
std::shared_ptr< CoaddInputs > readCoaddInputs()
Read the Exposure's coadd input catalogs.
std::shared_ptr< cameraGeom::Detector > readDetector()
Read the Exposure's detector.
std::shared_ptr< ExposureInfo > readExposureInfo()
Read the ExposureInfo containing all non-image components.
std::shared_ptr< VisitInfo > readVisitInfo()
Read the Exposure's visit metadata.
ExposureFitsReader(ExposureFitsReader &&)=delete
Mask< MaskPixelT > readMask(lsst::geom::Box2I const &bbox=lsst::geom::Box2I(), ImageOrigin origin=PARENT, bool conformMasks=false, bool allowUnsafe=false)
Read the mask plane.
A class to contain the data, WCS, and other information needed to describe an image of the sky.
Definition: Exposure.h:72
A collection of all the things that make an Exposure different from a MaskedImage.
Definition: ExposureInfo.h:86
A group of labels for a filter in an exposure or coadd.
Definition: FilterLabel.h:58
A class to represent a 2-dimensional array of pixels.
Definition: Image.h:51
Represent a 2-dimensional array of bitmask pixels.
Definition: Mask.h:77
std::string getFileName() const
Return the name of the file this reader targets.
A class to manipulate images, masks, and variance as a single object.
Definition: MaskedImage.h:73
The photometric calibration of an exposure.
Definition: PhotoCalib.h:114
A spatially-varying transmission curve as a function of wavelength.
Information about a single exposure of an imaging camera.
Definition: VisitInfo.h:68
Interface supporting iteration over heterogenous containers.
Definition: Storable.h:58
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.
float VariancePixel
default type for MaskedImage variance images
Point< int, 2 > Point2I
A base class for image defects.
STL namespace.