lsst.jointcal  16.0-23-gcb65559+1
Public Member Functions | List of all members
lsst::jointcal::GtransfoPoly Class Reference

Polynomial transformation class. More...

#include <Gtransfo.h>

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

Public Member Functions

 GtransfoPoly (const unsigned order=1)
 Default transfo : identity for all orders (>=1 ). More...
 
 GtransfoPoly (const Gtransfo *gtransfo, const Frame &frame, unsigned order, unsigned nPoint=1000)
 Constructs a "polynomial image" from an existing transfo, over a specified domain. More...
 
 GtransfoPoly (std::shared_ptr< afw::geom::TransformPoint2ToPoint2 > transform, jointcal::Frame const &domain, unsigned const order, unsigned const nSteps=50)
 Constructs a polynomial approximation to an afw::geom::TransformPoint2ToPoint2. More...
 
void setOrder (const unsigned order)
 Sets the polynomial order (the highest sum of exponents of the largest monomial). More...
 
unsigned getOrder () const
 Returns the polynomial order. More...
 
void apply (const double xIn, const double yIn, double &xOut, double &yOut) const override
 
void computeDerivative (Point const &where, GtransfoLin &derivative, const double step=0.01) const override
 specialised analytic routine More...
 
virtual void transformPosAndErrors (const FatPoint &in, FatPoint &out) const override
 a mix of apply and Derivative More...
 
int getNpar () const override
 total number of parameters More...
 
void dump (std::ostream &stream=std::cout) const override
 print out of coefficients in a readable form. More...
 
double fit (StarMatchList const &starMatchList) override
 guess what More...
 
GtransfoPoly operator* (GtransfoPoly const &right) const
 Composition (internal stuff in quadruple precision) 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...
 
std::unique_ptr< Gtransfoclone () const override
 returns a copy (allocated by new) of the transformation. 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 read (std::istream &s)
 
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...
 
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 std::unique_ptr< GtransfocomposeAndReduce (Gtransfo const &right) const
 Return a reduced composition of newTransfo = this(right()), or nullptr if it cannot be reduced. More...
 
virtual GtransfoLin linearApproximation (Point const &where, const double step=0.01) const
 linear (local) approximation. 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...
 
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 std::unique_ptr< GtransforoughInverse (const Frame &region) const
 Rough inverse. More...
 
void write (const std::string &fileName) const
 

Detailed Description

Polynomial transformation class.

Definition at line 276 of file Gtransfo.h.

Constructor & Destructor Documentation

◆ GtransfoPoly() [1/3]

lsst::jointcal::GtransfoPoly::GtransfoPoly ( const unsigned  order = 1)

Default transfo : identity for all orders (>=1 ).

Default transfo : identity for all orders (>=1 )

Parameters
orderThe highest total power (x+y) of monomials of this polynomial.

Definition at line 447 of file Gtransfo.cc.

◆ GtransfoPoly() [2/3]

lsst::jointcal::GtransfoPoly::GtransfoPoly ( const Gtransfo gtransfo,
const Frame frame,
unsigned  order,
unsigned  nPoint = 1000 
)

Constructs a "polynomial image" from an existing transfo, over a specified domain.

Definition at line 460 of file Gtransfo.cc.

◆ GtransfoPoly() [3/3]

lsst::jointcal::GtransfoPoly::GtransfoPoly ( std::shared_ptr< afw::geom::TransformPoint2ToPoint2 transform,
jointcal::Frame const &  domain,
unsigned const  order,
unsigned const  nSteps = 50 
)

Constructs a polynomial approximation to an afw::geom::TransformPoint2ToPoint2.

Parameters
[in]transformThe transform to be approximated.
[in]domainThe valid domain of the transform.
[in]orderThe polynomial order to use when approximating.
[in]nStepsThe number of sample points per axis (nSteps^2 total points).

Definition at line 480 of file Gtransfo.cc.

Member Function Documentation

◆ __str__()

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

Definition at line 94 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
overridevirtual

Implements lsst::jointcal::Gtransfo.

Definition at line 546 of file Gtransfo.cc.

◆ clone()

std::unique_ptr<Gtransfo> lsst::jointcal::GtransfoPoly::clone ( ) const
inlineoverridevirtual

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

Implements lsst::jointcal::Gtransfo.

Reimplemented in lsst::jointcal::GtransfoLin.

Definition at line 337 of file Gtransfo.h.

◆ coeff() [1/2]

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

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 
)

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

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

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::GtransfoPoly::computeDerivative ( Point const &  where,
GtransfoLin derivative,
const double  step = 0.01 
) const
overridevirtual

specialised analytic routine

Reimplemented from lsst::jointcal::Gtransfo.

Reimplemented in lsst::jointcal::GtransfoLin.

Definition at line 569 of file Gtransfo.cc.

◆ determinant()

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

Definition at line 782 of file Gtransfo.cc.

◆ dump()

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

print out of coefficients in a readable form.

Implements lsst::jointcal::Gtransfo.

Definition at line 763 of file Gtransfo.cc.

◆ fit()

double lsst::jointcal::GtransfoPoly::fit ( StarMatchList const &  starMatchList)
overridevirtual

guess what

Implements lsst::jointcal::Gtransfo.

Reimplemented in lsst::jointcal::GtransfoLinRot, and lsst::jointcal::GtransfoLinShift.

Definition at line 880 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::GtransfoPoly::getNpar ( ) const
inlineoverridevirtual

total number of parameters

Reimplemented from lsst::jointcal::Gtransfo.

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

Definition at line 316 of file Gtransfo.h.

◆ getOrder()

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

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::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 292 of file Gtransfo.cc.

◆ linearApproximation()

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

linear (local) approximation.

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

Definition at line 133 of file Gtransfo.cc.

◆ offsetParams()

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

Definition at line 215 of file Gtransfo.cc.

◆ operator*()

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

Composition (internal stuff in quadruple precision)

Definition at line 1003 of file Gtransfo.cc.

◆ operator+()

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

Addition.

Definition at line 1024 of file Gtransfo.cc.

◆ operator-()

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

Subtraction.

Definition at line 1037 of file Gtransfo.cc.

◆ paramDerivatives()

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

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
overridevirtual

Reimplemented from lsst::jointcal::Gtransfo.

Definition at line 733 of file Gtransfo.cc.

◆ paramRef() [2/2]

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

Reimplemented from lsst::jointcal::Gtransfo.

Definition at line 738 of file Gtransfo.cc.

◆ read()

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

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.

◆ setOrder()

void lsst::jointcal::GtransfoPoly::setOrder ( const unsigned  order)

Sets the polynomial order (the highest sum of exponents of the largest monomial).

Definition at line 525 of file Gtransfo.cc.

◆ toAstMap()

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

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
overridevirtual

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
overridevirtual

Reimplemented from lsst::jointcal::Gtransfo.

Definition at line 1052 of file Gtransfo.cc.


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