lsst.jointcal  19.0.0-14-gb0260a2+d3340e0b0c
Public Member Functions | List of all members
lsst::jointcal::AstrometryTransformInverse Class Reference
Inheritance diagram for lsst::jointcal::AstrometryTransformInverse:
lsst::jointcal::AstrometryTransform

Public Member Functions

 AstrometryTransformInverse (const AstrometryTransform *direct, const double precision, const Frame &region)
 
void apply (const double xIn, const double yIn, double &xOut, double &yOut) const
 implements an iterative (Gauss-Newton) solver. More...
 
void print (ostream &out) const
 prints the transform coefficients to stream. More...
 
double fit (StarMatchList const &starMatchList)
 fits a transform to a std::list of Point pairs (p1,p2, the Point fields in StarMatch). More...
 
virtual std::unique_ptr< AstrometryTransformclone () const
 returns a copy (allocated by new) of the transformation. More...
 
 AstrometryTransformInverse (AstrometryTransformInverse const &)
 
std::unique_ptr< AstrometryTransformroughInverse (const Frame &) const
 Overload the "generic routine". More...
 
std::unique_ptr< AstrometryTransforminverseTransform (double, const Frame &) const
 Inverse transform: returns the direct one! More...
 
 ~AstrometryTransformInverse ()
 
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 void computeDerivative (Point const &where, AstrometryTransformLinear &derivative, const double step=0.01) const
 Computes the local Derivative of a transform, w.r.t. More...
 
virtual AstrometryTransformLinear linearApproximation (Point const &where, const double step=0.01) const
 linear (local) approximation. More...
 
virtual void transformPosAndErrors (const FatPoint &in, FatPoint &out) const
 
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 double paramRef (Eigen::Index const i) const
 
virtual double & paramRef (Eigen::Index const i)
 
virtual void paramDerivatives (Point const &where, double *dx, double *dy) const
 Derivative w.r.t parameters. More...
 
virtual std::size_t getNpar () const
 returns the number of parameters (to compute chi2's) More...
 
virtual std::shared_ptr< ast::MappingtoAstMap (jointcal::Frame const &domain) const
 Create an equivalent AST mapping for this transformation, including an analytic inverse if possible. More...
 
void write (const std::string &fileName) const
 
virtual void write (std::ostream &stream) const
 

Detailed Description

Definition at line 267 of file AstrometryTransform.cc.

Constructor & Destructor Documentation

◆ AstrometryTransformInverse() [1/2]

lsst::jointcal::AstrometryTransformInverse::AstrometryTransformInverse ( const AstrometryTransform direct,
const double  precision,
const Frame region 
)

Definition at line 308 of file AstrometryTransform.cc.

◆ AstrometryTransformInverse() [2/2]

lsst::jointcal::AstrometryTransformInverse::AstrometryTransformInverse ( AstrometryTransformInverse const &  model)

Definition at line 315 of file AstrometryTransform.cc.

◆ ~AstrometryTransformInverse()

lsst::jointcal::AstrometryTransformInverse::~AstrometryTransformInverse ( )

Definition at line 322 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/4]

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

implements an iterative (Gauss-Newton) solver.

It resorts to the Derivative function: 4 calls to the direct transform per iteration.

Implements lsst::jointcal::AstrometryTransform.

Definition at line 330 of file AstrometryTransform.cc.

◆ apply() [2/4]

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() [3/4]

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() [4/4]

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.

◆ clone()

std::unique_ptr< AstrometryTransform > lsst::jointcal::AstrometryTransformInverse::clone ( ) const
virtual

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

Implements lsst::jointcal::AstrometryTransform.

Definition at line 362 of file AstrometryTransform.cc.

◆ composeAndReduce()

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.

◆ computeDerivative()

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

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

the Derivative is represented by a AstrometryTransformLinear, 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::AstrometryTransformLinear, lsst::jointcal::AstrometryTransformPolynomial, and lsst::jointcal::AstrometryTransformIdentity.

Definition at line 118 of file AstrometryTransform.cc.

◆ fit()

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

fits a transform 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 transform (e.g. such that this(T1(p1)) = T2(p2), use StarMatchList::applyTransform beforehand.

Implements lsst::jointcal::AstrometryTransform.

Definition at line 357 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()

virtual std::size_t lsst::jointcal::AstrometryTransform::getNpar ( ) const
inlinevirtualinherited

◆ 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::AstrometryTransformInverse::inverseTransform ( double  ,
const Frame  
) const
inlinevirtual

Inverse transform: returns the direct one!

Reimplemented from lsst::jointcal::AstrometryTransform.

Definition at line 293 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.

◆ paramDerivatives()

void lsst::jointcal::AstrometryTransform::paramDerivatives ( Point const &  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::AstrometryTransformPolynomial.

Definition at line 236 of file AstrometryTransform.cc.

◆ paramRef() [1/2]

double & lsst::jointcal::AstrometryTransform::paramRef ( Eigen::Index const  i)
virtualinherited

Reimplemented in lsst::jointcal::AstrometryTransformPolynomial.

Definition at line 231 of file AstrometryTransform.cc.

◆ paramRef() [2/2]

double lsst::jointcal::AstrometryTransform::paramRef ( Eigen::Index const  i) const
virtualinherited

Reimplemented in lsst::jointcal::AstrometryTransformPolynomial.

Definition at line 226 of file AstrometryTransform.cc.

◆ print()

void lsst::jointcal::AstrometryTransformInverse::print ( ostream out) const
virtual

prints the transform coefficients to stream.

Implements lsst::jointcal::AstrometryTransform.

Definition at line 353 of file AstrometryTransform.cc.

◆ roughInverse()

std::unique_ptr<AstrometryTransform> lsst::jointcal::AstrometryTransformInverse::roughInverse ( const Frame ) const
inlinevirtual

Overload the "generic routine".

Reimplemented from lsst::jointcal::AstrometryTransform.

Definition at line 290 of file AstrometryTransform.cc.

◆ toAstMap()

virtual std::shared_ptr<ast::Mapping> lsst::jointcal::AstrometryTransform::toAstMap ( jointcal::Frame const &  domain) const
inlinevirtualinherited

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 in lsst::jointcal::AstrometryTransformPolynomial, and lsst::jointcal::AstrometryTransformIdentity.

Definition at line 189 of file AstrometryTransform.h.

◆ 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::AstrometryTransform::transformPosAndErrors ( const FatPoint in,
FatPoint out 
) const
virtualinherited

◆ 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::AstrometryTransform::write ( std::ostream stream) const
virtualinherited

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