lsst.jointcal  master-gc935ebf72c
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public 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::SimplePhotometryModel

Public Member Functions

virtual unsigned assignIndices (const std::string &whatToFit, unsigned firstIndex)=0
 Assign indices to parameters involved in mappings, starting at firstIndex. More...
 
virtual void offsetParams (const Eigen::VectorXd &delta)=0
 Offset the parameters by the provided amounts. More...
 
virtual double photomFactor (const CcdImage &ccdImage, const Point &where) const =0
 Return the "photometric factor" at a given location on a ccdImage. More...
 
virtual void getIndicesAndDerivatives (const MeasuredStar &measuredStar, const CcdImage &ccdImage, std::vector< unsigned > &indices, Eigen::VectorXd &D)=0
 number of parameters to be read in indices.size() More...
 
virtual ~PhotometryModel ()
 

Detailed Description

Interface class for PhotometryFit.

Definition at line 17 of file PhotometryModel.h.

Constructor & Destructor Documentation

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

Definition at line 54 of file PhotometryModel.h.

Member Function Documentation

virtual unsigned lsst::jointcal::PhotometryModel::assignIndices ( const std::string &  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.

virtual void lsst::jointcal::PhotometryModel::getIndicesAndDerivatives ( const MeasuredStar measuredStar,
const CcdImage ccdImage,
std::vector< unsigned > &  indices,
Eigen::VectorXd &  D 
)
pure virtual

number of parameters to be read in indices.size()

Implemented in lsst::jointcal::SimplePhotometryModel.

virtual void lsst::jointcal::PhotometryModel::offsetParams ( const Eigen::VectorXd &  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.

virtual double lsst::jointcal::PhotometryModel::photomFactor ( const CcdImage ccdImage,
const Point 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.

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.


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