lsst.jointcal  21.0.0-16-g4bab731+aa5332d639
Public Member Functions | List of all members
lsst::jointcal::AstrometryTransform Class Referenceabstract

a virtual (interface) class for geometric transformations. More...

#include <AstrometryTransform.h>

Inheritance diagram for lsst::jointcal::AstrometryTransform:
lsst::jointcal::AstrometryTransformComposition lsst::jointcal::AstrometryTransformIdentity lsst::jointcal::AstrometryTransformInverse lsst::jointcal::AstrometryTransformPolynomial lsst::jointcal::AstrometryTransformSkyWcs lsst::jointcal::BaseTanWcs lsst::jointcal::TanRaDecToPixel lsst::jointcal::UserTransform

Public Member Functions

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 void print (std::ostream &out) const =0
 prints the transform coefficients to stream. More...
 
std::string __str__ ()
 
virtual double fit (StarMatchList const &starMatchList)=0
 fits a transform to a std::list of Point pairs (p1,p2, the Point fields in StarMatch). More...
 
void transformStar (FatPoint &in) const
 
virtual double getJacobian (Point const &point) const
 returns the local jacobian. More...
 
virtual std::unique_ptr< AstrometryTransformclone () const =0
 returns a copy (allocated by new) of the transformation. 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 double getJacobian (const double x, const double y) const
 returns the local jacobian. 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...
 
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 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::unique_ptr< AstrometryTransformroughInverse (const Frame &region) const
 Rough inverse. 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
 
virtual ~AstrometryTransform ()
 

Detailed Description

a virtual (interface) class for geometric transformations.

We implement here One AstrometryTransform interface class, and actual derived classes. Composition in the usual (mathematical) sense is provided using compose(), and some classes (e.g. AstrometryTransformLinear) handle a * operator. Generic inversion by iteration exists, but it is at least 10 times slower than the corresponding "direct transformation". If a transform has an analytical inverse, then providing inverseTransform is obviously a very good idea. Before resorting to inverseTransform, consider using StarMatchList::inverseTransform(). AstrometryTransformLinear::inverted() and TanPixelToRaDec::inverted() exist. The classes also provide derivation and linear approximation.

Definition at line 65 of file AstrometryTransform.h.

Constructor & Destructor Documentation

◆ ~AstrometryTransform()

virtual lsst::jointcal::AstrometryTransform::~AstrometryTransform ( )
inlinevirtual

Definition at line 197 of file AstrometryTransform.h.

Member Function Documentation

◆ __str__()

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

Definition at line 94 of file AstrometryTransform.h.

◆ apply() [1/4]

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

◆ apply() [2/4]

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

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

void lsst::jointcal::AstrometryTransform::apply ( Point const &  in,
Point out 
) const
inline

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

Definition at line 71 of file AstrometryTransform.h.

◆ clone()

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

◆ composeAndReduce()

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

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
virtual

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

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

◆ getJacobian() [1/2]

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

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
inlinevirtual

returns the local jacobian.

Definition at line 110 of file AstrometryTransform.h.

◆ getNpar()

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

◆ getParams()

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

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
virtual

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
virtual

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)

Definition at line 221 of file AstrometryTransform.cc.

◆ paramDerivatives()

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

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

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
virtual

Reimplemented in lsst::jointcal::AstrometryTransformPolynomial.

Definition at line 226 of file AstrometryTransform.cc.

◆ print()

virtual void lsst::jointcal::AstrometryTransform::print ( std::ostream out) const
pure virtual

◆ roughInverse()

std::unique_ptr< AstrometryTransform > lsst::jointcal::AstrometryTransform::roughInverse ( const Frame region) const
virtual

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

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

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
virtual

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
virtual

◆ transformStar()

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

Definition at line 107 of file AstrometryTransform.h.

◆ write() [1/2]

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

Definition at line 246 of file AstrometryTransform.cc.

◆ write() [2/2]

void lsst::jointcal::AstrometryTransform::write ( std::ostream stream) const
virtual

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