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
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
25#include <optional>
26
30
31namespace lsst {
32namespace afw {
33namespace image {
34
45public:
51 explicit ExposureFitsReader(std::string const &fileName);
52
59
66 explicit ExposureFitsReader(fits::Fits *fitsFile);
67
68 // FITS readers are not copyable, movable, or assignable.
73
75
77
83 std::string readImageDType() const;
84 std::string readMaskDType() const;
85 std::string readVarianceDType() const;
87
96
104 lsst::geom::Point2I readXY0(lsst::geom::Box2I const &bbox = lsst::geom::Box2I(),
105 ImageOrigin origin = PARENT);
106
111
118 std::shared_ptr<daf::base::PropertyList> readMetadata();
119
121 std::optional<table::RecordId> readExposureId();
122
124 std::shared_ptr<afw::geom::SkyWcs> readWcs();
125
129 std::shared_ptr<FilterLabel> readFilter();
130
132 std::shared_ptr<PhotoCalib> readPhotoCalib();
133
135 std::shared_ptr<detection::Psf> readPsf();
136
138 std::shared_ptr<afw::geom::polygon::Polygon> readValidPolygon();
139
141 std::shared_ptr<ApCorrMap> readApCorrMap();
142
144 std::shared_ptr<CoaddInputs> readCoaddInputs();
145
147 std::shared_ptr<VisitInfo> readVisitInfo();
148
151
153 std::shared_ptr<cameraGeom::Detector> readDetector();
154
156 std::shared_ptr<typehandling::Storable> readComponent(std::string const &componentName);
157
159 std::map<std::string, std::shared_ptr<table::io::Persistable>> readExtraComponents();
160
162 std::shared_ptr<ExposureInfo> readExposureInfo();
163
165
178 template <typename ImagePixelT>
179 Image<ImagePixelT> readImage(lsst::geom::Box2I const &bbox = lsst::geom::Box2I(),
180 ImageOrigin origin = PARENT, bool allowUnsafe = false);
181 template <typename ImagePixelT>
182 ndarray::Array<ImagePixelT, 2, 2> readImageArray(lsst::geom::Box2I const &bbox = lsst::geom::Box2I(),
183 ImageOrigin origin = PARENT, bool allowUnsafe = false);
185
201 template <typename MaskPixelT>
202 Mask<MaskPixelT> readMask(lsst::geom::Box2I const &bbox = lsst::geom::Box2I(),
203 ImageOrigin origin = PARENT, bool conformMasks = false,
204 bool allowUnsafe = false);
205
219 template <typename MaskPixelT>
220 ndarray::Array<MaskPixelT, 2, 2> readMaskArray(lsst::geom::Box2I const &bbox = lsst::geom::Box2I(),
221 ImageOrigin origin = PARENT, bool allowUnsafe = false);
222
224
237 template <typename VariancePixelT>
238 Image<VariancePixelT> readVariance(lsst::geom::Box2I const &bbox = lsst::geom::Box2I(),
239 ImageOrigin origin = PARENT, bool allowUnsafe = false);
240 template <typename VariancePixelT>
241 ndarray::Array<VariancePixelT, 2, 2> readVarianceArray(
242 lsst::geom::Box2I const &bbox = lsst::geom::Box2I(), ImageOrigin origin = PARENT,
243 bool allowUnsafe = false);
245
261 template <typename ImagePixelT, typename MaskPixelT = MaskPixel, typename VariancePixelT = VariancePixel>
262 MaskedImage<ImagePixelT, MaskPixelT, VariancePixelT> readMaskedImage(
263 lsst::geom::Box2I const &bbox = lsst::geom::Box2I(), ImageOrigin origin = PARENT,
264 bool conformMasks = false, bool allowUnsafe = false);
265
281 template <typename ImagePixelT, typename MaskPixelT = MaskPixel, typename VariancePixelT = VariancePixel>
282 Exposure<ImagePixelT, MaskPixelT, VariancePixelT> read(
283 lsst::geom::Box2I const &bbox = lsst::geom::Box2I(), ImageOrigin origin = PARENT,
284 bool conformMasks = false, bool allowUnsafe = false);
285
289 std::string getFileName() const { return _maskedImageReader.getFileName(); }
290
291private:
292 class MetadataReader;
293 class ArchiveReader;
294
295 void _ensureReaders();
296
297 fits::Fits *_getFitsFile() { return _maskedImageReader._getFitsFile(); }
298
299 MaskedImageFitsReader _maskedImageReader;
300 std::unique_ptr<MetadataReader> _metadataReader;
301 std::unique_ptr<ArchiveReader> _archiveReader;
302};
303
304} // namespace image
305} // namespace afw
306} // namespace lsst
307
308#endif // !LSST_AFW_IMAGE_EXPOSUREFITSREADER_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
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
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.
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.
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.
std::shared_ptr< FilterLabel > readFilter()
Read the Exposure's filter information.
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::optional< table::RecordId > readExposureId()
Read the Exposure's exposure ID, if it exists.
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.
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:82
A class to manipulate images, masks, and variance as a single object.
Definition MaskedImage.h:74
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
An integer coordinate rectangle.
Definition Box.h:55
std::int32_t MaskPixel
default type for Masks and MaskedImage Masks
float VariancePixel
default type for MaskedImage variance images
Point< int, 2 > Point2I
Definition Point.h:321
STL namespace.