lsst.afw g47ad8d2bab+3cc41d2aa1
ExposureInfo.cc
Go to the documentation of this file.
1// -*- LSST-C++ -*- // fixed format comment for emacs
2/*
3 * This file is part of afw.
4 *
5 * Developed for the LSST Data Management System.
6 * This product includes software developed by the LSST Project
7 * (https://www.lsst.org).
8 * See the COPYRIGHT file at the top-level directory of this distribution
9 * for details of code ownership.
10 *
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
15 *
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <https://www.gnu.org/licenses/>.
23 */
24
25#include "lsst/pex/exceptions.h"
26#include "lsst/log/Log.h"
35#include "lsst/afw/fits.h"
36
37using namespace std::string_literals;
38
39namespace {
40LOG_LOGGER _log = LOG_GET("lsst.afw.image.ExposureInfo");
41
43} // namespace
44
45namespace lsst {
46namespace afw {
47namespace image {
48
49// Important: do *not* change the keys' strings; doing so will break compatibility with old FITS files
50
51typehandling::Key<std::string, std::shared_ptr<geom::SkyWcs const>> const ExposureInfo::KEY_WCS =
52 typehandling::makeKey<std::shared_ptr<geom::SkyWcs const>>("SKYWCS"s);
53
54bool ExposureInfo::hasWcs() const { return hasComponent(KEY_WCS); }
57
59 typehandling::makeKey<std::shared_ptr<detection::Psf const>>("PSF"s);
60
61bool ExposureInfo::hasPsf() const { return hasComponent(KEY_PSF); }
64
66 typehandling::makeKey<std::shared_ptr<PhotoCalib const>>("PHOTOCALIB"s);
67
71}
74}
75
77 typehandling::makeKey<std::shared_ptr<cameraGeom::Detector const>>("DETECTOR"s);
78
82}
85}
86
89 typehandling::makeKey<std::shared_ptr<geom::polygon::Polygon const>>("VALID_POLYGON"s);
90
94}
97}
98
100 typehandling::makeKey<std::shared_ptr<CoaddInputs const>>("COADD_INPUTS"s);
101
104 setComponent(KEY_COADD_INPUTS, coaddInputs);
105}
108}
109
111 typehandling::makeKey<std::shared_ptr<ApCorrMap const>>("AP_CORR_MAP"s);
112
117}
118
121 typehandling::makeKey<std::shared_ptr<TransmissionCurve const>>("TRANSMISSION_CURVE"s);
122
126}
129}
130
131bool ExposureInfo::hasId() const noexcept { return _exposureId.has_value(); }
132
134 if (_exposureId) {
135 return *_exposureId;
136 } else {
137 throw LSST_EXCEPT(lsst::pex::exceptions::NotFoundError, "Exposure does not have an ID.");
138 }
139}
140
142 _exposureId = id;
143 // Ensure consistency with VisitInfo::getExposureId() until the latter is removed in DM-32138.
145 if (oldVisitInfo) {
146 auto newVisitInfo = std::make_shared<VisitInfo>(
147 *_exposureId, oldVisitInfo->getExposureTime(), oldVisitInfo->getDarkTime(),
148 oldVisitInfo->getDate(), oldVisitInfo->getUt1(), oldVisitInfo->getEra(),
149 oldVisitInfo->getBoresightRaDec(), oldVisitInfo->getBoresightAzAlt(),
150 oldVisitInfo->getBoresightAirmass(), oldVisitInfo->getBoresightRotAngle(),
151 oldVisitInfo->getRotType(), oldVisitInfo->getObservatory(), oldVisitInfo->getWeather(),
152 oldVisitInfo->getInstrumentLabel(), oldVisitInfo->getId(), oldVisitInfo->getFocusZ(),
153 oldVisitInfo->getObservationType(), oldVisitInfo->getScienceProgram(),
154 oldVisitInfo->getObservationReason(), oldVisitInfo->getObject(),
155 oldVisitInfo->getHasSimulatedContent());
156 // Do not call setVisitInfo, to avoid recursion
157 _visitInfo = newVisitInfo;
158 }
159}
160
161void ExposureInfo::clearId() noexcept { _exposureId.reset(); }
162
164 typehandling::makeKey<std::shared_ptr<FilterLabel const>>("FILTER"s);
165bool ExposureInfo::hasFilterLabel() const { return hasFilter(); }
171
173 // Version history:
174 // unversioned and 0: photometric calibration via Calib, WCS via SkyWcs using AST.
175 // 1: photometric calibration via PhotoCalib, generic components
176 // 2: remove Filter, replaced with (generic) FilterLabel
177 static int const version = 2;
178 return version;
179}
180
182 static std::string const versionName("EXPINFO_V");
183 return versionName;
184}
185
186// Clone various components; defined here so that we don't have to expose their insides in Exposure.h
187
189 if (apCorrMap) {
190 return std::make_shared<ApCorrMap>(*apCorrMap);
191 }
193}
194
201 std::shared_ptr<CoaddInputs> const& coaddInputs,
205 : _exposureId(),
206 _metadata(metadata ? metadata
207 : std::shared_ptr<daf::base::PropertySet>(new daf::base::PropertyList())),
208 _visitInfo(visitInfo),
209 _components(std::make_unique<MapClass>()) {
210 setWcs(wcs);
211 setPsf(psf);
214 setValidPolygon(polygon);
215 setCoaddInputs(coaddInputs);
216 setApCorrMap(_cloneApCorrMap(apCorrMap));
218}
219
221
222// Delegate to copy-constructor for backwards compatibility
224
225ExposureInfo::ExposureInfo(ExposureInfo const& other, bool copyMetadata)
226 : _exposureId(other._exposureId),
227 _metadata(other._metadata),
228 _visitInfo(other._visitInfo),
229 // ExposureInfos can (historically) share objects, but should each have their own pointers to them
230 _components(std::make_unique<MapClass>(*(other._components))) {
231 if (copyMetadata) _metadata = _metadata->deepCopy();
232}
233
235 if (&other != this) {
236 _exposureId = other._exposureId;
237 _metadata = other._metadata;
238 _visitInfo = other._visitInfo;
239 // ExposureInfos can (historically) share objects, but should each have their own pointers to them
240 _components = std::make_unique<MapClass>(*(other._components));
241 }
242 return *this;
243}
244// Delegate to copy-assignment for backwards compatibility
245ExposureInfo& ExposureInfo::operator=(ExposureInfo&& other) { return *this = other; }
246
247void ExposureInfo::initApCorrMap() { setApCorrMap(std::make_shared<ApCorrMap>()); }
248
250
251int ExposureInfo::_addToArchive(FitsWriteData& data, table::io::Persistable const& object, std::string key,
252 std::string comment) {
253 int componentId = data.archive.put(object);
254 data.metadata->set(key, componentId, comment);
255 return componentId;
256}
257
258int ExposureInfo::_addToArchive(FitsWriteData& data,
260 std::string comment) {
261 // Don't delegate to Persistable const& version because OutputArchive::put
262 // has special handling of shared_ptr
263 int componentId = data.archive.put(object);
264 data.metadata->set(key, componentId, comment);
265 return componentId;
266}
267
268// Standardized strings for _startWriteFits
269namespace {
270std::string _getOldHeaderKey(std::string mapKey) { return mapKey + "_ID"; }
271std::string _getNewHeaderKey(std::string mapKey) { return "ARCHIVE_ID_" + mapKey; }
272
273std::string _getHeaderComment(std::string mapKey) {
274 return "archive ID for generic component '" + mapKey + "'";
275}
276} // namespace
277
278ExposureInfo::FitsWriteData ExposureInfo::_startWriteFits(lsst::geom::Point2I const& xy0) const {
279 FitsWriteData data;
280
281 data.metadata.reset(new daf::base::PropertyList());
282 data.imageMetadata.reset(new daf::base::PropertyList());
283 data.maskMetadata = data.imageMetadata;
284 data.varianceMetadata = data.imageMetadata;
285
286 data.metadata->combine(*getMetadata());
287
289
290 // In the future, we might not have exactly three image HDUs, but we always do right now,
291 // so 0=primary, 1=image, 2=mask, 3=variance, 4+=archive
292 //
293 // Historically the AR_HDU keyword was 1-indexed (see RFC-304), and to maintain file compatibility
294 // this is still the case so we're setting AR_HDU to 5 == 4 + 1
295 //
296 data.metadata->set("AR_HDU", 5, "HDU (1-indexed) containing the archive used to store ancillary objects");
297 for (auto const& keyValue : *_components) {
298 std::string const& key = keyValue.first.getId();
299 std::shared_ptr<typehandling::Storable const> const& object = keyValue.second;
300
301 if (object && object->isPersistable()) {
302 std::string comment = _getHeaderComment(key);
303 // Store archive ID in two header keys:
304 // - old-style key for backwards compatibility,
305 // - and new-style key because it's much safer to parse
306 int id = _addToArchive(data, object, _getOldHeaderKey(key), comment);
307 data.metadata->set(_getNewHeaderKey(key), id, comment);
308 }
309 }
310
311 // LSST convention is that Wcs is in pixel coordinates (i.e relative to bottom left
312 // corner of parent image, if any). The Wcs/Fits convention is that the Wcs is in
313 // image coordinates. When saving an image we convert from pixel to index coordinates.
314 // In the case where this image is a parent image, the reference pixels are unchanged
315 // by this transformation
316 if (hasWcs() && getWcs()->isFits()) {
317 // Try to save the WCS as FITS-WCS metadata; if an exact representation
318 // is not possible then skip it
319 auto shift = lsst::geom::Extent2D(lsst::geom::Point2I(0, 0) - xy0);
320 auto newWcs = getWcs()->copyAtShiftedPixelOrigin(shift);
322 try {
323 wcsMetadata = newWcs->getFitsMetadata(true);
324 } catch (pex::exceptions::RuntimeError const&) {
325 // cannot represent this WCS as FITS-WCS; don't write its metadata
326 }
327 if (wcsMetadata) {
328 data.imageMetadata->combine(*newWcs->getFitsMetadata(true));
329 }
330 }
331
332 // For the sake of ds9, store _x0 and _y0 as -LTV1, -LTV2.
333 // This is in addition to saving _x0 and _y0 as WCS A, which is done elsewhere
334 // and is what LSST uses to read _x0 and _y0.
335 // LTV is a convention used by STScI (see \S2.6.2 of HST Data Handbook for STIS, version 5.0
336 // http://www.stsci.edu/hst/stis/documents/handbooks/currentDHB/ch2_stis_data7.html#429287)
337 // and recognized by ds9.
338 data.imageMetadata->set("LTV1", static_cast<double>(-xy0.getX()));
339 data.imageMetadata->set("LTV2", static_cast<double>(-xy0.getY()));
340
341 if (hasDetector()) {
342 data.metadata->set("DETNAME", getDetector()->getName());
343 data.metadata->set("DETSER", getDetector()->getSerial());
344 }
345
346 auto visitInfoPtr = getVisitInfo();
347 if (visitInfoPtr) {
348 detail::setVisitInfoMetadata(*(data.metadata), *visitInfoPtr);
349 }
350
351 // So long as VisitInfo also writes exposureId (until DM-32138), let ours take precedence.
352 if (hasId()) {
353 data.metadata->set("EXPID", getId());
354 }
355
356 return data;
357}
358
359void ExposureInfo::_finishWriteFits(fits::Fits& fitsfile, FitsWriteData const& data) const {
360 data.archive.writeFits(fitsfile);
361}
362
363} // namespace image
364} // namespace afw
365} // namespace lsst
char * data
Definition: BaseRecord.cc:61
table::Key< int > id
Definition: Detector.cc:162
table::Key< int > detector
#define LSST_EXCEPT(type,...)
#define LOG_GET(logger)
Implementation of the Photometric Calibration class.
table::Key< table::Array< std::uint8_t > > wcs
Definition: SkyWcs.cc:66
table::Key< std::string > object
Definition: VisitInfo.cc:232
A collection of all the things that make an Exposure different from a MaskedImage.
Definition: ExposureInfo.h:88
bool hasWcs() const
Does this exposure have a Wcs?
Definition: ExposureInfo.cc:54
static int getFitsSerializationVersion()
Get the version of FITS serialization that this ExposureInfo understands.
bool hasCoaddInputs() const
Does this exposure have coadd provenance catalogs?
void setFilterLabel(std::shared_ptr< FilterLabel const > filterLabel)
Set the exposure's filter information.
static typehandling::Key< std::string, std::shared_ptr< geom::SkyWcs const > > const KEY_WCS
Standard key for looking up the Wcs.
Definition: ExposureInfo.h:91
ExposureInfo & operator=(ExposureInfo const &other)
Assignment; shares all components.
static typehandling::Key< std::string, std::shared_ptr< cameraGeom::Detector const > > const KEY_DETECTOR
Standard key for looking up the detector information.
Definition: ExposureInfo.h:97
bool hasTransmissionCurve() const
Does this exposure have a transmission curve?
bool hasPsf() const
Does this exposure have a Psf?
Definition: ExposureInfo.cc:61
void setValidPolygon(std::shared_ptr< geom::polygon::Polygon const > polygon)
Set the exposure's valid Polygon.
Definition: ExposureInfo.cc:95
bool hasPhotoCalib() const
Does this exposure have a photometric calibration?
Definition: ExposureInfo.cc:68
bool hasApCorrMap() const
Return true if the exposure has an aperture correction map.
void setWcs(std::shared_ptr< geom::SkyWcs const > wcs)
Set the WCS of the exposure.
Definition: ExposureInfo.cc:56
std::shared_ptr< PhotoCalib const > getPhotoCalib() const
Return the exposure's photometric calibration.
Definition: ExposureInfo.cc:69
bool hasComponent(typehandling::Key< std::string, T > const &key) const
Test whether a generic component is defined.
Definition: ExposureInfo.h:319
std::shared_ptr< ApCorrMap const > getApCorrMap() const
Return the exposure's aperture correction map (null pointer if !hasApCorrMap())
std::shared_ptr< FilterLabel const > getFilterLabel() const
Return the exposure's filter information.
void setApCorrMap(std::shared_ptr< ApCorrMap const > apCorrMap)
Set the exposure's aperture correction map (null pointer if !hasApCorrMap())
void setPhotoCalib(std::shared_ptr< PhotoCalib const > photoCalib)
Set the Exposure's PhotoCalib object.
Definition: ExposureInfo.cc:72
static typehandling::Key< std::string, std::shared_ptr< geom::polygon::Polygon const > > const KEY_VALID_POLYGON
Standard key for looking up the valid polygon.
Definition: ExposureInfo.h:100
void setComponent(typehandling::Key< std::string, std::shared_ptr< T > > const &key, std::shared_ptr< T > const &object)
Add a generic component to the ExposureInfo.
Definition: ExposureInfo.h:299
bool hasValidPolygon() const
Does this exposure have a valid Polygon.
Definition: ExposureInfo.cc:91
std::shared_ptr< geom::SkyWcs const > getWcs() const
Return the WCS of the exposure.
Definition: ExposureInfo.cc:55
std::shared_ptr< T > getComponent(typehandling::Key< std::string, std::shared_ptr< T > > const &key) const
Retrieve a generic component from the ExposureInfo.
Definition: ExposureInfo.h:333
std::shared_ptr< FilterLabel const > getFilter() const
Return the exposure's filter information.
static typehandling::Key< std::string, std::shared_ptr< PhotoCalib const > > const KEY_PHOTO_CALIB
Standard key for looking up the photometric calibration.
Definition: ExposureInfo.h:95
void setCoaddInputs(std::shared_ptr< CoaddInputs const > coaddInputs)
Set the exposure's coadd provenance catalogs.
std::shared_ptr< cameraGeom::Detector const > getDetector() const
Return the exposure's Detector information.
Definition: ExposureInfo.cc:80
bool hasFilterLabel() const
Does this exposure have filter information?
void clearId() noexcept
Unset the exposure ID, if any.
void setDetector(std::shared_ptr< cameraGeom::Detector const > detector)
Set the exposure's Detector information.
Definition: ExposureInfo.cc:83
void setFilter(std::shared_ptr< FilterLabel const > filter)
Set the exposure's filter information.
void setPsf(std::shared_ptr< detection::Psf const > psf)
Set the exposure's point-spread function.
Definition: ExposureInfo.cc:63
static typehandling::Key< std::string, std::shared_ptr< TransmissionCurve const > > const KEY_TRANSMISSION_CURVE
Standard key for looking up the transmission curve.
Definition: ExposureInfo.h:107
void initApCorrMap()
Set the exposure's aperture correction map to a new, empty map.
static typehandling::Key< std::string, std::shared_ptr< CoaddInputs const > > const KEY_COADD_INPUTS
Standard key for looking up coadd provenance catalogs.
Definition: ExposureInfo.h:102
static typehandling::Key< std::string, std::shared_ptr< detection::Psf const > > const KEY_PSF
Standard key for looking up the point-spread function.
Definition: ExposureInfo.h:93
std::shared_ptr< CoaddInputs const > getCoaddInputs() const
Return a pair of catalogs that record the inputs, if this Exposure is a coadd (otherwise null).
bool hasFilter() const
Does this exposure have filter information?
table::RecordId getId() const
Return the exposure ID.
std::shared_ptr< geom::polygon::Polygon const > getValidPolygon() const
Return the valid Polygon.
Definition: ExposureInfo.cc:92
std::shared_ptr< daf::base::PropertySet > getMetadata() const
Return flexible metadata.
Definition: ExposureInfo.h:198
ExposureInfo(std::shared_ptr< geom::SkyWcs const > const &wcs=std::shared_ptr< geom::SkyWcs const >(), std::shared_ptr< detection::Psf const > const &psf=std::shared_ptr< detection::Psf const >(), std::shared_ptr< PhotoCalib const > const &photoCalib=std::shared_ptr< PhotoCalib const >(), std::shared_ptr< cameraGeom::Detector const > const &detector=std::shared_ptr< cameraGeom::Detector const >(), std::shared_ptr< geom::polygon::Polygon const > const &polygon=std::shared_ptr< geom::polygon::Polygon const >(), std::shared_ptr< daf::base::PropertySet > const &metadata=std::shared_ptr< daf::base::PropertySet >(), std::shared_ptr< CoaddInputs > const &coaddInputs=std::shared_ptr< CoaddInputs >(), std::shared_ptr< ApCorrMap > const &apCorrMap=std::shared_ptr< ApCorrMap >(), std::shared_ptr< image::VisitInfo const > const &visitInfo=std::shared_ptr< image::VisitInfo const >(), std::shared_ptr< TransmissionCurve const > const &transmissionCurve=std::shared_ptr< TransmissionCurve >())
Construct an ExposureInfo from its various components.
bool hasDetector() const
Does this exposure have Detector information?
Definition: ExposureInfo.cc:79
static typehandling::Key< std::string, std::shared_ptr< ApCorrMap const > > const KEY_AP_CORR_MAP
Standard key for looking up the aperture correction map.
Definition: ExposureInfo.h:104
static std::string const & getFitsSerializationVersionName()
Get the version of FITS serialization version info name.
std::shared_ptr< image::VisitInfo const > getVisitInfo() const
Return the exposure's visit info.
Definition: ExposureInfo.h:248
static typehandling::Key< std::string, std::shared_ptr< FilterLabel const > > const KEY_FILTER
Standard key for looking up filter information.
Definition: ExposureInfo.h:109
void setId(table::RecordId id)
Set the exposure ID.
bool hasId() const noexcept
Does this Exposure have an exposure id?
void setTransmissionCurve(std::shared_ptr< TransmissionCurve const > tc)
Set the exposure's transmission curve.
std::shared_ptr< detection::Psf const > getPsf() const
Return the exposure's point-spread function.
Definition: ExposureInfo.cc:62
std::shared_ptr< TransmissionCurve const > getTransmissionCurve() const
Return the exposure's transmission curve.
A map of Storable supporting strongly-typed access.
Definition: StorableMap.h:59
A base class for objects that can be persisted via afw::table::io Archive classes.
Definition: Persistable.h:74
Key for type-safe lookup in a GenericMap.
Definition: Key.h:52
void setVisitInfoMetadata(daf::base::PropertyList &metadata, VisitInfo const &visitInfo)
Set FITS metadata from a VisitInfo.
Definition: VisitInfo.cc:419
Extent< double, 2 > Extent2D
STL namespace.
Key< int > psf
Definition: Exposure.cc:65
Key< int > visitInfo
Definition: Exposure.cc:70
Key< int > photoCalib
Definition: Exposure.cc:67
Key< int > transmissionCurve
Definition: Exposure.cc:71
Key< int > apCorrMap
Definition: Exposure.cc:68