lsst.jointcal  14.0-20-g39ceace+1
Public Member Functions | List of all members
lsst::jointcal::GtransfoComposition Class Reference

Private class to handle Gtransfo compositions (i.e. More...

Inheritance diagram for lsst::jointcal::GtransfoComposition:
lsst::jointcal::Gtransfo

Public Member Functions

 GtransfoComposition (const Gtransfo *second, const Gtransfo *first)
 will pipe transfos More...
 
void apply (const double xIn, const double yIn, double &xOut, double &yOut) const
 return second(first(xIn,yIn)) More...
 
void dump (ostream &stream=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...
 
 ~GtransfoComposition ()
 
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 double getJacobian (const double x, const double y) 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 void computeDerivative (const Point &where, GtransfoLin &derivative, const double step=0.01) const
 Computes the local Derivative of a transfo, w.r.t. 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 (Eigen::VectorXd const &delta)
 
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
 

Detailed Description

Private class to handle Gtransfo compositions (i.e.

piping). Use the routine gtransfoCompose if you need this functionnality.

Definition at line 317 of file Gtransfo.cc.

Constructor & Destructor Documentation

◆ GtransfoComposition()

lsst::jointcal::GtransfoComposition::GtransfoComposition ( const Gtransfo second,
const Gtransfo first 
)

will pipe transfos

Definition at line 336 of file Gtransfo.cc.

◆ ~GtransfoComposition()

lsst::jointcal::GtransfoComposition::~GtransfoComposition ( )

Definition at line 361 of file Gtransfo.cc.

Member Function Documentation

◆ __str__()

std::string lsst::jointcal::Gtransfo::__str__ ( )
inlineinherited

Definition at line 58 of file Gtransfo.h.

◆ apply() [1/3]

void lsst::jointcal::Gtransfo::apply ( const Point in,
Point out 
) const
inlineinherited

applies the tranfo to in and writes into out. Is indeed virtual.

Definition at line 45 of file Gtransfo.h.

◆ apply() [2/3]

Point lsst::jointcal::Gtransfo::apply ( const Point in) const
inlineinherited

All these apply(..) shadow the virtual one in derived classes, unless one writes "using Gtransfo::apply".

Definition at line 49 of file Gtransfo.h.

◆ apply() [3/3]

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

return second(first(xIn,yIn))

Implements lsst::jointcal::Gtransfo.

Definition at line 341 of file Gtransfo.cc.

◆ clone()

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

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

Implements lsst::jointcal::Gtransfo.

Definition at line 357 of file Gtransfo.cc.

◆ computeDerivative()

void lsst::jointcal::Gtransfo::computeDerivative ( const Point where,
GtransfoLin derivative,
const double  step = 0.01 
) const
virtualinherited

Computes the local Derivative of a transfo, w.r.t.

the Derivative is represented by a GtransfoLin, in which (hopefully), the offset terms are zero.

position.

Step is used for numerical derivation.

Derivative should transform a vector of offsets into a vector of offsets.

Reimplemented in lsst::jointcal::GtransfoLin, lsst::jointcal::GtransfoPoly, and lsst::jointcal::GtransfoIdentity.

Definition at line 75 of file Gtransfo.cc.

◆ dump()

void lsst::jointcal::GtransfoComposition::dump ( ostream stream = cout) const
virtual

dumps the transfo coefficients to stream.

Implements lsst::jointcal::Gtransfo.

Definition at line 347 of file Gtransfo.cc.

◆ fit()

double lsst::jointcal::GtransfoComposition::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 352 of file Gtransfo.cc.

◆ getJacobian() [1/2]

virtual double lsst::jointcal::Gtransfo::getJacobian ( const Point point) const
inlinevirtualinherited

returns the local jacobian.

Definition at line 75 of file Gtransfo.h.

◆ getJacobian() [2/2]

double lsst::jointcal::Gtransfo::getJacobian ( const double  x,
const double  y 
) const
virtualinherited

returns the local jacobian.

Definition at line 56 of file Gtransfo.cc.

◆ getNpar()

virtual int lsst::jointcal::Gtransfo::getNpar ( ) const
inlinevirtualinherited

returns the number of parameters (to compute chi2's)

Reimplemented in lsst::jointcal::GtransfoLinScale, lsst::jointcal::GtransfoLinRot, lsst::jointcal::GtransfoLinShift, lsst::jointcal::GtransfoPoly, and lsst::jointcal::GtransfoIdentity.

Definition at line 130 of file Gtransfo.h.

◆ getParams()

void lsst::jointcal::Gtransfo::getParams ( double *  params) const
inherited

params should be at least Npar() long

Definition at line 169 of file Gtransfo.cc.

◆ inverseTransfo()

std::unique_ptr< Gtransfo > lsst::jointcal::Gtransfo::inverseTransfo ( const double  precision,
const Frame region 
) const
virtualinherited

returns an inverse transfo. Numerical if not overloaded.

precision and region refer to the "input" side of this, and hence to the output side of the returned Gtransfo.

Reimplemented in lsst::jointcal::TanRaDec2Pix, lsst::jointcal::TanSipPix2RaDec, lsst::jointcal::TanPix2RaDec, lsst::jointcal::GtransfoLin, and lsst::jointcal::GtransfoInverse.

Definition at line 251 of file Gtransfo.cc.

◆ linearApproximation()

GtransfoLin lsst::jointcal::Gtransfo::linearApproximation ( const Point where,
const double  step = 0.01 
) const
virtualinherited

linear (local) approximation.

Reimplemented in lsst::jointcal::GtransfoLin, and lsst::jointcal::GtransfoIdentity.

Definition at line 92 of file Gtransfo.cc.

◆ offsetParams()

void lsst::jointcal::Gtransfo::offsetParams ( Eigen::VectorXd const &  delta)
inherited

Definition at line 174 of file Gtransfo.cc.

◆ paramDerivatives()

void lsst::jointcal::Gtransfo::paramDerivatives ( const Point where,
double *  dx,
double *  dy 
) const
virtualinherited

Derivative w.r.t parameters.

Derivatives should be al least 2*NPar long. first Npar, for x, last Npar for y.

Reimplemented in lsst::jointcal::GtransfoPoly.

Definition at line 188 of file Gtransfo.cc.

◆ paramRef() [1/2]

double lsst::jointcal::Gtransfo::paramRef ( const int  i) const
virtualinherited

Reimplemented in lsst::jointcal::GtransfoPoly.

Definition at line 179 of file Gtransfo.cc.

◆ paramRef() [2/2]

double & lsst::jointcal::Gtransfo::paramRef ( const int  i)
virtualinherited

Reimplemented in lsst::jointcal::GtransfoPoly.

Definition at line 184 of file Gtransfo.cc.

◆ reduceCompo()

std::unique_ptr< Gtransfo > lsst::jointcal::Gtransfo::reduceCompo ( const Gtransfo right) const
virtualinherited

to be overloaded by derived classes if they can really "reduce" the composition (e.g.

composition of Polynomial can be reduced)

Reimplemented in lsst::jointcal::TanPix2RaDec, lsst::jointcal::GtransfoPoly, and lsst::jointcal::GtransfoIdentity.

Definition at line 52 of file Gtransfo.cc.

◆ roughInverse()

std::unique_ptr< Gtransfo > lsst::jointcal::Gtransfo::roughInverse ( const Frame region) const
virtualinherited

Rough inverse.

Stored by the numerical inverter to guess starting point for the trials. Just here to enable overloading.

Reimplemented in lsst::jointcal::TanRaDec2Pix, lsst::jointcal::TanPix2RaDec, and lsst::jointcal::GtransfoInverse.

Definition at line 149 of file Gtransfo.cc.

◆ transformErrors()

void lsst::jointcal::Gtransfo::transformErrors ( const Point where,
const double *  vIn,
double *  vOut 
) const
virtualinherited

transform errors (represented as double[3] in order V(xx),V(yy),Cov(xy))

Definition at line 116 of file Gtransfo.cc.

◆ transformPosAndErrors()

void lsst::jointcal::Gtransfo::transformPosAndErrors ( const FatPoint in,
FatPoint out 
) const
virtualinherited

Reimplemented in lsst::jointcal::TanRaDec2Pix, and lsst::jointcal::GtransfoPoly.

Definition at line 99 of file Gtransfo.cc.

◆ transformStar()

void lsst::jointcal::Gtransfo::transformStar ( FatPoint in) const
inlineinherited

allows to write MyTransfo(MyStar)

Definition at line 72 of file Gtransfo.h.

◆ write() [1/2]

void lsst::jointcal::Gtransfo::write ( const std::string fileName) const
inherited

Definition at line 198 of file Gtransfo.cc.

◆ write() [2/2]

void lsst::jointcal::Gtransfo::write ( std::ostream stream) const
virtualinherited

Reimplemented in lsst::jointcal::GtransfoPoly, and lsst::jointcal::GtransfoIdentity.

Definition at line 208 of file Gtransfo.cc.


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