LSSTApplications  20.0.0
LSSTDataManagementBasePackage
SimplePhotometryModel.cc
Go to the documentation of this file.
1 // -*- LSST-C++ -*-
2 /*
3  * This file is part of jointcal.
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 <iostream>
26 #include <cmath>
27 
28 #include "lsst/log/Log.h"
32 #include "lsst/jointcal/CcdImage.h"
34 
35 namespace lsst {
36 namespace jointcal {
37 
38 Eigen::Index SimplePhotometryModel::assignIndices(std::string const &whatToFit, Eigen::Index firstIndex) {
39  Eigen::Index ipar = firstIndex;
40  for (auto const &i : _myMap) {
41  auto mapping = i.second.get();
42  mapping->setIndex(ipar);
43  ipar += mapping->getNpar();
44  }
45  return ipar;
46 }
47 
48 void SimplePhotometryModel::offsetParams(Eigen::VectorXd const &delta) {
49  for (auto &i : _myMap) {
50  auto mapping = i.second.get();
51  mapping->offsetParams(delta.segment(mapping->getIndex(), mapping->getNpar()));
52  }
53 }
54 
56  for (auto &i : _myMap) {
57  i.second->freezeErrorTransform();
58  }
59 }
60 
62  std::vector<Eigen::Index> &indices) const {
63  auto mapping = findMapping(ccdImage);
64  if (indices.size() < mapping->getNpar()) indices.resize(mapping->getNpar());
65  indices[0] = mapping->getIndex();
66 }
67 
69  std::size_t total = 0;
70  for (auto &i : _myMap) {
71  total += i.second->getNpar();
72  }
73  return total;
74 }
75 
77  CcdImage const &ccdImage,
78  Eigen::VectorXd &derivatives) const {
79  auto mapping = findMapping(ccdImage);
80  mapping->computeParameterDerivatives(measuredStar, measuredStar.getInstFlux(), derivatives);
81 }
82 
84  for (auto &i : _myMap) {
85  out << i.first << ": ";
86  i.second->print(out);
87  out << std::endl;
88  }
89 }
90 
92  auto i = _myMap.find(ccdImage.getHashKey());
93  if (i == _myMap.end())
95  "SimplePhotometryModel cannot find CcdImage " + ccdImage.getName());
96  return i->second.get();
97 }
98 
99 SimpleFluxModel::SimpleFluxModel(CcdImageList const &ccdImageList, double errorPedestal)
100  : SimplePhotometryModel(ccdImageList, LOG_GET("jointcal.SimpleFluxModel"), errorPedestal) {
101  for (auto const &ccdImage : ccdImageList) {
102  auto photoCalib = ccdImage->getPhotoCalib();
103  // Use the single-frame processing calibration from the PhotoCalib as the initial value.
104  auto transform = std::make_shared<FluxTransformSpatiallyInvariant>(photoCalib->getCalibrationMean());
105  _myMap.emplace(ccdImage->getHashKey(), std::make_unique<PhotometryMapping>(transform));
106  }
107  LOGLS_INFO(_log, "SimpleFluxModel got " << _myMap.size() << " ccdImage mappings.");
108 }
109 
110 double SimpleFluxModel::computeResidual(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const {
111  return transform(ccdImage, measuredStar) - measuredStar.getFittedStar()->getFlux();
112 }
113 
114 double SimpleFluxModel::transform(CcdImage const &ccdImage, MeasuredStar const &star) const {
115  auto mapping = findMapping(ccdImage);
116  return mapping->transform(star, star.getInstFlux());
117 }
118 
119 double SimpleFluxModel::transformError(CcdImage const &ccdImage, MeasuredStar const &star) const {
120  auto mapping = findMapping(ccdImage);
121  double tempErr = tweakFluxError(star);
122  return mapping->transformError(star, star.getInstFlux(), tempErr);
123 }
124 
126  double calibration = (findMapping(ccdImage)->getParameters()[0]);
127  auto oldPhotoCalib = ccdImage.getPhotoCalib();
128  return std::make_unique<afw::image::PhotoCalib>(calibration, oldPhotoCalib->getCalibrationErr());
129 }
130 
132  out << "SimpleFluxModel (" << _myMap.size() << " mappings):" << std::endl;
134 }
135 
136 SimpleMagnitudeModel::SimpleMagnitudeModel(CcdImageList const &ccdImageList, double errorPedestal)
137  : SimplePhotometryModel(ccdImageList, LOG_GET("jointcal.SimpleMagnitudeModel"), errorPedestal) {
138  for (auto const &ccdImage : ccdImageList) {
139  auto photoCalib = ccdImage->getPhotoCalib();
140  // Use the single-frame processing calibration from the PhotoCalib as the default.
141  double calib = utils::nanojanskyToABMagnitude(photoCalib->getCalibrationMean());
142  auto transform = std::make_shared<MagnitudeTransformSpatiallyInvariant>(calib);
143  _myMap.emplace(ccdImage->getHashKey(), std::make_unique<PhotometryMapping>(transform));
144  }
145  LOGLS_INFO(_log, "SimpleMagnitudeModel got " << _myMap.size() << " ccdImage mappings.");
146 }
147 
149  MeasuredStar const &measuredStar) const {
150  return transform(ccdImage, measuredStar) - measuredStar.getFittedStar()->getMag();
151 }
152 
153 double SimpleMagnitudeModel::transform(CcdImage const &ccdImage, MeasuredStar const &star) const {
154  auto mapping = findMapping(ccdImage);
155  return mapping->transform(star, star.getInstMag());
156 }
157 
158 double SimpleMagnitudeModel::transformError(CcdImage const &ccdImage, MeasuredStar const &star) const {
159  auto mapping = findMapping(ccdImage);
160  double tempErr = tweakMagnitudeError(star);
161  return mapping->transformError(star, star.getInstMag(), tempErr);
162 }
163 
165  // NOTE: photocalib is defined as `instFlux * calibration = flux`,
166  // so we have to convert the transform from magnitude space.
167  double calibration = utils::ABMagnitudeToNanojansky(findMapping(ccdImage)->getParameters()[0]);
168  auto oldPhotoCalib = ccdImage.getPhotoCalib();
169  return std::make_unique<afw::image::PhotoCalib>(calibration, oldPhotoCalib->getCalibrationErr());
170 }
171 
173  out << "SimpleMagnitudeModel (" << _myMap.size() << " mappings):" << std::endl;
175 }
176 
177 } // namespace jointcal
178 } // namespace lsst
lsst::jointcal::SimplePhotometryModel::offsetParams
void offsetParams(Eigen::VectorXd const &delta) override
Offset the parameters by the provided amounts (by -delta).
Definition: SimplePhotometryModel.cc:48
lsst::jointcal::CcdImage::getHashKey
CcdImageKey getHashKey() const
Definition: CcdImage.h:152
lsst::jointcal::MeasuredStar
objects measured on actual images.
Definition: MeasuredStar.h:46
std::vector::resize
T resize(T... args)
SimplePhotometryModel.h
PhotometryTransform.h
std::string
STL class.
std::shared_ptr
STL class.
std::list< std::shared_ptr< CcdImage > >
CcdImage.h
lsst::jointcal::MeasuredStar::getInstFlux
double getInstFlux() const
Definition: MeasuredStar.h:97
lsst::jointcal::SimplePhotometryModel::findMapping
PhotometryMappingBase * findMapping(CcdImage const &ccdImage) const override
Return the mapping associated with this ccdImage.
Definition: SimplePhotometryModel.cc:91
lsst::jointcal::SimpleMagnitudeModel::transform
double transform(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override
Return the on-sky transformed flux for measuredStar on ccdImage.
Definition: SimplePhotometryModel.cc:153
lsst::jointcal::SimpleFluxModel::transform
double transform(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override
Return the on-sky transformed flux for measuredStar on ccdImage.
Definition: SimplePhotometryModel.cc:114
std::vector
STL class.
std::unordered_map::find
T find(T... args)
MeasuredStar.h
std::vector::size
T size(T... args)
std::unordered_map::emplace
T emplace(T... args)
LOG_GET
#define LOG_GET(logger)
Definition: Log.h:75
LOGLS_INFO
#define LOGLS_INFO(logger, message)
Definition: Log.h:628
lsst::jointcal::PhotometryMappingBase
Relates transform(s) to their position in the fitting matrix and allows interaction with the transfor...
Definition: PhotometryMapping.h:44
lsst::jointcal::CcdImage::getName
std::string getName() const
Return the _name that identifies this ccdImage.
Definition: CcdImage.h:79
lsst::jointcal::SimplePhotometryModel::assignIndices
Eigen::Index assignIndices(std::string const &whatToFit, Eigen::Index firstIndex) override
Assign indices in the full matrix to the parameters being fit in the mappings, starting at firstIndex...
Definition: SimplePhotometryModel.cc:38
lsst::jointcal::SimpleMagnitudeModel::computeResidual
double computeResidual(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override
Compute the residual between the model applied to a star and its associated fittedStar.
Definition: SimplePhotometryModel.cc:148
lsst::jointcal::PhotometryModel::tweakFluxError
double tweakFluxError(jointcal::MeasuredStar const &measuredStar) const
Add a fraction of the instrumental flux to the instrumental flux error, in quadrature.
Definition: PhotometryModel.h:199
calib
Key< int > calib
Definition: Exposure.cc:66
lsst::jointcal::SimplePhotometryModel::getTotalParameters
std::size_t getTotalParameters() const override
Return the total number of parameters in this model.
Definition: SimplePhotometryModel.cc:68
lsst::jointcal::SimpleFluxModel::computeResidual
double computeResidual(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override
Compute the residual between the model applied to a star and its associated fittedStar.
Definition: SimplePhotometryModel.cc:110
std::ostream
STL class.
lsst::jointcal::CcdImage
Handler of an actual image from a single CCD.
Definition: CcdImage.h:64
lsst::jointcal::SimpleMagnitudeModel::toPhotoCalib
std::shared_ptr< afw::image::PhotoCalib > toPhotoCalib(CcdImage const &ccdImage) const override
Return the mapping of ccdImage represented as a PhotoCalib.
Definition: SimplePhotometryModel.cc:164
lsst::jointcal::SimpleMagnitudeModel::transformError
double transformError(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override
Return the on-sky transformed flux uncertainty for measuredStar on ccdImage.
Definition: SimplePhotometryModel.cc:158
lsst::jointcal::MeasuredStar::getFittedStar
std::shared_ptr< FittedStar > getFittedStar() const
Definition: MeasuredStar.h:113
lsst::jointcal
Definition: Associations.h:49
lsst::jointcal::SimpleFluxModel::transformError
double transformError(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override
Return the on-sky transformed flux uncertainty for measuredStar on ccdImage.
Definition: SimplePhotometryModel.cc:119
lsst::jointcal::MeasuredStar::getInstMag
double getInstMag() const
Definition: MeasuredStar.h:99
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::jointcal::SimplePhotometryModel::freezeErrorTransform
void freezeErrorTransform() override
Once this routine has been called, the error transform is not modified by offsetParams().
Definition: SimplePhotometryModel.cc:55
LSST_EXCEPT
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
lsst::utils::nanojanskyToABMagnitude
double nanojanskyToABMagnitude(double flux)
Convert a flux in nanojansky to AB magnitude.
Definition: Magnitude.cc:30
lsst::jointcal::SimplePhotometryModel
Photometric response model which has a single photometric factor per CcdImage.
Definition: SimplePhotometryModel.h:43
photoCalib
Key< int > photoCalib
Definition: Exposure.cc:67
std::endl
T endl(T... args)
lsst::jointcal::SimplePhotometryModel::_myMap
MapType _myMap
Definition: SimplePhotometryModel.h:80
lsst::pex::exceptions::InvalidParameterError
Reports invalid arguments.
Definition: Runtime.h:66
lsst::jointcal::PhotometryModel::_log
LOG_LOGGER _log
lsst.logging instance, to be created by a subclass so that messages have consistent name.
Definition: PhotometryModel.h:221
lsst::jointcal::SimplePhotometryModel::computeParameterDerivatives
void computeParameterDerivatives(MeasuredStar const &measuredStar, CcdImage const &ccdImage, Eigen::VectorXd &derivatives) const override
Compute the parametric derivatives of this model.
Definition: SimplePhotometryModel.cc:76
lsst::jointcal::SimpleFluxModel::SimpleFluxModel
SimpleFluxModel(CcdImageList const &ccdImageList, double errorPedestal=0)
Definition: SimplePhotometryModel.cc:99
lsst::utils::ABMagnitudeToNanojansky
double ABMagnitudeToNanojansky(double magnitude)
Convert an AB magnitude to a flux in nanojansky.
Definition: Magnitude.cc:32
lsst::jointcal::SimpleMagnitudeModel::print
void print(std::ostream &out) const override
Print a string representation of the contents of this mapping, for debugging.
Definition: SimplePhotometryModel.cc:172
lsst::jointcal::SimplePhotometryModel::getMappingIndices
void getMappingIndices(CcdImage const &ccdImage, IndexVector &indices) const override
Get how this set of parameters (of length Npar()) map into the "grand" fit.
Definition: SimplePhotometryModel.cc:61
lsst::jointcal::PhotometryModel::tweakMagnitudeError
double tweakMagnitudeError(jointcal::MeasuredStar const &measuredStar) const
Add a small magnitude offset to the "instrumental magnitude" error, in quadrature.
Definition: PhotometryModel.h:208
std::size_t
std::unordered_map::end
T end(T... args)
lsst::jointcal::SimpleFluxModel::toPhotoCalib
std::shared_ptr< afw::image::PhotoCalib > toPhotoCalib(CcdImage const &ccdImage) const override
Return the mapping of ccdImage represented as a PhotoCalib.
Definition: SimplePhotometryModel.cc:125
lsst::jointcal::SimplePhotometryModel::print
virtual void print(std::ostream &out) const override
Print a string representation of the contents of this mapping, for debugging.
Definition: SimplePhotometryModel.cc:83
lsst::jointcal::CcdImage::getPhotoCalib
std::shared_ptr< afw::image::PhotoCalib > getPhotoCalib() const
Return the exposure's photometric calibration.
Definition: CcdImage.h:161
lsst::jointcal::PhotometryMappingBase::getParameters
virtual Eigen::VectorXd getParameters()=0
lsst::jointcal::SimpleFluxModel::print
void print(std::ostream &out) const override
Print a string representation of the contents of this mapping, for debugging.
Definition: SimplePhotometryModel.cc:131
lsst::jointcal::SimpleMagnitudeModel::SimpleMagnitudeModel
SimpleMagnitudeModel(CcdImageList const &ccdImageList, double errorPedestal=0)
Definition: SimplePhotometryModel.cc:136
Log.h
LSST DM logging module built on log4cxx.
PhotometryMapping.h