lsst.jointcal  14.0-13-g0c7ec64+2
Public Member Functions | List of all members
lsst::jointcal::Mapping Class Referenceabstract

virtual class needed in the abstraction of the distortion model More...

#include <Mapping.h>

Inheritance diagram for lsst::jointcal::Mapping:
lsst::jointcal::SimpleGtransfoMapping lsst::jointcal::TwoTransfoMapping lsst::jointcal::SimplePolyMapping

Public Member Functions

virtual unsigned getNpar () const =0
 Number of parameters in total. More...
 
virtual void getMappingIndices (std::vector< unsigned > &indices) const =0
 Sets how this set of parameters (of length Npar()) map into the "grand" fit Expects that indices has enough space reserved. More...
 
virtual void computeTransformAndDerivatives (FatPoint const &where, FatPoint &outPoint, Eigen::MatrixX2d &H) const =0
 Actually applies the mapping and evaluates the derivatives w.r.t the fitted parameters. More...
 
virtual void transformPosAndErrors (FatPoint const &where, FatPoint &outPoint) const =0
 The same as above but without the parameter derivatives (used to evaluate chi^2) More...
 
virtual void offsetParams (Eigen::VectorXd const &delta)=0
 Remember the error scale and freeze it. More...
 
virtual void positionDerivative (Point const &where, Eigen::Matrix2d &derivative, double epsilon) const =0
 The derivative w.r.t. position. More...
 
virtual ~Mapping ()
 

Detailed Description

virtual class needed in the abstraction of the distortion model

Definition at line 15 of file Mapping.h.

Constructor & Destructor Documentation

◆ ~Mapping()

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

Definition at line 43 of file Mapping.h.

Member Function Documentation

◆ computeTransformAndDerivatives()

virtual void lsst::jointcal::Mapping::computeTransformAndDerivatives ( FatPoint const &  where,
FatPoint outPoint,
Eigen::MatrixX2d H 
) const
pure virtual

Actually applies the mapping and evaluates the derivatives w.r.t the fitted parameters.

This is grouped into a single call because for most models, evaluating the derivatives w.r.T parameters is not much longer than just transforming

Implemented in lsst::jointcal::SimplePolyMapping, lsst::jointcal::SimpleGtransfoMapping, and lsst::jointcal::TwoTransfoMapping.

◆ getMappingIndices()

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

Sets how this set of parameters (of length Npar()) map into the "grand" fit Expects that indices has enough space reserved.

Implemented in lsst::jointcal::SimpleGtransfoMapping, and lsst::jointcal::TwoTransfoMapping.

◆ getNpar()

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

Number of parameters in total.

Implemented in lsst::jointcal::SimpleGtransfoMapping, and lsst::jointcal::TwoTransfoMapping.

◆ offsetParams()

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

Remember the error scale and freeze it.

Implemented in lsst::jointcal::SimpleGtransfoMapping, and lsst::jointcal::TwoTransfoMapping.

◆ positionDerivative()

virtual void lsst::jointcal::Mapping::positionDerivative ( Point const &  where,
Eigen::Matrix2d &  derivative,
double  epsilon 
) const
pure virtual

◆ transformPosAndErrors()

virtual void lsst::jointcal::Mapping::transformPosAndErrors ( FatPoint const &  where,
FatPoint outPoint 
) const
pure virtual

The same as above but without the parameter derivatives (used to evaluate chi^2)

Implemented in lsst::jointcal::SimplePolyMapping, lsst::jointcal::SimpleGtransfoMapping, and lsst::jointcal::TwoTransfoMapping.


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