LSST Applications  21.0.0+04719a4bac,21.0.0-1-ga51b5d4+4b710797af,21.0.0-1-gfc31b0f+3b24369756,21.0.0-10-g2408eff+50e97f2f47,21.0.0-10-g560fb7b+0803ad37c5,21.0.0-10-g5daeb2b+f9b8dc6d5a,21.0.0-10-g8d1d15d+77a6b82ebf,21.0.0-10-gcf60f90+c961be884d,21.0.0-11-g25eff31+7692554667,21.0.0-17-g6590b197+a14a01c114,21.0.0-2-g103fe59+b79afc2051,21.0.0-2-g1367e85+1003a3501c,21.0.0-2-g45278ab+04719a4bac,21.0.0-2-g5242d73+1003a3501c,21.0.0-2-g7f82c8f+c2a1919b98,21.0.0-2-g8f08a60+fd0b970de5,21.0.0-2-ga326454+c2a1919b98,21.0.0-2-gde069b7+ca45a81b40,21.0.0-2-gecfae73+afcaaec585,21.0.0-2-gfc62afb+1003a3501c,21.0.0-21-g5d80ea29e+5e3c9a3766,21.0.0-3-g357aad2+c67f36f878,21.0.0-3-g4be5c26+1003a3501c,21.0.0-3-g65f322c+02b1f88459,21.0.0-3-g7d9da8d+3b24369756,21.0.0-3-ge02ed75+a423c2ae7a,21.0.0-4-g591bb35+a423c2ae7a,21.0.0-4-g65b4814+0803ad37c5,21.0.0-4-g88306b8+199c7497e5,21.0.0-4-gccdca77+a631590478,21.0.0-4-ge8a399c+b923ff878e,21.0.0-5-gd00fb1e+d8b1e95daa,21.0.0-53-ge728e5d5+3cb64fea8e,21.0.0-6-g2d4f3f3+04719a4bac,21.0.0-7-g04766d7+8d320c19d5,21.0.0-7-g98eecf7+205433fbda,21.0.0-9-g39e06b5+a423c2ae7a,master-gac4afde19b+a423c2ae7a,w.2021.11
LSST Data Management Base Package
Calib.cc
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 
3 /*
4  * LSST Data Management System
5  * Copyright 2008-2016 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  * Classes to support calibration (e.g. photometric zero points, exposure times)
27  */
28 #include <cmath>
29 #include <cstdint>
30 
31 #include "ndarray.h"
32 #include "lsst/pex/exceptions.h"
33 #include "lsst/afw/image/Calib.h"
34 
35 namespace lsst {
36 namespace afw {
37 
38 namespace image {
39 
41 template <typename T>
42 ndarray::Array<T, 1> abMagFromFlux(ndarray::Array<T const, 1> const& flux) {
43  ndarray::Array<T, 1> out = ndarray::allocate(flux.getShape());
44  for (std::size_t ii = 0; ii < flux.getNumElements(); ++ii) {
45  out[ii] = abMagFromFlux(flux[ii]);
46  }
47  return out;
48 }
49 
51 template <typename T>
52 ndarray::Array<T, 1> abMagErrFromFluxErr(ndarray::Array<T const, 1> const& fluxErr,
53  ndarray::Array<T const, 1> const& flux) {
54  if (flux.getNumElements() != fluxErr.getNumElements()) {
55  throw LSST_EXCEPT(pex::exceptions::LengthError, (boost::format("Length mismatch: %d vs %d") %
56  flux.getNumElements() % fluxErr.getNumElements())
57  .str());
58  }
59  ndarray::Array<T, 1> out = ndarray::allocate(flux.getShape());
60  for (std::size_t ii = 0; ii < flux.getNumElements(); ++ii) {
61  out[ii] = abMagErrFromFluxErr(fluxErr[ii], flux[ii]);
62  }
63  return out;
64 }
65 
67 template <typename T>
68 ndarray::Array<T, 1> fluxFromABMag(ndarray::Array<T const, 1> const& mag) {
69  ndarray::Array<T, 1> out = ndarray::allocate(mag.getShape());
70  for (std::size_t ii = 0; ii < mag.getNumElements(); ++ii) {
71  out[ii] = fluxFromABMag(mag[ii]);
72  }
73  return out;
74 }
75 
77 template <typename T>
78 ndarray::Array<T, 1> fluxErrFromABMagErr(ndarray::Array<T const, 1> const& magErr,
79  ndarray::Array<T const, 1> const& mag) {
80  if (mag.getNumElements() != magErr.getNumElements()) {
81  throw LSST_EXCEPT(pex::exceptions::LengthError, (boost::format("Length mismatch: %d vs %d") %
82  mag.getNumElements() % magErr.getNumElements())
83  .str());
84  }
85  ndarray::Array<T, 1> out = ndarray::allocate(mag.getShape());
86  for (std::size_t ii = 0; ii < mag.getNumElements(); ++ii) {
87  out[ii] = fluxErrFromABMagErr(magErr[ii], mag[ii]);
88  }
89  return out;
90 }
91 
92 // Explicit instantiation
93 #define INSTANTIATE(TYPE) \
94  template ndarray::Array<TYPE, 1> abMagFromFlux(ndarray::Array<TYPE const, 1> const& flux); \
95  template ndarray::Array<TYPE, 1> abMagErrFromFluxErr(ndarray::Array<TYPE const, 1> const& fluxErr, \
96  ndarray::Array<TYPE const, 1> const& flux); \
97  template ndarray::Array<TYPE, 1> fluxFromABMag(ndarray::Array<TYPE const, 1> const& mag); \
98  template ndarray::Array<TYPE, 1> fluxErrFromABMagErr(ndarray::Array<TYPE const, 1> const& magErr, \
99  ndarray::Array<TYPE const, 1> const& mag);
100 
101 INSTANTIATE(float);
102 INSTANTIATE(double);
103 
104 } // namespace image
105 } // namespace afw
106 } // namespace lsst
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
Reports attempts to exceed implementation-defined length limits for some classes.
Definition: Runtime.h:76
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.
double abMagErrFromFluxErr(double fluxErr, double flux)
Compute AB magnitude error from flux and flux error in Janskys.
Definition: Calib.h:52
double fluxErrFromABMagErr(double magErr, double mag) noexcept
Compute flux error in Janskys from AB magnitude error and AB magnitude.
Definition: Calib.h:60
double abMagFromFlux(double flux)
Compute AB magnitude from flux in Janskys.
Definition: Calib.h:49
double fluxFromABMag(double mag) noexcept
Compute flux in Janskys from AB magnitude.
Definition: Calib.h:57
def format(config, name=None, writeSourceLine=True, prefix="", verbose=False)
Definition: history.py:174
A base class for image defects.
#define INSTANTIATE(TYPE)
Definition: Calib.cc:93