lsst.jointcal  22.0.1-12-g3bd7ecb+a917b5ddeb
Public Member Functions | List of all members
lsst::jointcal::AstrometryTransformPolynomial Class Reference

Polynomial transformation class. More...

#include <AstrometryTransform.h>

Inheritance diagram for lsst::jointcal::AstrometryTransformPolynomial:
lsst::jointcal::AstrometryTransform lsst::jointcal::AstrometryTransformLinear lsst::jointcal::AstrometryTransformLinearRot lsst::jointcal::AstrometryTransformLinearScale lsst::jointcal::AstrometryTransformLinearShift

Public Member Functions

 AstrometryTransformPolynomial (std::size_t order=1)
 Default transform : identity for all orders (>=1 ). More...
 
 AstrometryTransformPolynomial (const AstrometryTransform *transform, const Frame &frame, std::size_t order, std::size_t nPoint=1000)
 Constructs a "polynomial image" from an existing transform, over a specified domain. More...
 
 AstrometryTransformPolynomial (std::shared_ptr< afw::geom::TransformPoint2ToPoint2 > transform, jointcal::Frame const &domain, std::size_t order, std::size_t nSteps=50)
 Constructs a polynomial approximation to an afw::geom::TransformPoint2ToPoint2. More...
 
void setOrder (std::size_t order)
 Sets the polynomial order (the highest sum of exponents of the largest monomial). More...
 
std::size_t 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, AstrometryTransformLinear &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...
 
std::size_t getNpar () const override
 total number of parameters More...
 
void print (std::ostream &out) const override
 print out of coefficients in a readable form. More...
 
double fit (StarMatchList const &starMatchList) override
 guess what More...
 
AstrometryTransformPolynomial operator* (AstrometryTransformPolynomial const &right) const
 Composition (internal stuff in quadruple precision) More...
 
AstrometryTransformPolynomial operator+ (AstrometryTransformPolynomial const &right) const
 Addition. More...
 
AstrometryTransformPolynomial operator- (AstrometryTransformPolynomial const &right) const
 Subtraction. More...
 
std::unique_ptr< AstrometryTransformcomposeAndReduce (AstrometryTransformPolynomial const &right) const
 Return a reduced composition of newTransform = this(right()), or nullptr if it cannot be reduced. More...
 
std::unique_ptr< AstrometryTransformclone () const override
 returns a copy (allocated by new) of the transformation. More...
 
double coeffOrZero (std::size_t powX, std::size_t powY, std::size_t whichCoord) const
 read access, zero if beyond order More...
 
double determinant () const
 
double paramRef (Eigen::Index const i) const override
 
double & paramRef (Eigen::Index const 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)
 
virtual void apply (const double xIn, const double yIn, double &xOut, double &yOut) const=0
 
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 AstrometryTransform::apply". More...
 
Frame apply (Frame const &inputframe, bool inscribed) const
 Transform a bounding box, taking either the inscribed or circumscribed box. More...
 
virtual std::unique_ptr< AstrometryTransformcomposeAndReduce (AstrometryTransform const &right) const
 Return a reduced composition of newTransform = this(right()), or nullptr if it cannot be reduced. More...
 
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 AstrometryTransform::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
 
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< AstrometryTransformcomposeAndReduce (AstrometryTransform const &right) const
 Return a reduced composition of newTransform = this(right()), or nullptr if it cannot be reduced. More...
 
virtual AstrometryTransformLinear 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< AstrometryTransforminverseTransform (const double precision, const Frame &region) const
 returns an inverse transform. 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< AstrometryTransformroughInverse (const Frame &region) const
 Rough inverse. More...
 
void write (const std::string &fileName) const
 
double getCoefficient (std::size_t powX, std::size_t powY, std::size_t whichCoord) const
 Get the coefficient of a given power in x and y, for either the x or y coordinate. More...
 
double & getCoefficient (std::size_t powX, std::size_t powY, std::size_t whichCoord)
 Get the coefficient of a given power in x and y, for either the x or y coordinate. More...
 

Detailed Description

Polynomial transformation class.

Definition at line 280 of file AstrometryTransform.h.

Constructor & Destructor Documentation

◆ AstrometryTransformPolynomial() [1/3]

lsst::jointcal::AstrometryTransformPolynomial::AstrometryTransformPolynomial ( std::size_t  order = 1)

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

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

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

Definition at line 470 of file AstrometryTransform.cc.

◆ AstrometryTransformPolynomial() [2/3]

lsst::jointcal::AstrometryTransformPolynomial::AstrometryTransformPolynomial ( const AstrometryTransform transform,
const Frame frame,
std::size_t  order,
std::size_t  nPoint = 1000 
)

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

Definition at line 483 of file AstrometryTransform.cc.

◆ AstrometryTransformPolynomial() [3/3]

lsst::jointcal::AstrometryTransformPolynomial::AstrometryTransformPolynomial ( std::shared_ptr< afw::geom::TransformPoint2ToPoint2 transform,
jointcal::Frame const &  domain,
std::size_t  order,
std::size_t  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 505 of file AstrometryTransform.cc.

Member Function Documentation

◆ __str__()

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

Definition at line 94 of file AstrometryTransform.h.

◆ apply() [1/8]

void lsst::jointcal::AstrometryTransformPolynomial::apply ( const double  xIn,
const double  yIn,
double &  xOut,
double &  yOut 
) const
overridevirtual

Implements lsst::jointcal::AstrometryTransform.

Definition at line 572 of file AstrometryTransform.cc.

◆ apply() [2/8]

virtual void lsst::jointcal::AstrometryTransform::apply

◆ apply() [3/8]

Frame lsst::jointcal::AstrometryTransform::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 76 of file AstrometryTransform.cc.

◆ apply() [4/8]

Frame lsst::jointcal::AstrometryTransform::apply

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 89 of file AstrometryTransform.cc.

◆ apply() [5/8]

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

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

Definition at line 75 of file AstrometryTransform.h.

◆ apply() [6/8]

Point lsst::jointcal::AstrometryTransform::apply
inline

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

Definition at line 75 of file AstrometryTransform.h.

◆ apply() [7/8]

void lsst::jointcal::AstrometryTransform::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 AstrometryTransform.h.

◆ apply() [8/8]

void lsst::jointcal::AstrometryTransform::apply
inline

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

Definition at line 71 of file AstrometryTransform.h.

◆ clone()

std::unique_ptr<AstrometryTransform> lsst::jointcal::AstrometryTransformPolynomial::clone ( ) const
inlineoverridevirtual

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

Implements lsst::jointcal::AstrometryTransform.

Reimplemented in lsst::jointcal::AstrometryTransformLinear.

Definition at line 344 of file AstrometryTransform.h.

◆ coeffOrZero()

double lsst::jointcal::AstrometryTransformPolynomial::coeffOrZero ( std::size_t  powX,
std::size_t  powY,
std::size_t  whichCoord 
) const

read access, zero if beyond order

Definition at line 755 of file AstrometryTransform.cc.

◆ composeAndReduce() [1/3]

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

Return a reduced composition of newTransform = 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 AstrometryTransform, or nullptr if no such reduction is possible.

Reimplemented in lsst::jointcal::AstrometryTransformIdentity.

Definition at line 94 of file AstrometryTransform.cc.

◆ composeAndReduce() [2/3]

std::unique_ptr< AstrometryTransform > lsst::jointcal::AstrometryTransform::composeAndReduce

Return a reduced composition of newTransform = 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 AstrometryTransform, or nullptr if no such reduction is possible.

Definition at line 131 of file AstrometryTransform.cc.

◆ composeAndReduce() [3/3]

std::unique_ptr< AstrometryTransform > lsst::jointcal::AstrometryTransformPolynomial::composeAndReduce ( AstrometryTransformPolynomial const &  right) const

Return a reduced composition of newTransform = 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 AstrometryTransform, or nullptr if no such reduction is possible.

Definition at line 945 of file AstrometryTransform.cc.

◆ computeDerivative()

void lsst::jointcal::AstrometryTransformPolynomial::computeDerivative ( Point const &  where,
AstrometryTransformLinear derivative,
const double  step = 0.01 
) const
overridevirtual

specialised analytic routine

Reimplemented from lsst::jointcal::AstrometryTransform.

Reimplemented in lsst::jointcal::AstrometryTransformLinear.

Definition at line 596 of file AstrometryTransform.cc.

◆ determinant()

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

Definition at line 825 of file AstrometryTransform.cc.

◆ fit()

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

◆ getCoefficient() [1/2]

double & lsst::jointcal::AstrometryTransformPolynomial::getCoefficient ( std::size_t  powX,
std::size_t  powY,
std::size_t  whichCoord 
)

Get the coefficient of a given power in x and y, for either the x or y coordinate.

Definition at line 749 of file AstrometryTransform.cc.

◆ getCoefficient() [2/2]

double lsst::jointcal::AstrometryTransformPolynomial::getCoefficient ( std::size_t  powX,
std::size_t  powY,
std::size_t  whichCoord 
) const

Get the coefficient of a given power in x and y, for either the x or y coordinate.

Definition at line 740 of file AstrometryTransform.cc.

◆ getJacobian() [1/2]

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

returns the local jacobian.

Definition at line 99 of file AstrometryTransform.cc.

◆ getJacobian() [2/2]

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

returns the local jacobian.

Definition at line 110 of file AstrometryTransform.h.

◆ getNpar()

std::size_t lsst::jointcal::AstrometryTransformPolynomial::getNpar ( ) const
inlineoverridevirtual

◆ getOrder()

std::size_t lsst::jointcal::AstrometryTransformPolynomial::getOrder ( ) const
inline

Returns the polynomial order.

Definition at line 307 of file AstrometryTransform.h.

◆ getParams()

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

params should be at least Npar() long

Definition at line 216 of file AstrometryTransform.cc.

◆ inverseTransform()

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

returns an inverse transform. Numerical if not overloaded.

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

Reimplemented in lsst::jointcal::AstrometryTransformInverse, lsst::jointcal::AstrometryTransformLinear, lsst::jointcal::TanRaDecToPixel, lsst::jointcal::TanSipPixelToRaDec, and lsst::jointcal::TanPixelToRaDec.

Definition at line 303 of file AstrometryTransform.cc.

◆ linearApproximation()

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

linear (local) approximation.

Reimplemented in lsst::jointcal::AstrometryTransformLinear, and lsst::jointcal::AstrometryTransformIdentity.

Definition at line 136 of file AstrometryTransform.cc.

◆ offsetParams()

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

Definition at line 221 of file AstrometryTransform.cc.

◆ operator*()

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

Composition (internal stuff in quadruple precision)

Definition at line 1053 of file AstrometryTransform.cc.

◆ operator+()

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

Addition.

Definition at line 1075 of file AstrometryTransform.cc.

◆ operator-()

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

Subtraction.

Definition at line 1089 of file AstrometryTransform.cc.

◆ paramDerivatives()

void lsst::jointcal::AstrometryTransformPolynomial::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::AstrometryTransform.

Definition at line 775 of file AstrometryTransform.cc.

◆ paramRef() [1/2]

double lsst::jointcal::AstrometryTransformPolynomial::paramRef ( Eigen::Index const  i) const
overridevirtual

Reimplemented from lsst::jointcal::AstrometryTransform.

Definition at line 765 of file AstrometryTransform.cc.

◆ paramRef() [2/2]

double & lsst::jointcal::AstrometryTransformPolynomial::paramRef ( Eigen::Index const  i)
overridevirtual

Reimplemented from lsst::jointcal::AstrometryTransform.

Definition at line 770 of file AstrometryTransform.cc.

◆ print()

void lsst::jointcal::AstrometryTransformPolynomial::print ( std::ostream out) const
overridevirtual

print out of coefficients in a readable form.

Implements lsst::jointcal::AstrometryTransform.

Reimplemented in lsst::jointcal::AstrometryTransformLinear.

Definition at line 795 of file AstrometryTransform.cc.

◆ read()

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

Definition at line 1115 of file AstrometryTransform.cc.

◆ roughInverse()

std::unique_ptr< AstrometryTransform > lsst::jointcal::AstrometryTransform::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::TanRaDecToPixel, lsst::jointcal::TanPixelToRaDec, and lsst::jointcal::AstrometryTransformInverse.

Definition at line 195 of file AstrometryTransform.cc.

◆ setOrder()

void lsst::jointcal::AstrometryTransformPolynomial::setOrder ( std::size_t  order)

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

Definition at line 551 of file AstrometryTransform.cc.

◆ toAstMap()

std::shared_ptr< ast::Mapping > lsst::jointcal::AstrometryTransformPolynomial::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 transform, to help find an inverse.
Returns
An AST Mapping that represents this transformation.

Reimplemented from lsst::jointcal::AstrometryTransform.

Definition at line 1100 of file AstrometryTransform.cc.

◆ transformErrors()

void lsst::jointcal::AstrometryTransform::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 162 of file AstrometryTransform.cc.

◆ transformPosAndErrors()

void lsst::jointcal::AstrometryTransformPolynomial::transformPosAndErrors ( const FatPoint in,
FatPoint out 
) const
overridevirtual

a mix of apply and Derivative

Reimplemented from lsst::jointcal::AstrometryTransform.

Definition at line 656 of file AstrometryTransform.cc.

◆ transformStar()

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

Definition at line 107 of file AstrometryTransform.h.

◆ write() [1/2]

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

Definition at line 246 of file AstrometryTransform.cc.

◆ write() [2/2]

void lsst::jointcal::AstrometryTransformPolynomial::write ( std::ostream s) const
overridevirtual

Reimplemented from lsst::jointcal::AstrometryTransform.

Definition at line 1105 of file AstrometryTransform.cc.


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