lsst.jointcal  16.0-4-g128aaef
Public Member Functions | Protected Attributes | List of all members
lsst::jointcal::PhotometryMappingBase Class Referenceabstract

Relates transfo(s) to their position in the fitting matrix and allows interaction with the transfo(s). More...

#include <PhotometryMapping.h>

Inheritance diagram for lsst::jointcal::PhotometryMappingBase:
lsst::jointcal::ChipVisitPhotometryMapping lsst::jointcal::PhotometryMapping

Public Member Functions

 PhotometryMappingBase ()
 
virtual ~PhotometryMappingBase ()
 
 PhotometryMappingBase (PhotometryMappingBase const &)=delete
 No copy or move: there is only ever one instance of a given mapping (i.e. per ccd+visit) More...
 
 PhotometryMappingBase (PhotometryMappingBase &&)=delete
 
PhotometryMappingBaseoperator= (PhotometryMappingBase const &)=delete
 
PhotometryMappingBaseoperator= (PhotometryMappingBase &&)=delete
 
virtual unsigned getNpar () const =0
 Number of total parameters in this mapping. More...
 
virtual double transform (MeasuredStar const &measuredStar, double instFlux) const =0
 Return the on-sky transformed flux for measuredStar on ccdImage. More...
 
virtual double transformError (MeasuredStar const &measuredStar, double instFluxErr) const =0
 Return the on-sky transformed flux uncertainty for measuredStar on ccdImage. More...
 
virtual void freezeErrorTransform ()=0
 Once this routine has been called, the error transform is not modified by offsetParams(). More...
 
virtual void computeParameterDerivatives (MeasuredStar const &measuredStar, double instFlux, Eigen::Ref< Eigen::VectorXd > derivatives) const =0
 Compute the derivatives with respect to the parameters (i.e. More...
 
virtual void offsetParams (Eigen::VectorXd const &delta)=0
 Offset the transfo parameters by delta. More...
 
void setFixed (bool _fixed)
 Make this mapping's parameters fixed (i.e. not varied during fitting). More...
 
bool isFixed ()
 
virtual Eigen::VectorXd getParameters ()=0
 
virtual void getMappingIndices (std::vector< unsigned > &indices) const =0
 Gets how this set of parameters (of length getNpar()) map into the "grand" fit. More...
 
virtual void dump (std::ostream &stream=std::cout) const =0
 Dump the contents of the transfos, for debugging. More...
 
unsigned getIndex ()
 Get the index of this mapping in the grand fit. More...
 
void setIndex (unsigned i)
 Set the index of this mapping in the grand fit. More...
 

Protected Attributes

unsigned index
 
bool fixed
 

Detailed Description

Relates transfo(s) to their position in the fitting matrix and allows interaction with the transfo(s).

Definition at line 21 of file PhotometryMapping.h.

Constructor & Destructor Documentation

◆ PhotometryMappingBase() [1/3]

lsst::jointcal::PhotometryMappingBase::PhotometryMappingBase ( )
inline

Definition at line 23 of file PhotometryMapping.h.

◆ ~PhotometryMappingBase()

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

Definition at line 24 of file PhotometryMapping.h.

◆ PhotometryMappingBase() [2/3]

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

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

◆ PhotometryMappingBase() [3/3]

lsst::jointcal::PhotometryMappingBase::PhotometryMappingBase ( PhotometryMappingBase &&  )
delete

Member Function Documentation

◆ computeParameterDerivatives()

virtual void lsst::jointcal::PhotometryMappingBase::computeParameterDerivatives ( MeasuredStar const &  measuredStar,
double  instFlux,
Eigen::Ref< Eigen::VectorXd >  derivatives 
) const
pure virtual

Compute the derivatives with respect to the parameters (i.e.

the coefficients).

Parameters
[in]measuredStarThe measured star position to transform.
[in]instFluxThe instrument flux to compute the derivative at.
[out]derivativesThe computed derivatives, in the same order as the deltas in offsetParams.

Implemented in lsst::jointcal::ChipVisitPhotometryMapping, and lsst::jointcal::PhotometryMapping.

◆ dump()

virtual void lsst::jointcal::PhotometryMappingBase::dump ( std::ostream stream = std::cout) const
pure virtual

Dump the contents of the transfos, for debugging.

Implemented in lsst::jointcal::ChipVisitPhotometryMapping, and lsst::jointcal::PhotometryMapping.

◆ freezeErrorTransform()

virtual void lsst::jointcal::PhotometryMappingBase::freezeErrorTransform ( )
pure virtual

Once this routine has been called, the error transform is not modified by offsetParams().

The routine can be called when the mappings are roughly in place. After the call, the transformations used to propagate errors are no longer affected when updating the mappings. This allows an exactly linear fit, which can be necessary for some model+data combinations.

Implemented in lsst::jointcal::ChipVisitPhotometryMapping, and lsst::jointcal::PhotometryMapping.

◆ getIndex()

unsigned lsst::jointcal::PhotometryMappingBase::getIndex ( )
inline

Get the index of this mapping in the grand fit.

Definition at line 99 of file PhotometryMapping.h.

◆ getMappingIndices()

virtual void lsst::jointcal::PhotometryMappingBase::getMappingIndices ( std::vector< unsigned > &  indices) const
pure virtual

Gets how this set of parameters (of length getNpar()) map into the "grand" fit.

Expects that indices has enough space reserved.

Implemented in lsst::jointcal::ChipVisitPhotometryMapping, and lsst::jointcal::PhotometryMapping.

◆ getNpar()

virtual unsigned lsst::jointcal::PhotometryMappingBase::getNpar ( ) const
pure virtual

Number of total parameters in this mapping.

Implemented in lsst::jointcal::ChipVisitPhotometryMapping, and lsst::jointcal::PhotometryMapping.

◆ getParameters()

virtual Eigen::VectorXd lsst::jointcal::PhotometryMappingBase::getParameters ( )
pure virtual

◆ isFixed()

bool lsst::jointcal::PhotometryMappingBase::isFixed ( )
inline

Definition at line 85 of file PhotometryMapping.h.

◆ offsetParams()

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

Offset the transfo parameters by delta.

Parameters
[in]deltavector to offset transfo parameters. Same ordering as derivatives in computeParameterDerivatives();

Implemented in lsst::jointcal::ChipVisitPhotometryMapping, and lsst::jointcal::PhotometryMapping.

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

◆ setFixed()

void lsst::jointcal::PhotometryMappingBase::setFixed ( bool  _fixed)
inline

Make this mapping's parameters fixed (i.e. not varied during fitting).

Definition at line 84 of file PhotometryMapping.h.

◆ setIndex()

void lsst::jointcal::PhotometryMappingBase::setIndex ( unsigned  i)
inline

Set the index of this mapping in the grand fit.

Definition at line 102 of file PhotometryMapping.h.

◆ transform()

virtual double lsst::jointcal::PhotometryMappingBase::transform ( MeasuredStar const &  measuredStar,
double  instFlux 
) const
pure virtual

Return the on-sky transformed flux for measuredStar on ccdImage.

Parameters
[in]measuredStarThe measured star position to transform.
[in]instFluxThe instrument flux to transform.
Returns
The on-sky flux transformed from instFlux at measuredStar's position.

Implemented in lsst::jointcal::ChipVisitPhotometryMapping, and lsst::jointcal::PhotometryMapping.

◆ transformError()

virtual double lsst::jointcal::PhotometryMappingBase::transformError ( MeasuredStar const &  measuredStar,
double  instFluxErr 
) const
pure virtual

Return the on-sky transformed flux uncertainty for measuredStar on ccdImage.

Identical to transform() until freezeErrorTransform() is called.

Parameters
[in]measuredStarThe measured star position to transform.
[in]instFluxErrThe instrument flux error to transform.
Returns
The on-sky flux transformed from instFlux at measuredStar's position.

Implemented in lsst::jointcal::ChipVisitPhotometryMapping, and lsst::jointcal::PhotometryMapping.

Member Data Documentation

◆ fixed

bool lsst::jointcal::PhotometryMappingBase::fixed
protected

Definition at line 108 of file PhotometryMapping.h.

◆ index

unsigned lsst::jointcal::PhotometryMappingBase::index
protected

Definition at line 106 of file PhotometryMapping.h.


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