lsst.jointcal  master-ga8493ae4fe+2
Public Member Functions | List of all members
lsst::jointcal::SimplePhotometryModel Class Reference

Photometric response model which has a single photometric factor per CcdImage. More...

#include <SimplePhotometryModel.h>

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

Public Member Functions

 SimplePhotometryModel (CcdImageList const &ccdImageList)
 
 SimplePhotometryModel (SimplePhotometryModel const &)=delete
 No copy or move: there is only ever one instance of a given model (i.e. per ccd+visit) More...
 
 SimplePhotometryModel (SimplePhotometryModel &&)=delete
 
SimplePhotometryModeloperator= (SimplePhotometryModel const &)=delete
 
SimplePhotometryModeloperator= (SimplePhotometryModel &&)=delete
 
unsigned assignIndices (std::string const &whatToFit, unsigned firstIndex) override
 Assign indices to parameters involved in mappings, starting at firstIndex. More...
 
void offsetParams (Eigen::VectorXd const &delta) override
 Offset the parameters by the provided amounts. More...
 
double photomFactor (CcdImage const &ccdImage, Point const &where=Point()) const override
 Return the "photometric factor" for this ccdImage. More...
 
void getMappingIndices (CcdImage const &ccdImage, std::vector< unsigned > &indices) override
 Get how this set of parameters (of length Npar()) map into the "grand" fit. More...
 
void computeParameterDerivatives (MeasuredStar const &measuredStar, CcdImage const &ccdImage, Eigen::VectorXd &derivatives) override
 Compute the parametric derivatives of this model. More...
 
PhotometryMapping const & getMapping (CcdImage const &ccdImage) const
 Get the mapping associated with ccdImage. More...
 

Detailed Description

Photometric response model which has a single photometric factor per CcdImage.

It considers a full exposure as reference.

Definition at line 21 of file SimplePhotometryModel.h.

Constructor & Destructor Documentation

◆ SimplePhotometryModel() [1/3]

lsst::jointcal::SimplePhotometryModel::SimplePhotometryModel ( CcdImageList const &  ccdImageList)

Definition at line 17 of file SimplePhotometryModel.cc.

◆ SimplePhotometryModel() [2/3]

lsst::jointcal::SimplePhotometryModel::SimplePhotometryModel ( SimplePhotometryModel const &  )
delete

No copy or move: there is only ever one instance of a given model (i.e. per ccd+visit)

◆ SimplePhotometryModel() [3/3]

lsst::jointcal::SimplePhotometryModel::SimplePhotometryModel ( SimplePhotometryModel &&  )
delete

Member Function Documentation

◆ assignIndices()

unsigned lsst::jointcal::SimplePhotometryModel::assignIndices ( std::string const &  whatToFit,
unsigned  firstIndex 
)
overridevirtual

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

Parameters
[in]whatToFitIgnored.
[in]firstIndexIndex to start assigning at.
Returns
The highest assigned index.

Implements lsst::jointcal::PhotometryModel.

Definition at line 25 of file SimplePhotometryModel.cc.

◆ computeParameterDerivatives()

void lsst::jointcal::SimplePhotometryModel::computeParameterDerivatives ( MeasuredStar const &  measuredStar,
CcdImage const &  ccdImage,
Eigen::VectorXd &  derivatives 
)
overridevirtual

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.

Implements lsst::jointcal::PhotometryModel.

Definition at line 53 of file SimplePhotometryModel.cc.

◆ getMapping()

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

Get the mapping associated with ccdImage.

Definition at line 53 of file PhotometryModel.h.

◆ getMappingIndices()

void lsst::jointcal::SimplePhotometryModel::getMappingIndices ( CcdImage const &  ccdImage,
std::vector< unsigned > &  indices 
)
overridevirtual

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.

Implements lsst::jointcal::PhotometryModel.

Definition at line 47 of file SimplePhotometryModel.cc.

◆ offsetParams()

void lsst::jointcal::SimplePhotometryModel::offsetParams ( Eigen::VectorXd const &  delta)
overridevirtual

Offset the parameters by the provided amounts.

The shifts are applied according to the indices given in AssignIndices.a

Parameters
[in]deltavector of offsets to apply

Implements lsst::jointcal::PhotometryModel.

Definition at line 35 of file SimplePhotometryModel.cc.

◆ operator=() [1/2]

SimplePhotometryModel& lsst::jointcal::SimplePhotometryModel::operator= ( SimplePhotometryModel const &  )
delete

◆ operator=() [2/2]

SimplePhotometryModel& lsst::jointcal::SimplePhotometryModel::operator= ( SimplePhotometryModel &&  )
delete

◆ photomFactor()

double lsst::jointcal::SimplePhotometryModel::photomFactor ( CcdImage const &  ccdImage,
Point const &  where = Point() 
) const
overridevirtual

Return the "photometric factor" for this 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]whereIgnored
Returns
The photometric factor at the given location on ccdImage.

Implements lsst::jointcal::PhotometryModel.

Definition at line 42 of file SimplePhotometryModel.cc.


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