LSST Applications
21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
|
#include <PhotometryModel.h>
Public Member Functions | |
PhotometryModel (LOG_LOGGER log, double errorPedestal=0) | |
virtual Eigen::Index | assignIndices (std::string const &whatToFit, Eigen::Index firstIndex)=0 |
Assign indices in the full matrix to the parameters being fit in the mappings, starting at firstIndex. More... | |
virtual void | offsetParams (Eigen::VectorXd const &delta)=0 |
Offset the parameters by the provided amounts (by -delta). More... | |
virtual void | offsetFittedStar (FittedStar &fittedStar, double delta) const =0 |
Offset the appropriate flux or magnitude (by -delta). More... | |
virtual double | computeResidual (CcdImage const &ccdImage, MeasuredStar const &measuredStar) const =0 |
Compute the residual between the model applied to a star and its associated fittedStar. More... | |
virtual double | transform (CcdImage const &ccdImage, MeasuredStar const &measuredStar) const =0 |
Return the on-sky transformed flux for measuredStar on ccdImage. More... | |
virtual double | transformError (CcdImage const &ccdImage, MeasuredStar const &measuredStar) const =0 |
Return the on-sky transformed flux uncertainty for measuredStar on ccdImage. More... | |
virtual void | freezeErrorTransform ()=0 |
Once this routine has been called, the error transform is not modified by offsetParams(). More... | |
virtual void | getMappingIndices (CcdImage const &ccdImage, IndexVector &indices) const =0 |
Get how this set of parameters (of length Npar()) map into the "grand" fit. More... | |
virtual void | computeParameterDerivatives (MeasuredStar const &measuredStar, CcdImage const &ccdImage, Eigen::VectorXd &derivatives) const =0 |
Compute the parametric derivatives of this model. More... | |
virtual double | getRefError (RefStar const &refStar) const =0 |
Return the refStar error appropriate for this model (e.g. fluxErr or magErr). More... | |
virtual double | computeRefResidual (FittedStar const &fittedStar, RefStar const &refStar) const =0 |
Return the fittedStar - refStar residual appropriate for this model (e.g. flux - flux or mag - mag). More... | |
virtual std::shared_ptr< afw::image::PhotoCalib > | toPhotoCalib (CcdImage const &ccdImage) const =0 |
Return the mapping of ccdImage represented as a PhotoCalib. More... | |
std::size_t | getNpar (CcdImage const &ccdImage) const |
Return the number of parameters in the mapping of CcdImage. More... | |
PhotometryMappingBase const & | getMapping (CcdImage const &ccdImage) const |
Get the mapping associated with ccdImage. More... | |
virtual std::size_t | getTotalParameters () const =0 |
Return the total number of parameters in this model. More... | |
virtual void | print (std::ostream &out) const =0 |
Print a string representation of the contents of this mapping, for debugging. More... | |
bool | validate (CcdImageList const &ccdImageList, int ndof) const |
Return true if this is a "reasonable" model. More... | |
bool | checkPositiveOnBBox (CcdImage const &ccdImage) const |
Check that the model is positive on the ccdImage bbox. More... | |
double | getErrorPedestal () |
double | tweakFluxError (jointcal::MeasuredStar const &measuredStar) const |
Add a fraction of the instrumental flux to the instrumental flux error, in quadrature. More... | |
double | tweakMagnitudeError (jointcal::MeasuredStar const &measuredStar) const |
Add a small magnitude offset to the "instrumental magnitude" error, in quadrature. More... | |
virtual | ~PhotometryModel ()=default |
Protected Member Functions | |
virtual PhotometryMappingBase * | findMapping (CcdImage const &ccdImage) const =0 |
Return a pointer to the mapping associated with this ccdImage. More... | |
Protected Attributes | |
LOG_LOGGER | _log |
lsst.logging instance, to be created by a subclass so that messages have consistent name. More... | |
double | errorPedestal |
Friends | |
std::ostream & | operator<< (std::ostream &s, PhotometryModel const &model) |
Definition at line 44 of file PhotometryModel.h.
|
inline |
log | Logger to send messages to, to keep names consistent when logging. |
errorPedestal | Pedestal on flux/magnitude error (percent of flux or delta magnitude). |
Definition at line 50 of file PhotometryModel.h.
|
virtualdefault |
|
pure virtual |
Assign indices in the full matrix to the parameters being fit in the mappings, starting at firstIndex.
[in] | whatToFit | String containing parameters to fit. |
[in] | firstIndex | Index to start assigning at. |
Implemented in lsst::jointcal::SimplePhotometryModel, and lsst::jointcal::ConstrainedPhotometryModel.
bool lsst::jointcal::PhotometryModel::checkPositiveOnBBox | ( | CcdImage const & | ccdImage | ) | const |
Check that the model is positive on the ccdImage bbox.
ccdImage | The ccdImage to test. |
Definition at line 49 of file PhotometryModel.cc.
|
pure virtual |
Compute the parametric derivatives of this model.
[in] | measuredStar | The measured star with the position and flux to compute at. |
[in] | ccdImage | The ccdImage containing the measured star, to find the correct mapping. |
[out] | derivatives | The computed derivatives. Must be pre-allocated to the correct size. |
Implemented in lsst::jointcal::SimplePhotometryModel, and lsst::jointcal::ConstrainedPhotometryModel.
|
pure virtual |
Return the fittedStar - refStar residual appropriate for this model (e.g. flux - flux or mag - mag).
Implemented in lsst::jointcal::SimpleMagnitudeModel, lsst::jointcal::SimpleFluxModel, lsst::jointcal::ConstrainedMagnitudeModel, and lsst::jointcal::ConstrainedFluxModel.
|
pure virtual |
Compute the residual between the model applied to a star and its associated fittedStar.
\[ residual = Model(measuredStar) - fittedStar \]
ccdImage | The ccdImage where measuredStar resides. |
measuredStar | The measured star position to compute the residual of. |
Implemented in lsst::jointcal::SimpleMagnitudeModel, lsst::jointcal::SimpleFluxModel, lsst::jointcal::ConstrainedMagnitudeModel, and lsst::jointcal::ConstrainedFluxModel.
|
protectedpure virtual |
Return a pointer to the mapping associated with this ccdImage.
Implemented in lsst::jointcal::SimplePhotometryModel, and lsst::jointcal::ConstrainedPhotometryModel.
|
pure virtual |
Once this routine has been called, the error transform is not modified by offsetParams().
The routine can be called when the mappings are roughly in place. After the call, the transformations used to propagate errors are no longer affected when updating the mappings. This allows an exactly linear fit, which can be necessary for some model+data combinations.
Implemented in lsst::jointcal::SimplePhotometryModel, and lsst::jointcal::ConstrainedPhotometryModel.
|
inline |
Definition at line 196 of file PhotometryModel.h.
|
inline |
Get the mapping associated with ccdImage.
Definition at line 156 of file PhotometryModel.h.
|
pure virtual |
Get how this set of parameters (of length Npar()) map into the "grand" fit.
[in] | ccdImage | The ccdImage to look up. |
[out] | indices | The indices of the mapping associated with ccdImage. |
Implemented in lsst::jointcal::SimplePhotometryModel, and lsst::jointcal::ConstrainedPhotometryModel.
|
inline |
Return the number of parameters in the mapping of CcdImage.
Definition at line 153 of file PhotometryModel.h.
|
pure virtual |
Return the refStar error appropriate for this model (e.g. fluxErr or magErr).
Implemented in lsst::jointcal::SimpleMagnitudeModel, lsst::jointcal::SimpleFluxModel, lsst::jointcal::ConstrainedMagnitudeModel, and lsst::jointcal::ConstrainedFluxModel.
|
pure virtual |
Return the total number of parameters in this model.
Implemented in lsst::jointcal::SimplePhotometryModel, and lsst::jointcal::ConstrainedPhotometryModel.
|
pure virtual |
Offset the appropriate flux or magnitude (by -delta).
fittedStar | The star to update. |
delta | The amount to update by. |
Implemented in lsst::jointcal::SimpleMagnitudeModel, lsst::jointcal::SimpleFluxModel, lsst::jointcal::ConstrainedMagnitudeModel, and lsst::jointcal::ConstrainedFluxModel.
|
pure virtual |
Offset the parameters by the provided amounts (by -delta).
The shifts are applied according to the indices given in assignIndices.
[in] | delta | vector of offsets to apply |
Implemented in lsst::jointcal::SimplePhotometryModel, and lsst::jointcal::ConstrainedPhotometryModel.
|
pure virtual |
Print a string representation of the contents of this mapping, for debugging.
This string representation can be very verbose, as it contains all of the parameters of all of the transforms in this model.
Implemented in lsst::jointcal::SimpleMagnitudeModel, lsst::jointcal::SimpleFluxModel, lsst::jointcal::SimplePhotometryModel, lsst::jointcal::ConstrainedMagnitudeModel, lsst::jointcal::ConstrainedFluxModel, and lsst::jointcal::ConstrainedPhotometryModel.
|
pure virtual |
Return the mapping of ccdImage represented as a PhotoCalib.
Implemented in lsst::jointcal::SimpleMagnitudeModel, lsst::jointcal::SimpleFluxModel, lsst::jointcal::ConstrainedMagnitudeModel, and lsst::jointcal::ConstrainedFluxModel.
|
pure virtual |
Return the on-sky transformed flux for measuredStar on ccdImage.
[in] | ccdImage | The ccdImage where measuredStar resides. |
measuredStar | The measured star position to transform. |
Implemented in lsst::jointcal::SimpleMagnitudeModel, lsst::jointcal::SimpleFluxModel, lsst::jointcal::ConstrainedMagnitudeModel, and lsst::jointcal::ConstrainedFluxModel.
|
pure virtual |
Return the on-sky transformed flux uncertainty for measuredStar on ccdImage.
Identical to transform() until freezeErrorTransform() is called.
[in] | ccdImage | The ccdImage where measuredStar resides. |
measuredStar | The measured star position to transform. |
Implemented in lsst::jointcal::SimpleMagnitudeModel, lsst::jointcal::SimpleFluxModel, lsst::jointcal::ConstrainedMagnitudeModel, and lsst::jointcal::ConstrainedFluxModel.
|
inline |
Add a fraction of the instrumental flux to the instrumental flux error, in quadrature.
Definition at line 199 of file PhotometryModel.h.
|
inline |
Add a small magnitude offset to the "instrumental magnitude" error, in quadrature.
Definition at line 208 of file PhotometryModel.h.
bool lsst::jointcal::PhotometryModel::validate | ( | CcdImageList const & | ccdImageList, |
int | ndof | ||
) | const |
Return true if this is a "reasonable" model.
A valid photometry model is positive within each sensor's bounding box.
ccdImageList | The ccdImages to test the model validity on. |
ndof | The number of degrees of freedom in the fit, e.g. from Fitterbase.computeChi2(). |
Definition at line 33 of file PhotometryModel.cc.
|
friend |
Definition at line 191 of file PhotometryModel.h.
|
protected |
lsst.logging instance, to be created by a subclass so that messages have consistent name.
Definition at line 223 of file PhotometryModel.h.
|
protected |
Definition at line 226 of file PhotometryModel.h.