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
|
Photometry model with constraints, \(M(x,y) = M_CCD(x,y)*M_visit(u,v)\). More...
#include <ConstrainedPhotometryModel.h>
Classes | |
struct | PrepPhotoCalib |
To hold the return of prepPhotoCalib. More... | |
Public Member Functions | |
ConstrainedPhotometryModel (CcdImageList const &ccdImageList, geom::Box2D const &focalPlaneBBox, LOG_LOGGER log, int visitOrder=7, double errorPedestal=0) | |
Construct a constrained photometry model. More... | |
ConstrainedPhotometryModel (ConstrainedPhotometryModel const &)=delete | |
No copy or move: there is only ever one instance of a given model (i.e. per ccd+visit) More... | |
ConstrainedPhotometryModel (ConstrainedPhotometryModel &&)=delete | |
ConstrainedPhotometryModel & | operator= (ConstrainedPhotometryModel const &)=delete |
ConstrainedPhotometryModel & | operator= (ConstrainedPhotometryModel &&)=delete |
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. More... | |
void | offsetParams (Eigen::VectorXd const &delta) override |
Offset the parameters by the provided amounts (by -delta). More... | |
void | freezeErrorTransform () override |
Once this routine has been called, the error transform is not modified by offsetParams(). More... | |
void | getMappingIndices (CcdImage const &ccdImage, IndexVector &indices) const override |
Get how this set of parameters (of length Npar()) map into the "grand" fit. More... | |
std::size_t | getTotalParameters () const override |
Return the total number of parameters in this model. More... | |
void | computeParameterDerivatives (MeasuredStar const &measuredStar, CcdImage const &ccdImage, Eigen::VectorXd &derivatives) const override |
Compute the parametric derivatives of this model. More... | |
void | print (std::ostream &out) const override |
Print a string representation of the contents of this mapping, for debugging. More... | |
~ConstrainedPhotometryModel ()=default | |
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 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... | |
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... | |
Protected Types | |
typedef std::unordered_map< CcdImageKey, std::unique_ptr< ChipVisitPhotometryMapping > > | MapType |
typedef std::map< VisitIdType, std::shared_ptr< PhotometryMapping > > | VisitMapType |
typedef std::map< CcdIdType, std::shared_ptr< PhotometryMapping > > | ChipMapType |
Protected Member Functions | |
PhotometryMappingBase * | findMapping (CcdImage const &ccdImage) const override |
Return a pointer to the mapping associated with this ccdImage. More... | |
template<class ChipTransform , class VisitTransform , class ChipVisitMapping > | |
void | initialize (CcdImageList const &ccdImageList, geom::Box2D const &focalPlaneBBox, int visitOrder) |
Initialize the chip, visit, and chipVisit mappings by creating appropriate transforms and mappings. More... | |
virtual double | initialChipCalibration (std::shared_ptr< afw::image::PhotoCalib const > photoCalib)=0 |
Return the initial calibration to use from this photoCalib. More... | |
PrepPhotoCalib | prepPhotoCalib (CcdImage const &ccdImage) const |
Helper for preparing toPhotoCalib() More... | |
Protected Attributes | |
MapType | _chipVisitMap |
VisitMapType | _visitMap |
ChipMapType | _chipMap |
LOG_LOGGER | _log |
lsst.logging instance, to be created by a subclass so that messages have consistent name. More... | |
double | errorPedestal |
Photometry model with constraints, \(M(x,y) = M_CCD(x,y)*M_visit(u,v)\).
This model consists of the following components:
Because this model's parameters are degenerate under multiplication by a constant, \(M=(a*M_CCD)*(1/a*M_visit)\), we hold one CCD's zero point fixed to remove that degeneracy.
Definition at line 48 of file ConstrainedPhotometryModel.h.
|
protected |
Definition at line 110 of file ConstrainedPhotometryModel.h.
|
protected |
Definition at line 103 of file ConstrainedPhotometryModel.h.
|
protected |
Definition at line 107 of file ConstrainedPhotometryModel.h.
|
inlineexplicit |
Construct a constrained photometry model.
ccdImageList | The list of CCDImages to construct the model for. | |
focalPlaneBBox | The bounding box of the camera's focal plane, defining the domain of the visit polynomial. | |
[in] | log | An lsst::log::Log instance to log messages to. |
[in] | visitOrder | The order of the visit polynomial. |
[in] | errorPedestal | A pedestal in flux or magnitude to apply to all MeasuredStar flux errors. |
Definition at line 60 of file ConstrainedPhotometryModel.h.
|
delete |
No copy or move: there is only ever one instance of a given model (i.e. per ccd+visit)
|
delete |
|
default |
|
overridevirtual |
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. |
Implements lsst::jointcal::PhotometryModel.
Definition at line 45 of file ConstrainedPhotometryModel.cc.
|
inherited |
Check that the model is positive on the ccdImage bbox.
ccdImage | The ccdImage to test. |
Definition at line 49 of file PhotometryModel.cc.
|
overridevirtual |
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. |
Implements lsst::jointcal::PhotometryModel.
Definition at line 125 of file ConstrainedPhotometryModel.cc.
|
pure virtualinherited |
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 virtualinherited |
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.
|
overrideprotectedvirtual |
Return a pointer to the mapping associated with this ccdImage.
Implements lsst::jointcal::PhotometryModel.
Definition at line 168 of file ConstrainedPhotometryModel.cc.
|
overridevirtual |
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.
Implements lsst::jointcal::PhotometryModel.
Definition at line 100 of file ConstrainedPhotometryModel.cc.
|
inlineinherited |
Definition at line 196 of file PhotometryModel.h.
|
inlineinherited |
Get the mapping associated with ccdImage.
Definition at line 156 of file PhotometryModel.h.
|
overridevirtual |
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. |
Implements lsst::jointcal::PhotometryModel.
Definition at line 109 of file ConstrainedPhotometryModel.cc.
|
inlineinherited |
Return the number of parameters in the mapping of CcdImage.
Definition at line 153 of file PhotometryModel.h.
|
pure virtualinherited |
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.
|
overridevirtual |
Return the total number of parameters in this model.
Implements lsst::jointcal::PhotometryModel.
Definition at line 114 of file ConstrainedPhotometryModel.cc.
|
protectedpure virtual |
Return the initial calibration to use from this photoCalib.
Implemented in lsst::jointcal::ConstrainedMagnitudeModel, and lsst::jointcal::ConstrainedFluxModel.
|
protected |
Initialize the chip, visit, and chipVisit mappings by creating appropriate transforms and mappings.
Definition at line 177 of file ConstrainedPhotometryModel.cc.
|
pure virtualinherited |
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.
|
overridevirtual |
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 |
Implements lsst::jointcal::PhotometryModel.
Definition at line 83 of file ConstrainedPhotometryModel.cc.
|
delete |
|
delete |
|
protected |
Helper for preparing toPhotoCalib()
Definition at line 228 of file ConstrainedPhotometryModel.cc.
|
overridevirtual |
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.
Implements lsst::jointcal::PhotometryModel.
Reimplemented in lsst::jointcal::ConstrainedMagnitudeModel, and lsst::jointcal::ConstrainedFluxModel.
Definition at line 154 of file ConstrainedPhotometryModel.cc.
|
pure virtualinherited |
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 virtualinherited |
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 virtualinherited |
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.
|
inlineinherited |
Add a fraction of the instrumental flux to the instrumental flux error, in quadrature.
Definition at line 199 of file PhotometryModel.h.
|
inlineinherited |
Add a small magnitude offset to the "instrumental magnitude" error, in quadrature.
Definition at line 208 of file PhotometryModel.h.
|
inherited |
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.
|
protected |
Definition at line 111 of file ConstrainedPhotometryModel.h.
|
protected |
Definition at line 104 of file ConstrainedPhotometryModel.h.
|
protectedinherited |
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 108 of file ConstrainedPhotometryModel.h.
|
protectedinherited |
Definition at line 226 of file PhotometryModel.h.