LSST Applications  21.0.0-147-g0e635eb1+1acddb5be5,22.0.0+052faf71bd,22.0.0+1ea9a8b2b2,22.0.0+6312710a6c,22.0.0+729191ecac,22.0.0+7589c3a021,22.0.0+9f079a9461,22.0.1-1-g7d6de66+b8044ec9de,22.0.1-1-g87000a6+536b1ee016,22.0.1-1-g8e32f31+6312710a6c,22.0.1-10-gd060f87+016f7cdc03,22.0.1-12-g9c3108e+df145f6f68,22.0.1-16-g314fa6d+c825727ab8,22.0.1-19-g93a5c75+d23f2fb6d8,22.0.1-19-gb93eaa13+aab3ef7709,22.0.1-2-g8ef0a89+b8044ec9de,22.0.1-2-g92698f7+9f079a9461,22.0.1-2-ga9b0f51+052faf71bd,22.0.1-2-gac51dbf+052faf71bd,22.0.1-2-gb66926d+6312710a6c,22.0.1-2-gcb770ba+09e3807989,22.0.1-20-g32debb5+b8044ec9de,22.0.1-23-gc2439a9a+fb0756638e,22.0.1-3-g496fd5d+09117f784f,22.0.1-3-g59f966b+1e6ba2c031,22.0.1-3-g849a1b8+f8b568069f,22.0.1-3-gaaec9c0+c5c846a8b1,22.0.1-32-g5ddfab5d3+60ce4897b0,22.0.1-4-g037fbe1+64e601228d,22.0.1-4-g8623105+b8044ec9de,22.0.1-5-g096abc9+d18c45d440,22.0.1-5-g15c806e+57f5c03693,22.0.1-7-gba73697+57f5c03693,master-g6e05de7fdc+c1283a92b8,master-g72cdda8301+729191ecac,w.2021.39
LSST Data Management Base Package
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"
30 #include "lsst/afw/geom/SkyWcs.h"
32 #include "lsst/afw/detection/Psf.h"
35 #include "lsst/afw/fits.h"
36 
37 using namespace std::string_literals;
38 
39 namespace {
40 LOG_LOGGER _log = LOG_GET("afw.image.ExposureInfo");
41 
43 } // namespace
44 
45 namespace lsst {
46 namespace afw {
47 namespace image {
48 
49 // Important: do *not* change the keys' strings; doing so will break compatibility with old FITS files
50 
51 typehandling::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 
54 bool ExposureInfo::hasWcs() const { return hasComponent(KEY_WCS); }
55 std::shared_ptr<geom::SkyWcs const> ExposureInfo::getWcs() const { return getComponent(KEY_WCS); }
56 void ExposureInfo::setWcs(std::shared_ptr<geom::SkyWcs const> wcs) { setComponent(KEY_WCS, wcs); }
57 
59  typehandling::makeKey<std::shared_ptr<detection::Psf const>>("PSF"s);
60 
61 bool ExposureInfo::hasPsf() const { return hasComponent(KEY_PSF); }
62 std::shared_ptr<detection::Psf const> ExposureInfo::getPsf() const { return getComponent(KEY_PSF); }
63 void ExposureInfo::setPsf(std::shared_ptr<detection::Psf const> psf) { setComponent(KEY_PSF, psf); }
64 
65 typehandling::Key<std::string, std::shared_ptr<PhotoCalib const>> const ExposureInfo::KEY_PHOTO_CALIB =
66  typehandling::makeKey<std::shared_ptr<PhotoCalib const>>("PHOTOCALIB"s);
67 
68 bool ExposureInfo::hasPhotoCalib() const { return hasComponent(KEY_PHOTO_CALIB); }
69 std::shared_ptr<PhotoCalib const> ExposureInfo::getPhotoCalib() const {
70  return getComponent(KEY_PHOTO_CALIB);
71 }
72 void ExposureInfo::setPhotoCalib(std::shared_ptr<PhotoCalib const> photoCalib) {
73  setComponent(KEY_PHOTO_CALIB, photoCalib);
74 }
75 
77  typehandling::makeKey<std::shared_ptr<cameraGeom::Detector const>>("DETECTOR"s);
78 
79 bool ExposureInfo::hasDetector() const { return hasComponent(KEY_DETECTOR); }
80 std::shared_ptr<cameraGeom::Detector const> ExposureInfo::getDetector() const {
81  return getComponent(KEY_DETECTOR);
82 }
83 void ExposureInfo::setDetector(std::shared_ptr<cameraGeom::Detector const> detector) {
84  setComponent(KEY_DETECTOR, detector);
85 }
86 
88  ExposureInfo::KEY_VALID_POLYGON =
89  typehandling::makeKey<std::shared_ptr<geom::polygon::Polygon const>>("VALID_POLYGON"s);
90 
91 bool ExposureInfo::hasValidPolygon() const { return hasComponent(KEY_VALID_POLYGON); }
92 std::shared_ptr<geom::polygon::Polygon const> ExposureInfo::getValidPolygon() const {
93  return getComponent(KEY_VALID_POLYGON);
94 }
95 void ExposureInfo::setValidPolygon(std::shared_ptr<geom::polygon::Polygon const> polygon) {
96  setComponent(KEY_VALID_POLYGON, polygon);
97 }
98 
99 typehandling::Key<std::string, std::shared_ptr<CoaddInputs const>> const ExposureInfo::KEY_COADD_INPUTS =
100  typehandling::makeKey<std::shared_ptr<CoaddInputs const>>("COADD_INPUTS"s);
101 
102 bool ExposureInfo::hasCoaddInputs() const { return hasComponent(KEY_COADD_INPUTS); }
103 void ExposureInfo::setCoaddInputs(std::shared_ptr<CoaddInputs const> coaddInputs) {
104  setComponent(KEY_COADD_INPUTS, coaddInputs);
105 }
106 std::shared_ptr<CoaddInputs const> ExposureInfo::getCoaddInputs() const {
107  return getComponent(KEY_COADD_INPUTS);
108 }
109 
110 typehandling::Key<std::string, std::shared_ptr<ApCorrMap const>> const ExposureInfo::KEY_AP_CORR_MAP =
111  typehandling::makeKey<std::shared_ptr<ApCorrMap const>>("AP_CORR_MAP"s);
112 
113 bool ExposureInfo::hasApCorrMap() const { return hasComponent(KEY_AP_CORR_MAP); }
114 std::shared_ptr<ApCorrMap const> ExposureInfo::getApCorrMap() const { return getComponent(KEY_AP_CORR_MAP); }
115 void ExposureInfo::setApCorrMap(std::shared_ptr<ApCorrMap const> apCorrMap) {
116  setComponent(KEY_AP_CORR_MAP, apCorrMap);
117 }
118 
120  ExposureInfo::KEY_TRANSMISSION_CURVE =
121  typehandling::makeKey<std::shared_ptr<TransmissionCurve const>>("TRANSMISSION_CURVE"s);
122 
123 bool ExposureInfo::hasTransmissionCurve() const { return hasComponent(KEY_TRANSMISSION_CURVE); }
124 std::shared_ptr<TransmissionCurve const> ExposureInfo::getTransmissionCurve() const {
125  return getComponent(KEY_TRANSMISSION_CURVE);
126 }
127 void ExposureInfo::setTransmissionCurve(std::shared_ptr<TransmissionCurve const> tc) {
128  setComponent(KEY_TRANSMISSION_CURVE, tc);
129 }
130 
131 // Compatibility code defined inside ExposureFitsReader.cc, to be removed in DM-27177
133 Filter makeFilter(FilterLabel const& label);
134 
136  std::shared_ptr<FilterLabel const> label = getFilterLabel();
137  if (label) {
138  return makeFilter(*label);
139  } else {
140  // Old exposures always had a Filter, even if only the default
141  return Filter();
142  }
143 }
144 
145 void ExposureInfo::setFilter(Filter const& filter) { setFilterLabel(makeFilterLabel(filter)); }
146 
148  typehandling::makeKey<std::shared_ptr<FilterLabel const>>("FILTER"s);
149 bool ExposureInfo::hasFilterLabel() const { return hasComponent(KEY_FILTER); }
150 std::shared_ptr<FilterLabel const> ExposureInfo::getFilterLabel() const { return getComponent(KEY_FILTER); }
151 void ExposureInfo::setFilterLabel(std::shared_ptr<FilterLabel const> label) {
152  setComponent(KEY_FILTER, label);
153 }
154 
155 int ExposureInfo::getFitsSerializationVersion() {
156  // Version history:
157  // unversioned and 0: photometric calibration via Calib, WCS via SkyWcs using AST.
158  // 1: photometric calibration via PhotoCalib, generic components
159  // 2: remove Filter, replaced with (generic) FilterLabel
160  static int const version = 2;
161  return version;
162 }
163 
164 std::string const& ExposureInfo::getFitsSerializationVersionName() {
165  static std::string const versionName("EXPINFO_V");
166  return versionName;
167 }
168 
169 // Clone various components; defined here so that we don't have to expose their insides in Exposure.h
170 
172  if (apCorrMap) {
173  return std::make_shared<ApCorrMap>(*apCorrMap);
174  }
176 }
177 
178 ExposureInfo::ExposureInfo(std::shared_ptr<geom::SkyWcs const> const& wcs,
184  std::shared_ptr<CoaddInputs> const& coaddInputs,
188  : _metadata(metadata ? metadata
189  : std::shared_ptr<daf::base::PropertySet>(new daf::base::PropertyList())),
190  _visitInfo(visitInfo),
191  _components(std::make_unique<MapClass>()) {
192  // setFilter guards against default filters
193  setFilter(filter);
194  setWcs(wcs);
195  setPsf(psf);
198  setValidPolygon(polygon);
199  setCoaddInputs(coaddInputs);
200  setApCorrMap(_cloneApCorrMap(apCorrMap));
202 }
203 
204 ExposureInfo::ExposureInfo(ExposureInfo const& other) : ExposureInfo(other, false) {}
205 
206 // Delegate to copy-constructor for backwards compatibility
208 
209 ExposureInfo::ExposureInfo(ExposureInfo const& other, bool copyMetadata)
210  : _metadata(other._metadata),
211  _visitInfo(other._visitInfo),
212  // ExposureInfos can (historically) share objects, but should each have their own pointers to them
213  _components(std::make_unique<MapClass>(*(other._components))) {
214  if (copyMetadata) _metadata = _metadata->deepCopy();
215 }
216 
218  if (&other != this) {
219  _metadata = other._metadata;
220  _visitInfo = other._visitInfo;
221  // ExposureInfos can (historically) share objects, but should each have their own pointers to them
222  _components = std::make_unique<MapClass>(*(other._components));
223  }
224  return *this;
225 }
226 // Delegate to copy-assignment for backwards compatibility
227 ExposureInfo& ExposureInfo::operator=(ExposureInfo&& other) { return *this = other; }
228 
229 void ExposureInfo::initApCorrMap() { setApCorrMap(std::make_shared<ApCorrMap>()); }
230 
231 ExposureInfo::~ExposureInfo() = default;
232 
233 int ExposureInfo::_addToArchive(FitsWriteData& data, table::io::Persistable const& object, std::string key,
234  std::string comment) {
235  int componentId = data.archive.put(object);
236  data.metadata->set(key, componentId, comment);
237  return componentId;
238 }
239 
240 int ExposureInfo::_addToArchive(FitsWriteData& data,
242  std::string comment) {
243  // Don't delegate to Persistable const& version because OutputArchive::put
244  // has special handling of shared_ptr
245  int componentId = data.archive.put(object);
246  data.metadata->set(key, componentId, comment);
247  return componentId;
248 }
249 
250 // Standardized strings for _startWriteFits
251 namespace {
252 std::string _getOldHeaderKey(std::string mapKey) { return mapKey + "_ID"; }
253 std::string _getNewHeaderKey(std::string mapKey) { return "ARCHIVE_ID_" + mapKey; }
254 
255 std::string _getHeaderComment(std::string mapKey) {
256  return "archive ID for generic component '" + mapKey + "'";
257 }
258 } // namespace
259 
260 ExposureInfo::FitsWriteData ExposureInfo::_startWriteFits(lsst::geom::Point2I const& xy0) const {
261  FitsWriteData data;
262 
263  data.metadata.reset(new daf::base::PropertyList());
264  data.imageMetadata.reset(new daf::base::PropertyList());
265  data.maskMetadata = data.imageMetadata;
266  data.varianceMetadata = data.imageMetadata;
267 
268  data.metadata->combine(getMetadata());
269 
271 
272  // In the future, we might not have exactly three image HDUs, but we always do right now,
273  // so 0=primary, 1=image, 2=mask, 3=variance, 4+=archive
274  //
275  // Historically the AR_HDU keyword was 1-indexed (see RFC-304), and to maintain file compatibility
276  // this is still the case so we're setting AR_HDU to 5 == 4 + 1
277  //
278  data.metadata->set("AR_HDU", 5, "HDU (1-indexed) containing the archive used to store ancillary objects");
279  for (auto const& keyValue : *_components) {
280  std::string const& key = keyValue.first.getId();
281  std::shared_ptr<typehandling::Storable const> const& object = keyValue.second;
282 
283  if (object && object->isPersistable()) {
284  std::string comment = _getHeaderComment(key);
285  // Store archive ID in two header keys:
286  // - old-style key for backwards compatibility,
287  // - and new-style key because it's much safer to parse
288  int id = _addToArchive(data, object, _getOldHeaderKey(key), comment);
289  data.metadata->set(_getNewHeaderKey(key), id, comment);
290  }
291  }
292 
293  // LSST convention is that Wcs is in pixel coordinates (i.e relative to bottom left
294  // corner of parent image, if any). The Wcs/Fits convention is that the Wcs is in
295  // image coordinates. When saving an image we convert from pixel to index coordinates.
296  // In the case where this image is a parent image, the reference pixels are unchanged
297  // by this transformation
298  if (hasWcs() && getWcs()->isFits()) {
299  // Try to save the WCS as FITS-WCS metadata; if an exact representation
300  // is not possible then skip it
301  auto shift = lsst::geom::Extent2D(lsst::geom::Point2I(0, 0) - xy0);
302  auto newWcs = getWcs()->copyAtShiftedPixelOrigin(shift);
304  try {
305  wcsMetadata = newWcs->getFitsMetadata(true);
306  } catch (pex::exceptions::RuntimeError const&) {
307  // cannot represent this WCS as FITS-WCS; don't write its metadata
308  }
309  if (wcsMetadata) {
310  data.imageMetadata->combine(newWcs->getFitsMetadata(true));
311  }
312  }
313 
314  // For the sake of ds9, store _x0 and _y0 as -LTV1, -LTV2.
315  // This is in addition to saving _x0 and _y0 as WCS A, which is done elsewhere
316  // and is what LSST uses to read _x0 and _y0.
317  // LTV is a convention used by STScI (see \S2.6.2 of HST Data Handbook for STIS, version 5.0
318  // http://www.stsci.edu/hst/stis/documents/handbooks/currentDHB/ch2_stis_data7.html#429287)
319  // and recognized by ds9.
320  data.imageMetadata->set("LTV1", static_cast<double>(-xy0.getX()));
321  data.imageMetadata->set("LTV2", static_cast<double>(-xy0.getY()));
322 
323  if (hasDetector()) {
324  data.metadata->set("DETNAME", getDetector()->getName());
325  data.metadata->set("DETSER", getDetector()->getSerial());
326  }
327 
328  auto visitInfoPtr = getVisitInfo();
329  if (visitInfoPtr) {
330  detail::setVisitInfoMetadata(*(data.metadata), *visitInfoPtr);
331  }
332 
333  return data;
334 }
335 
336 void ExposureInfo::_finishWriteFits(fits::Fits& fitsfile, FitsWriteData const& data) const {
337  data.archive.writeFits(fitsfile);
338 }
339 
340 } // namespace image
341 } // namespace afw
342 } // namespace lsst
char * data
Definition: BaseRecord.cc:61
table::Key< int > detector
LSST DM logging module built on log4cxx.
#define LOG_GET(logger)
Returns a Log object associated with logger.
Definition: Log.h:75
#define LOG_LOGGER
Definition: Log.h:714
Implementation of the Photometric Calibration class.
table::Key< table::Array< std::uint8_t > > wcs
Definition: SkyWcs.cc:66
A collection of all the things that make an Exposure different from a MaskedImage.
Definition: ExposureInfo.h:86
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.
std::shared_ptr< daf::base::PropertySet > getMetadata() const
Return flexible metadata.
Definition: ExposureInfo.h:163
ExposureInfo & operator=(ExposureInfo const &other)
Assignment; shares all components.
void setFilter(Filter const &filter)
Set the exposure's filter.
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 >(), Filter const &filter=Filter(), 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.
void setValidPolygon(std::shared_ptr< geom::polygon::Polygon const > polygon)
Set the exposure's valid Polygon.
Definition: ExposureInfo.cc:95
void setWcs(std::shared_ptr< geom::SkyWcs const > wcs)
Set the WCS of the exposure.
Definition: ExposureInfo.cc:56
std::shared_ptr< image::VisitInfo const > getVisitInfo() const
Return the exposure's visit info.
Definition: ExposureInfo.h:213
void setApCorrMap(std::shared_ptr< ApCorrMap const > apCorrMap)
Set the exposure's aperture correction map (null pointer if !hasApCorrMap())
std::shared_ptr< cameraGeom::Detector const > getDetector() const
Return the exposure's Detector information.
Definition: ExposureInfo.cc:80
void setPhotoCalib(std::shared_ptr< PhotoCalib const > photoCalib)
Set the Exposure's PhotoCalib object.
Definition: ExposureInfo.cc:72
void setCoaddInputs(std::shared_ptr< CoaddInputs const > coaddInputs)
Set the exposure's coadd provenance catalogs.
void setDetector(std::shared_ptr< cameraGeom::Detector const > detector)
Set the exposure's Detector information.
Definition: ExposureInfo.cc:83
void setPsf(std::shared_ptr< detection::Psf const > psf)
Set the exposure's point-spread function.
Definition: ExposureInfo.cc:63
void initApCorrMap()
Set the exposure's aperture correction map to a new, empty map.
std::shared_ptr< geom::SkyWcs const > getWcs() const
Return the WCS of the exposure.
Definition: ExposureInfo.cc:55
bool hasDetector() const
Does this exposure have Detector information?
Definition: ExposureInfo.cc:79
static std::string const & getFitsSerializationVersionName()
Get the version of FITS serialization version info name.
void setTransmissionCurve(std::shared_ptr< TransmissionCurve const > tc)
Set the exposure's transmission curve.
A group of labels for a filter in an exposure or coadd.
Definition: FilterLabel.h:58
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:356
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.
Filter makeFilter(FilterLabel const &label)
Convert a FilterLabel back to an old-style Filter.
std::shared_ptr< FilterLabel > makeFilterLabel(Filter const &filter)
Convert an old-style Filter to a FilterLabel.
std::string const & getName() const noexcept
Return a filter's name.
Definition: Filter.h:78
Extent< double, 2 > Extent2D
Definition: Extent.h:400
A base class for image defects.
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