LSSTApplications  20.0.0
LSSTDataManagementBasePackage
Calib.h
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 
3 /*
4  * LSST Data Management System
5  * Copyright 2008, 2009, 2010 LSST Corporation.
6  *
7  * This product includes software developed by the
8  * LSST Project (http://www.lsst.org/).
9  *
10  * This program is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation, either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the LSST License Statement and
21  * the GNU General Public License along with this program. If not,
22  * see <http://www.lsstcorp.org/LegalNotices/>.
23  */
24 
25 //
26 /*
27  * Classes to support calibration (e.g. photometric zero points, exposure times)
28  */
29 #ifndef LSST_AFW_IMAGE_CALIB_H
30 #define LSST_AFW_IMAGE_CALIB_H
31 
32 #include <cmath>
33 #include <utility>
34 #include <memory>
35 #include "ndarray_fwd.h"
36 #include "lsst/base.h"
37 #include "lsst/daf/base/DateTime.h"
38 #include "lsst/pex/exceptions.h"
39 #include "lsst/geom/Point.h"
41 
42 namespace lsst {
43 namespace afw {
44 namespace image {
45 
46 static double const JanskysPerABFlux = 3631.0;
47 
49 inline double abMagFromFlux(double flux) { return -2.5 * std::log10(flux / JanskysPerABFlux); }
50 
52 inline double abMagErrFromFluxErr(double fluxErr, double flux) {
53  return std::abs(fluxErr / (-0.4 * flux * std::log(10)));
54 }
55 
57 inline double fluxFromABMag(double mag) noexcept { return std::pow(10.0, -0.4 * mag) * JanskysPerABFlux; }
58 
60 inline double fluxErrFromABMagErr(double magErr, double mag) noexcept {
61  return std::abs(-0.4 * magErr * fluxFromABMag(mag) * std::log(10.0));
62 }
63 
65 template <typename T>
66 ndarray::Array<T, 1> abMagFromFlux(ndarray::Array<T const, 1> const& flux);
67 
69 template <typename T>
70 ndarray::Array<T, 1> abMagErrFromFluxErr(ndarray::Array<T const, 1> const& fluxErr,
71  ndarray::Array<T const, 1> const& flux);
72 
74 template <typename T>
75 ndarray::Array<T, 1> fluxFromABMag(ndarray::Array<T const, 1> const& mag);
76 
78 template <typename T>
79 ndarray::Array<T, 1> fluxErrFromABMagErr(ndarray::Array<T const, 1> const& magErr,
80  ndarray::Array<T const, 1> const& mag);
81 
82 } // namespace image
83 } // namespace afw
84 } // namespace lsst
85 
86 #endif // LSST_AFW_IMAGE_CALIB_H
lsst::afw::image
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.
Definition: imageAlgorithm.dox:1
DateTime.h
Interface for DateTime class.
lsst::sphgeom::abs
Angle abs(Angle const &a)
Definition: Angle.h:106
lsst::afw
Definition: imageAlgorithm.dox:1
lsst::afw::image::fluxErrFromABMagErr
double fluxErrFromABMagErr(double magErr, double mag) noexcept
Compute flux error in Janskys from AB magnitude error and AB magnitude.
Definition: Calib.h:60
lsst::afw::image::fluxFromABMag
double fluxFromABMag(double mag) noexcept
Compute flux in Janskys from AB magnitude.
Definition: Calib.h:57
std::log
T log(T... args)
lsst::afw::image::abMagErrFromFluxErr
double abMagErrFromFluxErr(double fluxErr, double flux)
Compute AB magnitude error from flux and flux error in Janskys.
Definition: Calib.h:52
base.h
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
Persistable.h
std::log10
T log10(T... args)
Point.h
lsst::afw::image::abMagFromFlux
double abMagFromFlux(double flux)
Compute AB magnitude from flux in Janskys.
Definition: Calib.h:49
exceptions.h
std::pow
T pow(T... args)