lsst.jointcal  master-gc935ebf72c+13
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | List of all members
lsst::jointcal::UserTransfo Class Reference

a run-time transfo that allows users to define a Gtransfo with minimal coding (just the transfo routine). More...

#include <Gtransfo.h>

Inheritance diagram for lsst::jointcal::UserTransfo:
lsst::jointcal::Gtransfo

Public Member Functions

 UserTransfo (GtransfoFun &fun, const void *userData)
 the transfo routine and extra data that it may need. More...
 
void apply (const double xIn, const double yIn, double &xOut, double &yOut) const
 
void dump (std::ostream &stream=std::cout) const
 dumps the transfo coefficients to stream. More...
 
double fit (const StarMatchList &starMatchList)
 fits a transfo to a std::list of Point pairs (p1,p2, the Point fields in StarMatch). More...
 
std::unique_ptr< Gtransfoclone () const
 returns a copy (allocated by new) of the transformation. More...
 
- Public Member Functions inherited from lsst::jointcal::Gtransfo
void apply (const Point &in, Point &out) const
 applies the tranfo to in and writes into out. Is indeed virtual. More...
 
Point apply (const Point &in) const
 All these apply(..) shadow the virtual one in derived classes, unless one writes "using Gtransfo::apply". More...
 
std::string __str__ ()
 
void transformStar (FatPoint &in) const
 allows to write MyTransfo(MyStar) More...
 
virtual double getJacobian (const Point &point) const
 returns the local jacobian. More...
 
virtual std::unique_ptr< GtransforeduceCompo (const Gtransfo *right) const
 to be overloaded by derived classes if they can really "reduce" the composition (e.g. More...
 
virtual double getJacobian (const double x, const double y) const
 returns the local jacobian. More...
 
virtual void computeDerivative (const Point &where, GtransfoLin &derivative, const double step=0.01) const
 Computes the local Derivative of a transfo. Step is used for numerical derivation. More...
 
virtual GtransfoLin linearApproximation (const Point &where, const double step=0.01) const
 linear (local) approximation. More...
 
virtual void transformPosAndErrors (const FatPoint &in, FatPoint &out) const
 
virtual void transformErrors (const Point &where, const double *vIn, double *vOut) const
 transform errors (represented as double[3] in order V(xx),V(yy),Cov(xy)) More...
 
virtual std::unique_ptr< GtransfoinverseTransfo (const double precision, const Frame &region) const
 returns an inverse transfo. Numerical if not overloaded. More...
 
void getParams (double *params) const
 params should be at least Npar() long More...
 
void offsetParams (const double *params)
 
virtual double paramRef (const int i) const
 
virtual double & paramRef (const int i)
 
virtual void paramDerivatives (const Point &where, double *dx, double *dy) const
 Derivative w.r.t parameters. More...
 
virtual std::unique_ptr< GtransforoughInverse (const Frame &region) const
 Rough inverse. More...
 
virtual int getNpar () const
 returns the number of parameters (to compute chi2's) More...
 
void write (const std::string &fileName) const
 
virtual void write (std::ostream &stream) const
 
virtual ~Gtransfo ()
 

Detailed Description

a run-time transfo that allows users to define a Gtransfo with minimal coding (just the transfo routine).

Definition at line 562 of file Gtransfo.h.

Constructor & Destructor Documentation

lsst::jointcal::UserTransfo::UserTransfo ( GtransfoFun fun,
const void *  userData 
)

the transfo routine and extra data that it may need.

Definition at line 1564 of file Gtransfo.cc.

Member Function Documentation

void lsst::jointcal::UserTransfo::apply ( const double  xIn,
const double  yIn,
double &  xOut,
double &  yOut 
) const
virtual

Implements lsst::jointcal::Gtransfo.

Definition at line 1567 of file Gtransfo.cc.

std::unique_ptr< Gtransfo > lsst::jointcal::UserTransfo::clone ( ) const
virtual

returns a copy (allocated by new) of the transformation.

Implements lsst::jointcal::Gtransfo.

Definition at line 1581 of file Gtransfo.cc.

void lsst::jointcal::UserTransfo::dump ( std::ostream &  stream = std::cout) const
virtual

dumps the transfo coefficients to stream.

Implements lsst::jointcal::Gtransfo.

Definition at line 1571 of file Gtransfo.cc.

double lsst::jointcal::UserTransfo::fit ( const StarMatchList starMatchList)
virtual

fits a transfo to a std::list of Point pairs (p1,p2, the Point fields in StarMatch).

After the fit this(p1) yields approximately p2. The returned value is the sum of squared residuals. If you want to fit a partial transfo (e.g. such that this(T1(p1)) = T2(p2), use StarMatchList::applyTransfo beforehand.

Implements lsst::jointcal::Gtransfo.

Definition at line 1575 of file Gtransfo.cc.


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