Class SimpleMagnitudeModel¶
Defined in File SimplePhotometryModel.h
Inheritance Relationships¶
Base Type¶
public lsst::jointcal::SimplePhotometryModel
(Class SimplePhotometryModel)
Class Documentation¶
-
class
SimpleMagnitudeModel
: public lsst::jointcal::SimplePhotometryModel¶ Public Functions
-
SimpleMagnitudeModel
(CcdImageList const &ccdImageList, double errorPedestal_ = 0)¶
-
void
offsetFittedStar
(FittedStar &fittedStar, double delta) const¶ Offset the appropriate flux or magnitude (by -delta).
- Parameters
fittedStar
: The star to update.delta
: The amount to update by.
-
double
computeResidual
(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const¶ Compute the residual between the model applied to a star and its associated fittedStar.
\[ residual = Model(measuredStar) - fittedStar \]- Return
The residual.
- Parameters
ccdImage
: The ccdImage where measuredStar resides.measuredStar
: The measured star position to compute the residual of.
-
double
transform
(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const¶ Return the on-sky transformed flux for measuredStar on ccdImage.
- Return
The on-sky flux transformed from instFlux at measuredStar’s position.
- Parameters
[in] ccdImage
: The ccdImage where measuredStar resides.measuredStar
: The measured star position to transform.
-
double
transformError
(CcdImage const &ccdImage, MeasuredStar const &measuredStar) const¶ Return the on-sky transformed flux uncertainty for measuredStar on ccdImage. Identical to transform() until freezeErrorTransform() is called.
- Return
The on-sky flux transformed from instFlux at measuredStar’s position.
- Parameters
[in] ccdImage
: The ccdImage where measuredStar resides.measuredStar
: The measured star position to transform.
-
double
getRefError
(RefStar const &refStar) const¶ Return the refStar error appropriate for this model (e.g. fluxErr or magErr).
-
double
computeRefResidual
(FittedStar const &fittedStar, RefStar const &refStar) const¶ Return the fittedStar - refStar residual appropriate for this model (e.g. flux - flux or mag - mag).
-
std::shared_ptr<afw::image::PhotoCalib>
toPhotoCalib
(CcdImage const &ccdImage) const¶ Return the mapping of ccdImage represented as a PhotoCalib.
- Note
SimplePhotometryModel uses a spatially-invariant transform, so we can simplify the PhotoCalib.
-