lsst.jointcal  22.0.1-19-gfa6a221+6adfa02372
Public Member Functions | Protected Member Functions | List of all members
lsst::jointcal::AstrometryTransformLinearShift Class Reference

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

#include <AstrometryTransform.h>

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

Public Member Functions

 AstrometryTransformLinearShift (double ox=0., double oy=0.)
 Add ox and oy. More...
 
 AstrometryTransformLinearShift (Point const &point)
 
double fit (StarMatchList const &starMatchList)
 guess what More...
 
std::size_t getNpar () const
 total number of parameters More...
 
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...
 
AstrometryTransformLinear operator* (AstrometryTransformLinear const &right) const
 enables to combine linear tranformations: T1=T2*T3 is legal. More...
 
AstrometryTransformPolynomial operator* (AstrometryTransformPolynomial const &right) const
 Composition (internal stuff in quadruple precision) More...
 
AstrometryTransformLinear inverted () const
 returns the inverse: T1 = T2.inverted(); More...
 
void print (std::ostream &out) const override
 print out of coefficients in a readable form. More...
 
void computeDerivative (Point const &where, AstrometryTransformLinear &derivative, const double step=0.01) const override
 specialised analytic routine More...
 
AstrometryTransformLinear linearApproximation (Point const &where, const double step=0.01) const override
 linear (local) approximation. More...
 
std::unique_ptr< AstrometryTransformclone () const override
 returns a copy (allocated by new) of the transformation. More...
 
std::unique_ptr< AstrometryTransforminverseTransform (const double precision, const Frame &region) const override
 returns an inverse transform. Numerical if not overloaded. More...
 
double A11 () const
 
double A12 () const
 
double A21 () const
 
double A22 () const
 
double Dx () const
 
double Dy () const
 
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 AstrometryTransform::apply". More...
 
Frame apply (Frame const &inputframe, bool inscribed) const
 Transform a bounding box, taking either the inscribed or circumscribed box. More...
 
std::size_t getOrder () const
 Returns the polynomial order. More...
 
virtual void transformPosAndErrors (const FatPoint &in, FatPoint &out) const override
 a mix of apply and Derivative 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...
 
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 std::unique_ptr< AstrometryTransformcomposeAndReduce (AstrometryTransform const &right) const
 Return a reduced composition of newTransform = this(right()), or nullptr if it cannot be reduced. 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 write (const std::string &fileName) const
 
void read (std::istream &s)
 
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 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< AstrometryTransformroughInverse (const Frame &region) const
 Rough inverse. More...
 
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...
 

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 497 of file AstrometryTransform.h.

Constructor & Destructor Documentation

◆ AstrometryTransformLinearShift() [1/2]

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

Add ox and oy.

Definition at line 501 of file AstrometryTransform.h.

◆ AstrometryTransformLinearShift() [2/2]

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

Definition at line 503 of file AstrometryTransform.h.

Member Function Documentation

◆ __str__()

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

Definition at line 94 of file AstrometryTransform.h.

◆ a11()

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

Definition at line 479 of file AstrometryTransform.h.

◆ A11()

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

Definition at line 471 of file AstrometryTransform.h.

◆ a12()

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

Definition at line 480 of file AstrometryTransform.h.

◆ A12()

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

Definition at line 472 of file AstrometryTransform.h.

◆ a21()

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

Definition at line 481 of file AstrometryTransform.h.

◆ A21()

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

Definition at line 473 of file AstrometryTransform.h.

◆ a22()

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

Definition at line 482 of file AstrometryTransform.h.

◆ A22()

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

Definition at line 474 of file AstrometryTransform.h.

◆ apply() [1/8]

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

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::AstrometryTransformLinear::clone ( ) const
inlineoverridevirtualinherited

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

Reimplemented from lsst::jointcal::AstrometryTransformPolynomial.

Definition at line 464 of file AstrometryTransform.h.

◆ coeffOrZero()

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

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
inherited

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
inherited

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

specialised analytic routine

Reimplemented from lsst::jointcal::AstrometryTransformPolynomial.

Definition at line 1252 of file AstrometryTransform.cc.

◆ determinant()

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

Definition at line 825 of file AstrometryTransform.cc.

◆ dx()

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

Definition at line 483 of file AstrometryTransform.h.

◆ Dx()

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

Definition at line 475 of file AstrometryTransform.h.

◆ dy()

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

Definition at line 484 of file AstrometryTransform.h.

◆ Dy()

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

Definition at line 476 of file AstrometryTransform.h.

◆ fit()

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

guess what

Reimplemented from lsst::jointcal::AstrometryTransformPolynomial.

Definition at line 1310 of file AstrometryTransform.cc.

◆ getCoefficient() [1/2]

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

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
inherited

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::AstrometryTransformLinearShift::getNpar ( ) const
inlinevirtual

total number of parameters

Reimplemented from lsst::jointcal::AstrometryTransformPolynomial.

Definition at line 507 of file AstrometryTransform.h.

◆ getOrder()

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

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::AstrometryTransformLinear::inverseTransform ( const double  precision,
const Frame region 
) const
overridevirtualinherited

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

Definition at line 1290 of file AstrometryTransform.cc.

◆ inverted()

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

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

Definition at line 1263 of file AstrometryTransform.cc.

◆ linearApproximation()

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

linear (local) approximation.

Reimplemented from lsst::jointcal::AstrometryTransform.

Definition at line 1259 of file AstrometryTransform.cc.

◆ offsetParams()

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

Definition at line 221 of file AstrometryTransform.cc.

◆ operator*() [1/2]

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

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

Definition at line 1237 of file AstrometryTransform.cc.

◆ operator*() [2/2]

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

Composition (internal stuff in quadruple precision)

Definition at line 1053 of file AstrometryTransform.cc.

◆ operator+()

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

Addition.

Definition at line 1075 of file AstrometryTransform.cc.

◆ operator-()

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

Subtraction.

Definition at line 1089 of file AstrometryTransform.cc.

◆ paramDerivatives()

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

Definition at line 775 of file AstrometryTransform.cc.

◆ paramRef() [1/2]

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

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)
overridevirtualinherited

Reimplemented from lsst::jointcal::AstrometryTransform.

Definition at line 770 of file AstrometryTransform.cc.

◆ print()

void lsst::jointcal::AstrometryTransformLinear::print ( std::ostream out) const
overridevirtualinherited

print out of coefficients in a readable form.

Reimplemented from lsst::jointcal::AstrometryTransformPolynomial.

Definition at line 1295 of file AstrometryTransform.cc.

◆ read()

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

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.

◆ toAstMap()

std::shared_ptr< ast::Mapping > lsst::jointcal::AstrometryTransformPolynomial::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 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
overridevirtualinherited

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
overridevirtualinherited

Reimplemented from lsst::jointcal::AstrometryTransform.

Definition at line 1105 of file AstrometryTransform.cc.


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