LSST Applications g0b6bd0c080+a72a5dd7e6,g1182afd7b4+2a019aa3bb,g17e5ecfddb+2b8207f7de,g1d67935e3f+06cf436103,g38293774b4+ac198e9f13,g396055baef+6a2097e274,g3b44f30a73+6611e0205b,g480783c3b1+98f8679e14,g48ccf36440+89c08d0516,g4b93dc025c+98f8679e14,g5c4744a4d9+a302e8c7f0,g613e996a0d+e1c447f2e0,g6c8d09e9e7+25247a063c,g7271f0639c+98f8679e14,g7a9cd813b8+124095ede6,g9d27549199+a302e8c7f0,ga1cf026fa3+ac198e9f13,ga32aa97882+7403ac30ac,ga786bb30fb+7a139211af,gaa63f70f4e+9994eb9896,gabf319e997+ade567573c,gba47b54d5d+94dc90c3ea,gbec6a3398f+06cf436103,gc6308e37c7+07dd123edb,gc655b1545f+ade567573c,gcc9029db3c+ab229f5caf,gd01420fc67+06cf436103,gd877ba84e5+06cf436103,gdb4cecd868+6f279b5b48,ge2d134c3d5+cc4dbb2e3f,ge448b5faa6+86d1ceac1d,gecc7e12556+98f8679e14,gf3ee170dca+25247a063c,gf4ac96e456+ade567573c,gf9f5ea5b4d+ac198e9f13,gff490e6085+8c2580be5c,w.2022.27
LSST Data Management Base Package
PhotoCalib.h
Go to the documentation of this file.
1/*
2 * LSST Data Management System
3 * Copyright 2017 LSST Corporation.
4 *
5 * This product includes software developed by the
6 * LSST Project (http://www.lsst.org/).
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 LSST License Statement and
19 * the GNU General Public License along with this program. If not,
20 * see <http://www.lsstcorp.org/LegalNotices/>.
21 */
22
23#ifndef LSST_AFW_IMAGE_PHOTOCALIB_H
24#define LSST_AFW_IMAGE_PHOTOCALIB_H
25
32#include "boost/format.hpp"
33
36#include "lsst/geom/Point.h"
37#include "lsst/geom/Box.h"
45
46namespace lsst {
47namespace afw {
48namespace image {
49
52 Measurement(double value, double error) : value(value), error(error) {}
53 double const value;
54 double const error;
55};
56
58
69inline void assertNonNegative(double value, std::string const &name) {
70 if (value < 0) {
72 (boost::format("%s must be positive: %.3g") % name % value).str());
73 }
74}
75
114class PhotoCalib final : public table::io::PersistableFacade<PhotoCalib>, public typehandling::Storable {
115public:
116 // Allow move, but no copy
117 PhotoCalib(PhotoCalib const &) = default;
118 PhotoCalib(PhotoCalib &&) = default;
119 PhotoCalib &operator=(PhotoCalib const &) = delete;
121
122 ~PhotoCalib() override = default;
123
128
137 explicit PhotoCalib(double calibrationMean, double calibrationErr = 0,
139 : _calibrationMean(calibrationMean), _calibrationErr(calibrationErr), _isConstant(true) {
140 assertNonNegative(_calibrationMean, "Calibration mean");
141 assertNonNegative(_calibrationErr, "Calibration error");
142 ndarray::Array<double, 2, 2> coeffs = ndarray::allocate(ndarray::makeVector(1, 1));
143 coeffs[0][0] = calibrationMean;
144 _calibration = std::make_shared<afw::math::ChebyshevBoundedField>(
146 }
147
155 : _calibration(calibration),
156 _calibrationMean(computeCalibrationMean(calibration)),
157 _calibrationErr(calibrationErr),
158 _isConstant(false) {
159 assertNonNegative(_calibrationMean, "Calibration (computed via BoundedField.mean()) mean");
160 assertNonNegative(_calibrationErr, "Calibration error");
161 }
162
173 : _calibration(calibration),
174 _calibrationMean(calibrationMean),
175 _calibrationErr(calibrationErr),
176 _isConstant(isConstant) {
177 assertNonNegative(_calibrationMean, "Calibration mean");
178 assertNonNegative(_calibrationErr, "Calibration error");
179 }
180
191 double instFluxToNanojansky(double instFlux, lsst::geom::Point<double, 2> const &point) const;
192
194 double instFluxToNanojansky(double instFlux) const;
195
207 Measurement instFluxToNanojansky(double instFlux, double instFluxErr,
208 lsst::geom::Point<double, 2> const &point) const;
209
211 Measurement instFluxToNanojansky(double instFlux, double instFluxErr) const;
212
226 std::string const &instFluxField) const;
227
240 ndarray::Array<double, 2, 2> instFluxToNanojansky(afw::table::SourceCatalog const &sourceCatalog,
241 std::string const &instFluxField) const;
242
256 void instFluxToNanojansky(afw::table::SourceCatalog &sourceCatalog, std::string const &instFluxField,
257 std::string const &outField) const;
258
269 double instFluxToMagnitude(double instFlux, lsst::geom::Point<double, 2> const &point) const;
270
272 double instFluxToMagnitude(double instFlux) const;
273
285 Measurement instFluxToMagnitude(double instFlux, double instFluxErr,
286 lsst::geom::Point<double, 2> const &point) const;
287
289 Measurement instFluxToMagnitude(double instFlux, double instFluxErr) const;
290
304 std::string const &instFluxField) const;
305
318 ndarray::Array<double, 2, 2> instFluxToMagnitude(afw::table::SourceCatalog const &sourceCatalog,
319 std::string const &instFluxField) const;
320
337 void instFluxToMagnitude(afw::table::SourceCatalog &sourceCatalog, std::string const &instFluxField,
338 std::string const &outField) const;
339
351 bool includeScaleUncertainty = true) const;
352
370 std::vector<std::string> const &instFluxFields) const;
371
374
387 double magnitudeToInstFlux(double magnitude, lsst::geom::Point<double, 2> const &point) const;
388
390 double magnitudeToInstFlux(double magnitude) const;
391
404 double getCalibrationMean() const { return _calibrationMean; }
405
418 double getCalibrationErr() const { return _calibrationErr; }
419
425 bool isConstant() const { return _isConstant; }
426
439 double getInstFluxAtZeroMagnitude() const { return utils::referenceFlux / _calibrationMean; }
440
457 double getLocalCalibration(lsst::geom::Point<double, 2> const &point) const { return evaluate(point); }
458
473
496
498 bool operator==(PhotoCalib const &rhs) const;
499
501 bool operator!=(PhotoCalib const &rhs) const { return !(*this == rhs); }
502
503 bool isPersistable() const noexcept override { return true; }
504
507
509 std::string toString() const override;
510
516 bool equals(typehandling::Storable const &other) const noexcept override;
517 // PhotoCalib equality comparable but intentionally not hashable
518
519protected:
520 std::string getPersistenceName() const override;
521
522 void write(OutputArchiveHandle &handle) const override;
523
524private:
526
527 // The "mean" calibration, defined as the geometric mean of _calibration evaluated over _calibration's
528 // bbox. Computed on instantiation as a convinience. Also, the actual calibration for a spatially-constant
529 // calibration.
530 double _calibrationMean;
531
532 // The standard deviation of this PhotoCalib.
533 double _calibrationErr;
534
535 // Is this spatially-constant? Used to short-circuit getting centroids.
536 bool _isConstant;
537
543 double evaluate(lsst::geom::Point<double, 2> const &point) const;
547 ndarray::Array<double, 1> evaluateArray(ndarray::Array<double, 1> const &xx,
548 ndarray::Array<double, 1> const &yy) const;
552 ndarray::Array<double, 1> evaluateCatalog(afw::table::SourceCatalog const &sourceCatalog) const;
553
555 double computeCalibrationMean(std::shared_ptr<afw::math::BoundedField> calibration) const;
556
558 void instFluxToNanojanskyArray(afw::table::SourceCatalog const &sourceCatalog,
559 std::string const &instFluxField,
560 ndarray::Array<double, 2, 2> result) const;
561 void instFluxToMagnitudeArray(afw::table::SourceCatalog const &sourceCatalog,
562 std::string const &instFluxField,
563 ndarray::Array<double, 2, 2> result) const;
564};
565
578
592std::shared_ptr<PhotoCalib> makePhotoCalibFromCalibZeroPoint(double instFluxMag0, double instFluxMag0Err);
593
594} // namespace image
595} // namespace afw
596} // namespace lsst
597
598#endif // LSST_AFW_IMAGE_PHOTOCALIB_H
py::object result
Definition: _schema.cc:429
table::Key< std::string > name
Definition: Amplifier.cc:116
AmpInfoBoxKey bbox
Definition: Amplifier.cc:117
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
table::Key< double > calibrationMean
Definition: PhotoCalib.cc:369
table::Key< double > calibrationErr
Definition: PhotoCalib.cc:370
std::ostream * os
Definition: Schema.cc:557
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
PhotoCalib(double calibrationMean, double calibrationErr, std::shared_ptr< afw::math::BoundedField > calibration, bool isConstant)
Create a calibration with a pre-computed mean.
Definition: PhotoCalib.h:171
afw::table::SourceCatalog calibrateCatalog(afw::table::SourceCatalog const &catalog, std::vector< std::string > const &instFluxFields) const
Return a flux calibrated catalog, with new _flux, _fluxErr, _mag, and _magErr fields.
Definition: PhotoCalib.cc:282
bool operator==(PhotoCalib const &rhs) const
Two PhotoCalibs are equal if their component bounded fields and calibrationErr are equal.
Definition: PhotoCalib.cc:229
double getCalibrationMean() const
Get the mean photometric calibration.
Definition: PhotoCalib.h:404
PhotoCalib(PhotoCalib &&)=default
double instFluxToNanojansky(double instFlux, lsst::geom::Point< double, 2 > const &point) const
Convert instFlux in ADU to nJy at a point in the BoundedField.
Definition: PhotoCalib.cc:104
std::string getPersistenceName() const override
Return the unique name used to persist this object and look up its factory.
Definition: PhotoCalib.cc:509
PhotoCalib()
Create a empty, zeroed calibration.
Definition: PhotoCalib.h:127
PhotoCalib(PhotoCalib const &)=default
double instFluxToMagnitude(double instFlux, lsst::geom::Point< double, 2 > const &point) const
Convert instFlux in ADU to AB magnitude.
Definition: PhotoCalib.cc:158
PhotoCalib(double calibrationMean, double calibrationErr=0, lsst::geom::Box2I const &bbox=lsst::geom::Box2I())
Create a non-spatially-varying calibration.
Definition: PhotoCalib.h:137
std::string toString() const override
Create a string representation of this object.
Definition: PhotoCalib.cc:242
bool operator!=(PhotoCalib const &rhs) const
Two PhotoCalibs are equal if their component bounded fields and calibrationErr are equal.
Definition: PhotoCalib.h:501
bool equals(typehandling::Storable const &other) const noexcept override
Compare this object to another Storable.
Definition: PhotoCalib.cc:252
PhotoCalib(std::shared_ptr< afw::math::BoundedField > calibration, double calibrationErr=0)
Create a spatially-varying calibration.
Definition: PhotoCalib.h:154
PhotoCalib & operator=(PhotoCalib const &)=delete
std::shared_ptr< typehandling::Storable > cloneStorable() const override
Create a new PhotoCalib that is a copy of this one.
Definition: PhotoCalib.cc:238
double getLocalCalibration(lsst::geom::Point< double, 2 > const &point) const
Get the local calibration at a point.
Definition: PhotoCalib.h:457
std::shared_ptr< afw::math::BoundedField > computeScalingTo(std::shared_ptr< PhotoCalib > other) const
Calculates the scaling between this PhotoCalib and another PhotoCalib.
Definition: PhotoCalib.cc:225
void write(OutputArchiveHandle &handle) const override
Write the object to one or more catalogs.
Definition: PhotoCalib.cc:511
bool isPersistable() const noexcept override
Return true if this particular object can be persisted using afw::table::io.
Definition: PhotoCalib.h:503
double getCalibrationErr() const
Get the mean photometric calibration error.
Definition: PhotoCalib.h:418
bool isConstant() const
Is this photoCalib spatially constant?
Definition: PhotoCalib.h:425
MaskedImage< float > calibrateImage(MaskedImage< float > const &maskedImage, bool includeScaleUncertainty=true) const
Return a flux calibrated image, with pixel values in nJy.
Definition: PhotoCalib.cc:260
~PhotoCalib() override=default
std::shared_ptr< afw::math::BoundedField > computeScaledCalibration() const
Calculates the spatially-variable calibration, normalized by the mean in the valid domain.
Definition: PhotoCalib.cc:221
PhotoCalib & operator=(PhotoCalib &&)=delete
double magnitudeToInstFlux(double magnitude, lsst::geom::Point< double, 2 > const &point) const
Convert AB magnitude to instFlux (ADU).
Definition: PhotoCalib.cc:217
double getInstFluxAtZeroMagnitude() const
Get the magnitude zero point (the instrumental flux corresponding to 0 magnitude).
Definition: PhotoCalib.h:439
A BoundedField based on 2-d Chebyshev polynomials of the first kind.
Record class that contains measurements made on a single exposure.
Definition: Source.h:78
A CRTP facade class for subclasses of Persistable.
Definition: Persistable.h:176
io::OutputArchiveHandle OutputArchiveHandle
Definition: Persistable.h:108
Interface supporting iteration over heterogenous containers.
Definition: Storable.h:58
Class for storing generic metadata.
Definition: PropertySet.h:66
An integer coordinate rectangle.
Definition: Box.h:55
Reports invalid arguments.
Definition: Runtime.h:66
bool strip
Definition: fits.cc:911
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.
std::shared_ptr< PhotoCalib > makePhotoCalibFromCalibZeroPoint(double instFluxMag0, double instFluxMag0Err)
Construct a PhotoCalib from the deprecated Calib-style instFluxMag0/instFluxMag0Err values.
Definition: PhotoCalib.cc:613
std::shared_ptr< PhotoCalib > makePhotoCalibFromMetadata(daf::base::PropertySet &metadata, bool strip=false)
Construct a PhotoCalib from FITS FLUXMAG0/FLUXMAG0ERR keywords.
Definition: PhotoCalib.cc:595
std::ostream & operator<<(std::ostream &os, Measurement const &measurement)
Definition: PhotoCalib.cc:47
void assertNonNegative(double value, std::string const &name)
Raise lsst::pex::exceptions::InvalidParameterError if value is not >=0.
Definition: PhotoCalib.h:69
const double referenceFlux
The Oke & Gunn (1983) AB magnitude reference flux, in nJy (often approximated as 3631....
Definition: Magnitude.h:46
def format(config, name=None, writeSourceLine=True, prefix="", verbose=False)
Definition: history.py:174
A base class for image defects.
A value and its error.
Definition: PhotoCalib.h:51
Measurement(double value, double error)
Definition: PhotoCalib.h:52
Utilities for converting between flux and magnitude in C++.