25 #ifndef LSST_JOINTCAL_PHOTOMETRY_MODEL_H
26 #define LSST_JOINTCAL_PHOTOMETRY_MODEL_H
139 Eigen::VectorXd &derivatives)
const = 0;
LSST DM logging module built on log4cxx.
Implementation of the Photometric Calibration class.
Handler of an actual image from a single CCD.
FittedStars are objects whose position or flux is going to be fitted, and which come from the associa...
Sources measured on images.
double getInstFlux() const
double getInstFluxErr() const
double getInstMagErr() const
Relates transform(s) to their position in the fitting matrix and allows interaction with the transfor...
virtual std::size_t getNpar() const =0
Number of total parameters in this mapping.
virtual std::size_t getTotalParameters() const =0
Return the total number of parameters in this model.
virtual PhotometryMappingBase * findMapping(CcdImage const &ccdImage) const =0
Return a pointer to the mapping associated with this ccdImage.
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...
LOG_LOGGER _log
lsst.logging instance, to be created by a subclass so that messages have consistent name.
virtual void offsetParams(Eigen::VectorXd const &delta)=0
Offset the parameters by the provided amounts (by -delta).
virtual double transform(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const =0
Return the on-sky transformed flux for measuredStar on ccdImage.
virtual double getRefError(RefStar const &refStar) const =0
Return the refStar error appropriate for this model (e.g. fluxErr or magErr).
bool validate(CcdImageList const &ccdImageList, int ndof) const
Return true if this is a "reasonable" model.
virtual void print(std::ostream &out) const =0
Print a string representation of the contents of this mapping, for debugging.
virtual void offsetFittedStar(FittedStar &fittedStar, double delta) const =0
Offset the appropriate flux or magnitude (by -delta).
PhotometryModel(LOG_LOGGER log, double errorPedestal=0)
virtual void freezeErrorTransform()=0
Once this routine has been called, the error transform is not modified by offsetParams().
virtual std::shared_ptr< afw::image::PhotoCalib > toPhotoCalib(CcdImage const &ccdImage) const =0
Return the mapping of ccdImage represented as a PhotoCalib.
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.
PhotometryMappingBase const & getMapping(CcdImage const &ccdImage) const
Get the mapping associated with ccdImage.
std::size_t getNpar(CcdImage const &ccdImage) const
Return the number of parameters in the mapping of CcdImage.
virtual void computeParameterDerivatives(MeasuredStar const &measuredStar, CcdImage const &ccdImage, Eigen::VectorXd &derivatives) const =0
Compute the parametric derivatives of this model.
virtual void getMappingIndices(CcdImage const &ccdImage, IndexVector &indices) const =0
Get how this set of parameters (of length Npar()) map into the "grand" fit.
double getErrorPedestal()
bool checkPositiveOnBBox(CcdImage const &ccdImage) const
Check that the model is positive on the ccdImage bbox.
virtual ~PhotometryModel()=default
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).
double tweakFluxError(jointcal::MeasuredStar const &measuredStar) const
Add a fraction of the instrumental flux to the instrumental flux error, in quadrature.
friend std::ostream & operator<<(std::ostream &s, PhotometryModel const &model)
virtual double transformError(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const =0
Return the on-sky transformed flux uncertainty for measuredStar on ccdImage.
double tweakMagnitudeError(jointcal::MeasuredStar const &measuredStar) const
Add a small magnitude offset to the "instrumental magnitude" error, in quadrature.
Objects used as position/flux anchors (e.g.
A base class for image defects.