lsst.jointcal
16.0-21-g96865c2+1
|
#include <ConstrainedPhotometryModel.h>
Public Member Functions | |
ConstrainedMagnitudeModel (CcdImageList const &ccdImageList, afw::geom::Box2D const &focalPlaneBBox, int visitOrder=7, double errorPedestal_=0) | |
void | offsetFittedStar (FittedStar &fittedStar, double delta) const override |
Offset the appropriate flux or magnitude (by -delta). More... | |
double | computeResidual (CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override |
Compute the residual between the model applied to a star and its associated fittedStar. More... | |
double | computeRefResidual (FittedStar const &fittedStar, RefStar const &refStar) const override |
Return the fittedStar - refStar residual appropriate for this model (e.g. flux - flux or mag - mag). More... | |
double | getRefError (RefStar const &refStar) const override |
Return the refStar error appropriate for this model (e.g. fluxErr or magErr). More... | |
double | transform (CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override |
Return the on-sky transformed flux for measuredStar on ccdImage. More... | |
double | transformError (CcdImage const &ccdImage, MeasuredStar const &measuredStar) const override |
Return the on-sky transformed flux uncertainty for measuredStar on ccdImage. More... | |
std::shared_ptr< afw::image::PhotoCalib > | toPhotoCalib (CcdImage const &ccdImage) const override |
Return the mapping of ccdImage represented as a PhotoCalib. More... | |
unsigned | assignIndices (std::string const &whatToFit, unsigned 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, std::vector< unsigned > &indices) const override |
Get how this set of parameters (of length Npar()) map into the "grand" fit. More... | |
int | 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 | dump (std::ostream &stream=std::cout) const override |
Dump the contents of the transfos, for debugging. More... | |
unsigned | 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) 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 | |
double | initialChipCalibration (std::shared_ptr< afw::image::PhotoCalib const > photoCalib) override |
Return the initial calibration to use from this photoCalib. More... | |
PhotometryMappingBase * | findMapping (CcdImage const &ccdImage) const override |
Return a pointer to the mapping associated with this ccdImage. More... | |
template<class ChipTransfo , class VisitTransfo , class ChipVisitMapping > | |
void | initialize (CcdImageList const &ccdImageList, afw::geom::Box2D const &focalPlaneBBox, int visitOrder) |
Initialize the chip, visit, and chipVisit mappings by creating appropriate transfos and mappings. 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 |
Definition at line 147 of file ConstrainedPhotometryModel.h.
|
protectedinherited |
Definition at line 86 of file ConstrainedPhotometryModel.h.
|
protectedinherited |
Definition at line 79 of file ConstrainedPhotometryModel.h.
|
protectedinherited |
Definition at line 83 of file ConstrainedPhotometryModel.h.
|
inlineexplicit |
Definition at line 149 of file ConstrainedPhotometryModel.h.
|
overridevirtualinherited |
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 20 of file ConstrainedPhotometryModel.cc.
|
inherited |
Check that the model is positive on the ccdImage bbox.
ccdImage | The ccdImage to test. |
Definition at line 18 of file PhotometryModel.cc.
|
overridevirtualinherited |
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 100 of file ConstrainedPhotometryModel.cc.
|
inlineoverridevirtual |
Return the fittedStar - refStar residual appropriate for this model (e.g. flux - flux or mag - mag).
Implements lsst::jointcal::PhotometryModel.
Definition at line 168 of file ConstrainedPhotometryModel.h.
|
overridevirtual |
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. |
Implements lsst::jointcal::PhotometryModel.
Definition at line 259 of file ConstrainedPhotometryModel.cc.
|
overridevirtualinherited |
Dump the contents of the transfos, for debugging.
Implements lsst::jointcal::PhotometryModel.
Definition at line 128 of file ConstrainedPhotometryModel.cc.
|
overrideprotectedvirtualinherited |
Return a pointer to the mapping associated with this ccdImage.
Implements lsst::jointcal::PhotometryModel.
Definition at line 140 of file ConstrainedPhotometryModel.cc.
|
overridevirtualinherited |
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 74 of file ConstrainedPhotometryModel.cc.
|
inlineinherited |
Definition at line 162 of file PhotometryModel.h.
|
inlineinherited |
Get the mapping associated with ccdImage.
Definition at line 129 of file PhotometryModel.h.
|
overridevirtualinherited |
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 83 of file ConstrainedPhotometryModel.cc.
|
inlineinherited |
Return the number of parameters in the mapping of CcdImage.
Definition at line 126 of file PhotometryModel.h.
|
inlineoverridevirtual |
Return the refStar error appropriate for this model (e.g. fluxErr or magErr).
Implements lsst::jointcal::PhotometryModel.
Definition at line 173 of file ConstrainedPhotometryModel.h.
|
overridevirtualinherited |
Return the total number of parameters in this model.
Implements lsst::jointcal::PhotometryModel.
Definition at line 89 of file ConstrainedPhotometryModel.cc.
|
inlineoverrideprotectedvirtual |
Return the initial calibration to use from this photoCalib.
Implements lsst::jointcal::ConstrainedPhotometryModel.
Definition at line 186 of file ConstrainedPhotometryModel.h.
|
protectedinherited |
Initialize the chip, visit, and chipVisit mappings by creating appropriate transfos and mappings.
Definition at line 149 of file ConstrainedPhotometryModel.cc.
|
inlineoverridevirtual |
Offset the appropriate flux or magnitude (by -delta).
fittedStar | The star to update. |
delta | The amount to update by. |
Implements lsst::jointcal::PhotometryModel.
Definition at line 160 of file ConstrainedPhotometryModel.h.
|
overridevirtualinherited |
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 57 of file ConstrainedPhotometryModel.cc.
|
overridevirtual |
Return the mapping of ccdImage represented as a PhotoCalib.
Implements lsst::jointcal::PhotometryModel.
Definition at line 277 of file ConstrainedPhotometryModel.cc.
|
overridevirtual |
Return the on-sky transformed flux for measuredStar on ccdImage.
[in] | ccdImage | The ccdImage where measuredStar resides. |
measuredStar | The measured star position to transform. |
Implements lsst::jointcal::PhotometryModel.
Definition at line 264 of file ConstrainedPhotometryModel.cc.
|
overridevirtual |
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. |
Implements lsst::jointcal::PhotometryModel.
Definition at line 270 of file ConstrainedPhotometryModel.cc.
|
inlineinherited |
Add a fraction of the instrumental flux to the instrumental flux error, in quadrature.
Definition at line 165 of file PhotometryModel.h.
|
inlineinherited |
Add a small magnitude offset to the "instrumental magnitude" error, in quadrature.
Definition at line 174 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. |
Definition at line 9 of file PhotometryModel.cc.
|
protectedinherited |
Definition at line 87 of file ConstrainedPhotometryModel.h.
|
protectedinherited |
Definition at line 80 of file ConstrainedPhotometryModel.h.
|
protectedinherited |
lsst.logging instance, to be created by a subclass so that messages have consistent name.
Definition at line 187 of file PhotometryModel.h.
|
protectedinherited |
Definition at line 84 of file ConstrainedPhotometryModel.h.
|
protectedinherited |
Definition at line 190 of file PhotometryModel.h.