lsst.jointcal  master-g52a623bc1f+3
Public Member Functions | Protected Member Functions | List of all members
lsst::jointcal::PhotometryModel Class Referenceabstract

Interface class for PhotometryFit. More...

#include <PhotometryModel.h>

Inheritance diagram for lsst::jointcal::PhotometryModel:
lsst::jointcal::ConstrainedPhotometryModel lsst::jointcal::SimplePhotometryModel

Public Member Functions

virtual unsigned assignIndices (std::string const &whatToFit, unsigned firstIndex)=0
 Assign indices to parameters involved in mappings, starting at firstIndex. More...
 
virtual void offsetParams (Eigen::VectorXd const &delta)=0
 Offset the parameters by the provided amounts. More...
 
virtual double photomFactor (CcdImage const &ccdImage, Point const &where) const =0
 Return the "photometric factor" at a given location on a ccdImage. More...
 
PhotometryMapping const & getMapping (CcdImage const &ccdImage) const
 Get the mapping associated with ccdImage. More...
 
virtual void getMappingIndices (CcdImage const &ccdImage, std::vector< unsigned > &indices)=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)=0
 Compute the parametric derivatives of this model. More...
 
virtual ~PhotometryModel ()
 

Protected Member Functions

virtual PhotometryMappingfindMapping (CcdImage const &ccdImage, std::string name) const =0
 Return a pointer to the mapping associated with this ccdImage. name is for describing error messages. More...
 

Detailed Description

Interface class for PhotometryFit.

Definition at line 19 of file PhotometryModel.h.

Constructor & Destructor Documentation

◆ ~PhotometryModel()

virtual lsst::jointcal::PhotometryModel::~PhotometryModel ( )
inlinevirtual

Definition at line 79 of file PhotometryModel.h.

Member Function Documentation

◆ assignIndices()

virtual unsigned lsst::jointcal::PhotometryModel::assignIndices ( std::string const &  whatToFit,
unsigned  firstIndex 
)
pure virtual

Assign indices to parameters involved in mappings, starting at firstIndex.

Parameters
[in]whatToFitString containing parameters to fit.
[in]firstIndexIndex to start assigning at.
Returns
The highest assigned index.

Implemented in lsst::jointcal::SimplePhotometryModel, and lsst::jointcal::ConstrainedPhotometryModel.

◆ computeParameterDerivatives()

virtual void lsst::jointcal::PhotometryModel::computeParameterDerivatives ( MeasuredStar const &  measuredStar,
CcdImage const &  ccdImage,
Eigen::VectorXd &  derivatives 
)
pure virtual

Compute the parametric derivatives of this model.

Parameters
[in]measuredStarThe measured star with the position and flux to compute at.
[in]ccdImageThe ccdImage containing the measured star, to find the correct mapping.
[out]derivativesThe computed derivatives. Must be pre-allocated to the correct size.

Implemented in lsst::jointcal::SimplePhotometryModel, and lsst::jointcal::ConstrainedPhotometryModel.

◆ findMapping()

virtual PhotometryMapping* lsst::jointcal::PhotometryModel::findMapping ( CcdImage const &  ccdImage,
std::string  name 
) const
protectedpure virtual

Return a pointer to the mapping associated with this ccdImage. name is for describing error messages.

◆ getMapping()

PhotometryMapping const& lsst::jointcal::PhotometryModel::getMapping ( CcdImage const &  ccdImage) const
inline

Get the mapping associated with ccdImage.

Definition at line 53 of file PhotometryModel.h.

◆ getMappingIndices()

virtual void lsst::jointcal::PhotometryModel::getMappingIndices ( CcdImage const &  ccdImage,
std::vector< unsigned > &  indices 
)
pure virtual

Get how this set of parameters (of length Npar()) map into the "grand" fit.

Parameters
[in]ccdImageThe ccdImage to find the mapping of.
[out]indicesThe indices of the mapping associated with ccdImage.

Implemented in lsst::jointcal::SimplePhotometryModel, and lsst::jointcal::ConstrainedPhotometryModel.

◆ offsetParams()

virtual void lsst::jointcal::PhotometryModel::offsetParams ( Eigen::VectorXd const &  delta)
pure virtual

Offset the parameters by the provided amounts.

The shifts are applied according to the indices given in assignIndices.

Parameters
[in]deltavector of offsets to apply

Implemented in lsst::jointcal::SimplePhotometryModel, and lsst::jointcal::ConstrainedPhotometryModel.

◆ photomFactor()

virtual double lsst::jointcal::PhotometryModel::photomFactor ( CcdImage const &  ccdImage,
Point const &  where 
) const
pure virtual

Return the "photometric factor" at a given location on a ccdImage.

Multiply this by a Calib's flux/magnitude zero-point to get the updated fluxMag0 at that point.

Parameters
[in]ccdImageThe ccdImage to get the photometric factor for.
[in]wherePossition on ccdImage in ccd coordinates.
Returns
The photometric factor at the given location on ccdImage.

Implemented in lsst::jointcal::SimplePhotometryModel, and lsst::jointcal::ConstrainedPhotometryModel.


The documentation for this class was generated from the following file: