lsst.jointcal
16.0-15-g8e16a51+8
|
Interface class for PhotometryFit. More...
#include <PhotometryModel.h>
Public Member Functions | |
virtual unsigned | assignIndices (std::string const &whatToFit, unsigned 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, std::vector< unsigned > &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... | |
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... | |
virtual int | getTotalParameters () const =0 |
Return the total number of parameters in this model. More... | |
virtual void | dump (std::ostream &stream=std::cout) const =0 |
Dump the contents of the transfos, for debugging. More... | |
Protected Member Functions | |
virtual PhotometryMappingBase * | findMapping (CcdImage const &ccdImage) const =0 |
Return a pointer to the mapping associated with this ccdImage. More... | |
Friends | |
std::ostream & | operator<< (std::ostream &s, PhotometryModel const &model) |
Interface class for PhotometryFit.
Definition at line 24 of file PhotometryModel.h.
|
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::ConstrainedPhotometryModel, and lsst::jointcal::SimplePhotometryModel.
|
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::ConstrainedPhotometryModel, and lsst::jointcal::SimplePhotometryModel.
|
pure virtual |
Return the fittedStar - refStar residual appropriate for this model (e.g. flux - flux or mag - mag).
Implemented in lsst::jointcal::ConstrainedMagnitudeModel, lsst::jointcal::ConstrainedFluxModel, lsst::jointcal::SimpleMagnitudeModel, and lsst::jointcal::SimpleFluxModel.
|
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::ConstrainedMagnitudeModel, lsst::jointcal::ConstrainedFluxModel, lsst::jointcal::SimpleMagnitudeModel, and lsst::jointcal::SimpleFluxModel.
|
pure virtual |
Dump the contents of the transfos, for debugging.
Implemented in lsst::jointcal::ConstrainedPhotometryModel, and lsst::jointcal::SimplePhotometryModel.
|
protectedpure virtual |
Return a pointer to the mapping associated with this ccdImage.
Implemented in lsst::jointcal::ConstrainedPhotometryModel, and lsst::jointcal::SimplePhotometryModel.
|
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::ConstrainedPhotometryModel, and lsst::jointcal::SimplePhotometryModel.
|
inline |
Get the mapping associated with ccdImage.
Definition at line 130 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::ConstrainedPhotometryModel, and lsst::jointcal::SimplePhotometryModel.
|
inline |
Return the number of parameters in the mapping of CcdImage.
Definition at line 127 of file PhotometryModel.h.
|
pure virtual |
Return the refStar error appropriate for this model (e.g. fluxErr or magErr).
Implemented in lsst::jointcal::ConstrainedMagnitudeModel, lsst::jointcal::ConstrainedFluxModel, lsst::jointcal::SimpleMagnitudeModel, and lsst::jointcal::SimpleFluxModel.
|
pure virtual |
Return the total number of parameters in this model.
Implemented in lsst::jointcal::ConstrainedPhotometryModel, and lsst::jointcal::SimplePhotometryModel.
|
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::ConstrainedMagnitudeModel, lsst::jointcal::ConstrainedFluxModel, lsst::jointcal::SimpleMagnitudeModel, and lsst::jointcal::SimpleFluxModel.
|
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::ConstrainedPhotometryModel, and lsst::jointcal::SimplePhotometryModel.
|
pure virtual |
Return the mapping of ccdImage represented as a PhotoCalib.
Implemented in lsst::jointcal::ConstrainedMagnitudeModel, lsst::jointcal::ConstrainedFluxModel, lsst::jointcal::SimpleMagnitudeModel, and lsst::jointcal::SimpleFluxModel.
|
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::ConstrainedMagnitudeModel, lsst::jointcal::ConstrainedFluxModel, lsst::jointcal::SimpleMagnitudeModel, and lsst::jointcal::SimpleFluxModel.
|
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::ConstrainedMagnitudeModel, lsst::jointcal::ConstrainedFluxModel, lsst::jointcal::SimpleMagnitudeModel, and lsst::jointcal::SimpleFluxModel.
|
friend |
Definition at line 140 of file PhotometryModel.h.