lsst.jointcal  16.0-24-gd8faad8+1
Public Member Functions | Protected Member Functions | List of all members
lsst::jointcal::GtransfoLinShift Class Reference

just here to provide a specialized constructor, and fit. More...

#include <Gtransfo.h>

Inheritance diagram for lsst::jointcal::GtransfoLinShift:
lsst::jointcal::GtransfoLin lsst::jointcal::GtransfoPoly lsst::jointcal::Gtransfo

Public Member Functions

 GtransfoLinShift (double ox=0., double oy=0.)
 Add ox and oy. More...
 
 GtransfoLinShift (Point const &point)
 
double fit (StarMatchList const &starMatchList)
 guess what More...
 
int getNpar () const
 total number of parameters More...
 
GtransfoLin operator* (GtransfoLin const &right) const
 enables to combine linear tranformations: T1=T2*T3 is legal. More...
 
GtransfoPoly operator* (GtransfoPoly const &right) const
 Composition (internal stuff in quadruple precision) More...
 
GtransfoLin inverted () const
 returns the inverse: T1 = T2.inverted(); More...
 
void computeDerivative (Point const &where, GtransfoLin &derivative, const double step=0.01) const
 specialised analytic routine More...
 
GtransfoLin linearApproximation (Point const &where, const double step=0.01) const
 linear (local) approximation. More...
 
std::unique_ptr< Gtransfoclone () const
 returns a copy (allocated by new) of the transformation. More...
 
std::unique_ptr< GtransfoinverseTransfo (const double precision, const Frame &region) const
 returns an inverse transfo. Numerical if not overloaded. More...
 
double A11 () const
 
double A12 () const
 
double A21 () const
 
double A22 () const
 
double Dx () const
 
double Dy () const
 
unsigned getOrder () const
 Returns the polynomial order. More...
 
void apply (const double xIn, const double yIn, double &xOut, double &yOut) const override
 
void apply (Point const &in, Point &out) const
 applies the tranfo to in and writes into out. Is indeed virtual. More...
 
Point apply (Point const &in) const
 All these apply(..) shadow the virtual one in derived classes, unless one writes "using Gtransfo::apply". More...
 
Frame apply (Frame const &inputframe, bool inscribed) const
 Transform a bounding box, taking either the inscribed or circumscribed box. More...
 
virtual void transformPosAndErrors (const FatPoint &in, FatPoint &out) const override
 a mix of apply and Derivative More...
 
void dump (std::ostream &stream=std::cout) const override
 print out of coefficients in a readable form. More...
 
GtransfoPoly operator+ (GtransfoPoly const &right) const
 Addition. More...
 
GtransfoPoly operator- (GtransfoPoly const &right) const
 Subtraction. More...
 
std::unique_ptr< GtransfocomposeAndReduce (GtransfoPoly const &right) const
 Return a reduced composition of newTransfo = this(right()), or nullptr if it cannot be reduced. More...
 
virtual std::unique_ptr< GtransfocomposeAndReduce (Gtransfo const &right) const
 Return a reduced composition of newTransfo = this(right()), or nullptr if it cannot be reduced. More...
 
double coeff (const unsigned powX, const unsigned powY, const unsigned whichCoord) const
 access to coefficients (read only) More...
 
double & coeff (const unsigned powX, const unsigned powY, const unsigned whichCoord)
 write access More...
 
double coeffOrZero (const unsigned powX, const unsigned powY, const unsigned whichCoord) const
 read access, zero if beyond order More...
 
double determinant () const
 
double paramRef (const int i) const override
 
double & paramRef (const int i) override
 
void paramDerivatives (Point const &where, double *dx, double *dy) const override
 Derivative w.r.t parameters. More...
 
std::shared_ptr< ast::MappingtoAstMap (jointcal::Frame const &domain) const override
 Create an equivalent AST mapping for this transformation, including an analytic inverse if possible. More...
 
void write (std::ostream &s) const override
 
void write (const std::string &fileName) const
 
void read (std::istream &s)
 
std::string __str__ ()
 
void transformStar (FatPoint &in) const
 allows to write MyTransfo(MyStar) More...
 
virtual double getJacobian (Point const &point) const
 returns the local jacobian. More...
 
virtual double getJacobian (const double x, const double y) const
 returns the local jacobian. More...
 
virtual void transformErrors (Point const &where, const double *vIn, double *vOut) const
 transform errors (represented as double[3] in order V(xx),V(yy),Cov(xy)) More...
 
void getParams (double *params) const
 params should be at least Npar() long More...
 
void offsetParams (Eigen::VectorXd const &delta)
 
virtual std::unique_ptr< GtransforoughInverse (const Frame &region) const
 Rough inverse. More...
 

Protected Member Functions

double & a11 ()
 
double & a12 ()
 
double & a21 ()
 
double & a22 ()
 
double & dx ()
 
double & dy ()
 

Detailed Description

just here to provide a specialized constructor, and fit.

Definition at line 478 of file Gtransfo.h.

Constructor & Destructor Documentation

◆ GtransfoLinShift() [1/2]

lsst::jointcal::GtransfoLinShift::GtransfoLinShift ( double  ox = 0.,
double  oy = 0. 
)
inline

Add ox and oy.

Definition at line 482 of file Gtransfo.h.

◆ GtransfoLinShift() [2/2]

lsst::jointcal::GtransfoLinShift::GtransfoLinShift ( Point const &  point)
inline

Definition at line 483 of file Gtransfo.h.

Member Function Documentation

◆ __str__()

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

Definition at line 94 of file Gtransfo.h.

◆ A11()

double lsst::jointcal::GtransfoLin::A11 ( ) const
inlineinherited

Definition at line 452 of file Gtransfo.h.

◆ a11()

double& lsst::jointcal::GtransfoLin::a11 ( )
inlineprotectedinherited

Definition at line 460 of file Gtransfo.h.

◆ A12()

double lsst::jointcal::GtransfoLin::A12 ( ) const
inlineinherited

Definition at line 453 of file Gtransfo.h.

◆ a12()

double& lsst::jointcal::GtransfoLin::a12 ( )
inlineprotectedinherited

Definition at line 461 of file Gtransfo.h.

◆ A21()

double lsst::jointcal::GtransfoLin::A21 ( ) const
inlineinherited

Definition at line 454 of file Gtransfo.h.

◆ a21()

double& lsst::jointcal::GtransfoLin::a21 ( )
inlineprotectedinherited

Definition at line 462 of file Gtransfo.h.

◆ A22()

double lsst::jointcal::GtransfoLin::A22 ( ) const
inlineinherited

Definition at line 455 of file Gtransfo.h.

◆ a22()

double& lsst::jointcal::GtransfoLin::a22 ( )
inlineprotectedinherited

Definition at line 463 of file Gtransfo.h.

◆ apply() [1/4]

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

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

Definition at line 71 of file Gtransfo.h.

◆ apply() [2/4]

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

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

Definition at line 75 of file Gtransfo.h.

◆ apply() [3/4]

Frame lsst::jointcal::Gtransfo::apply ( Frame const &  inputframe,
bool  inscribed 
) const
inherited

Transform a bounding box, taking either the inscribed or circumscribed box.

Parameters
[in]inputframeThe frame to be transformed.
[in]inscribedReturn the inscribed (true) or circumscribed (false) box.
Returns
The transformed frame.

Definition at line 74 of file Gtransfo.cc.

◆ apply() [4/4]

void lsst::jointcal::GtransfoPoly::apply ( const double  xIn,
const double  yIn,
double &  xOut,
double &  yOut 
) const
overridevirtualinherited

Implements lsst::jointcal::Gtransfo.

Definition at line 546 of file Gtransfo.cc.

◆ clone()

std::unique_ptr<Gtransfo> lsst::jointcal::GtransfoLin::clone ( ) const
inlinevirtualinherited

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

Reimplemented from lsst::jointcal::GtransfoPoly.

Definition at line 448 of file Gtransfo.h.

◆ coeff() [1/2]

double lsst::jointcal::GtransfoPoly::coeff ( const unsigned  powX,
const unsigned  powY,
const unsigned  whichCoord 
) const
inherited

access to coefficients (read only)

Definition at line 711 of file Gtransfo.cc.

◆ coeff() [2/2]

double & lsst::jointcal::GtransfoPoly::coeff ( const unsigned  powX,
const unsigned  powY,
const unsigned  whichCoord 
)
inherited

write access

Definition at line 719 of file Gtransfo.cc.

◆ coeffOrZero()

double lsst::jointcal::GtransfoPoly::coeffOrZero ( const unsigned  powX,
const unsigned  powY,
const unsigned  whichCoord 
) const
inherited

read access, zero if beyond order

Definition at line 724 of file Gtransfo.cc.

◆ composeAndReduce() [1/2]

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

Return a reduced composition of newTransfo = this(right()), or nullptr if it cannot be reduced.

"Reduced" in this context means that they are capable of being merged into a single transform, for example, for two polynomials:

\[ f(x) = 1 + x^2, g(x) = -1 + 3x \]

we would have h = f.composeAndReduce(g) == 2 - 6x + 9x^2.

To be overloaded by derived classes if they can properly reduce the composition.

Parameters
rightThe transform to apply first.
Returns
The new reduced and composed gtransfo, or nullptr if no such reduction is possible.

Reimplemented in lsst::jointcal::GtransfoIdentity.

Definition at line 92 of file Gtransfo.cc.

◆ composeAndReduce() [2/2]

std::unique_ptr< Gtransfo > lsst::jointcal::GtransfoPoly::composeAndReduce ( GtransfoPoly const &  right) const
inherited

Return a reduced composition of newTransfo = this(right()), or nullptr if it cannot be reduced.

"Reduced" in this context means that they are capable of being merged into a single transform, for example, for two polynomials:

\[ f(x) = 1 + x^2, g(x) = -1 + 3x \]

we would have h = f.composeAndReduce(g) == 2 - 6x + 9x^2.

To be overloaded by derived classes if they can properly reduce the composition.

Parameters
rightThe transform to apply first.
Returns
The new reduced and composed gtransfo, or nullptr if no such reduction is possible.

Definition at line 898 of file Gtransfo.cc.

◆ computeDerivative()

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

specialised analytic routine

Reimplemented from lsst::jointcal::GtransfoPoly.

Definition at line 1194 of file Gtransfo.cc.

◆ determinant()

double lsst::jointcal::GtransfoPoly::determinant ( ) const
inherited

Definition at line 782 of file Gtransfo.cc.

◆ dump()

void lsst::jointcal::GtransfoPoly::dump ( std::ostream stream = std::cout) const
overridevirtualinherited

print out of coefficients in a readable form.

Implements lsst::jointcal::Gtransfo.

Definition at line 763 of file Gtransfo.cc.

◆ Dx()

double lsst::jointcal::GtransfoLin::Dx ( ) const
inlineinherited

Definition at line 456 of file Gtransfo.h.

◆ dx()

double& lsst::jointcal::GtransfoLin::dx ( )
inlineprotectedinherited

Definition at line 464 of file Gtransfo.h.

◆ Dy()

double lsst::jointcal::GtransfoLin::Dy ( ) const
inlineinherited

Definition at line 457 of file Gtransfo.h.

◆ dy()

double& lsst::jointcal::GtransfoLin::dy ( )
inlineprotectedinherited

Definition at line 465 of file Gtransfo.h.

◆ fit()

double lsst::jointcal::GtransfoLinShift::fit ( StarMatchList const &  starMatchList)
virtual

guess what

Reimplemented from lsst::jointcal::GtransfoPoly.

Definition at line 1236 of file Gtransfo.cc.

◆ getJacobian() [1/2]

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

returns the local jacobian.

Definition at line 111 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 97 of file Gtransfo.cc.

◆ getNpar()

int lsst::jointcal::GtransfoLinShift::getNpar ( ) const
inlinevirtual

total number of parameters

Reimplemented from lsst::jointcal::GtransfoPoly.

Definition at line 486 of file Gtransfo.h.

◆ getOrder()

unsigned lsst::jointcal::GtransfoPoly::getOrder ( ) const
inlineinherited

Returns the polynomial order.

Definition at line 302 of file Gtransfo.h.

◆ getParams()

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

params should be at least Npar() long

Definition at line 210 of file Gtransfo.cc.

◆ inverseTransfo()

std::unique_ptr< Gtransfo > lsst::jointcal::GtransfoLin::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 from lsst::jointcal::Gtransfo.

Definition at line 1228 of file Gtransfo.cc.

◆ inverted()

GtransfoLin lsst::jointcal::GtransfoLin::inverted ( ) const
inherited

returns the inverse: T1 = T2.inverted();

Definition at line 1202 of file Gtransfo.cc.

◆ linearApproximation()

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

linear (local) approximation.

Reimplemented from lsst::jointcal::Gtransfo.

Definition at line 1200 of file Gtransfo.cc.

◆ offsetParams()

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

Definition at line 215 of file Gtransfo.cc.

◆ operator*() [1/2]

GtransfoPoly lsst::jointcal::GtransfoPoly::operator* ( GtransfoPoly const &  right) const
inherited

Composition (internal stuff in quadruple precision)

Definition at line 1003 of file Gtransfo.cc.

◆ operator*() [2/2]

GtransfoLin lsst::jointcal::GtransfoLin::operator* ( GtransfoLin const &  right) const
inherited

enables to combine linear tranformations: T1=T2*T3 is legal.

Definition at line 1179 of file Gtransfo.cc.

◆ operator+()

GtransfoPoly lsst::jointcal::GtransfoPoly::operator+ ( GtransfoPoly const &  right) const
inherited

Addition.

Definition at line 1024 of file Gtransfo.cc.

◆ operator-()

GtransfoPoly lsst::jointcal::GtransfoPoly::operator- ( GtransfoPoly const &  right) const
inherited

Subtraction.

Definition at line 1037 of file Gtransfo.cc.

◆ paramDerivatives()

void lsst::jointcal::GtransfoPoly::paramDerivatives ( Point const &  where,
double *  dx,
double *  dy 
) const
overridevirtualinherited

Derivative w.r.t parameters.

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

Reimplemented from lsst::jointcal::Gtransfo.

Definition at line 743 of file Gtransfo.cc.

◆ paramRef() [1/2]

double lsst::jointcal::GtransfoPoly::paramRef ( const int  i) const
overridevirtualinherited

Reimplemented from lsst::jointcal::Gtransfo.

Definition at line 733 of file Gtransfo.cc.

◆ paramRef() [2/2]

double & lsst::jointcal::GtransfoPoly::paramRef ( const int  i)
overridevirtualinherited

Reimplemented from lsst::jointcal::Gtransfo.

Definition at line 738 of file Gtransfo.cc.

◆ read()

void lsst::jointcal::GtransfoPoly::read ( std::istream s)
inherited

Definition at line 1062 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 190 of file Gtransfo.cc.

◆ toAstMap()

std::shared_ptr< ast::Mapping > lsst::jointcal::GtransfoPoly::toAstMap ( jointcal::Frame const &  domain) const
overridevirtualinherited

Create an equivalent AST mapping for this transformation, including an analytic inverse if possible.

Parameters
domainThe domain of the transfo, to help find an inverse.
Returns
An AST Mapping that represents this transformation.

Reimplemented from lsst::jointcal::Gtransfo.

Definition at line 1047 of file Gtransfo.cc.

◆ transformErrors()

void lsst::jointcal::Gtransfo::transformErrors ( Point const &  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 157 of file Gtransfo.cc.

◆ transformPosAndErrors()

void lsst::jointcal::GtransfoPoly::transformPosAndErrors ( const FatPoint in,
FatPoint out 
) const
overridevirtualinherited

a mix of apply and Derivative

Reimplemented from lsst::jointcal::Gtransfo.

Definition at line 627 of file Gtransfo.cc.

◆ transformStar()

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

allows to write MyTransfo(MyStar)

Definition at line 108 of file Gtransfo.h.

◆ write() [1/2]

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

Definition at line 239 of file Gtransfo.cc.

◆ write() [2/2]

void lsst::jointcal::GtransfoPoly::write ( std::ostream s) const
overridevirtualinherited

Reimplemented from lsst::jointcal::Gtransfo.

Definition at line 1052 of file Gtransfo.cc.


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