lsst.jointcal  16.0-18-gdf247dd+5
Public Member Functions | List of all members
lsst::jointcal::TanRaDec2Pix Class Reference

This one is the Tangent Plane (called gnomonic) projection (from celestial sphere to tangent plane) More...

#include <Gtransfo.h>

Inheritance diagram for lsst::jointcal::TanRaDec2Pix:
lsst::jointcal::Gtransfo

Public Member Functions

 TanRaDec2Pix (GtransfoLin const &tan2Pix, Point const &tangentPoint)
 assume degrees everywhere. More...
 
 TanRaDec2Pix ()
 
GtransfoLin getLinPart () const
 The Linear part (corresponding to CD's and CRPIX's) More...
 
void setTangentPoint (Point const &tangentPoint)
 Resets the projection (or tangent) point. More...
 
Point getTangentPoint () const
 tangent point coordinates (degrees) More...
 
void apply (const double xIn, const double yIn, double &xOut, double &yOut) const
 
void transformPosAndErrors (const FatPoint &in, FatPoint &out) const
 transform with analytical derivatives More...
 
TanPix2RaDec inverted () const
 exact typed inverse: More...
 
std::unique_ptr< GtransforoughInverse (const Frame &region) const
 Overload the "generic routine" (available for all Gtransfo types. More...
 
std::unique_ptr< GtransfoinverseTransfo (const double precision, const Frame &region) const
 Inverse transfo: returns a TanPix2RaDec. More...
 
void dump (std::ostream &stream) const
 dumps the transfo coefficients to stream. More...
 
std::unique_ptr< Gtransfoclone () const
 returns a copy (allocated by new) of the transformation. More...
 
double fit (StarMatchList const &starMatchList)
 fits a transfo to a std::list of Point pairs (p1,p2, the Point fields in StarMatch). 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 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 void computeDerivative (Point const &where, GtransfoLin &derivative, const double step=0.01) const
 Computes the local Derivative of a transfo, w.r.t. 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...
 
void getParams (double *params) const
 params should be at least Npar() long More...
 
void offsetParams (Eigen::VectorXd const &delta)
 
virtual double paramRef (const int i) const
 
virtual double & paramRef (const int i)
 
virtual void paramDerivatives (Point const &where, double *dx, double *dy) const
 Derivative w.r.t parameters. More...
 
virtual int 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

This one is the Tangent Plane (called gnomonic) projection (from celestial sphere to tangent plane)

this transfo does not implement corrections, since they are defined the other way around (from pixels to sky), and not invertible analytically. The inversion of tangent point WCS (TanPix2RaDec) is obtained via inverseTransfo().

Definition at line 653 of file Gtransfo.h.

Constructor & Destructor Documentation

◆ TanRaDec2Pix() [1/2]

lsst::jointcal::TanRaDec2Pix::TanRaDec2Pix ( GtransfoLin const &  tan2Pix,
Point const &  tangentPoint 
)

assume degrees everywhere.

Definition at line 1548 of file Gtransfo.cc.

◆ TanRaDec2Pix() [2/2]

lsst::jointcal::TanRaDec2Pix::TanRaDec2Pix ( )

Definition at line 1561 of file Gtransfo.cc.

Member Function Documentation

◆ __str__()

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

Definition at line 71 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 48 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 52 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 50 of file Gtransfo.cc.

◆ apply() [4/4]

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

Implements lsst::jointcal::Gtransfo.

Definition at line 1624 of file Gtransfo.cc.

◆ clone()

std::unique_ptr< Gtransfo > lsst::jointcal::TanRaDec2Pix::clone ( ) const
virtual

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

Implements lsst::jointcal::Gtransfo.

Definition at line 1660 of file Gtransfo.cc.

◆ composeAndReduce()

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

◆ computeDerivative()

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

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

the Derivative is represented by a GtransfoLin, 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::GtransfoLin, lsst::jointcal::GtransfoPoly, and lsst::jointcal::GtransfoIdentity.

Definition at line 92 of file Gtransfo.cc.

◆ dump()

void lsst::jointcal::TanRaDec2Pix::dump ( std::ostream stream) const
virtual

dumps the transfo coefficients to stream.

Implements lsst::jointcal::Gtransfo.

Definition at line 1647 of file Gtransfo.cc.

◆ fit()

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

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

Implements lsst::jointcal::Gtransfo.

Definition at line 1664 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 88 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 73 of file Gtransfo.cc.

◆ getLinPart()

GtransfoLin lsst::jointcal::TanRaDec2Pix::getLinPart ( ) const

The Linear part (corresponding to CD's and CRPIX's)

Definition at line 1569 of file Gtransfo.cc.

◆ getNpar()

virtual int lsst::jointcal::Gtransfo::getNpar ( ) const
inlinevirtualinherited

returns the number of parameters (to compute chi2's)

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

Definition at line 157 of file Gtransfo.h.

◆ getParams()

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

params should be at least Npar() long

Definition at line 186 of file Gtransfo.cc.

◆ getTangentPoint()

Point lsst::jointcal::TanRaDec2Pix::getTangentPoint ( ) const

tangent point coordinates (degrees)

Definition at line 1567 of file Gtransfo.cc.

◆ inverseTransfo()

std::unique_ptr< Gtransfo > lsst::jointcal::TanRaDec2Pix::inverseTransfo ( const double  precision,
const Frame region 
) const
virtual

Inverse transfo: returns a TanPix2RaDec.

Reimplemented from lsst::jointcal::Gtransfo.

Definition at line 1656 of file Gtransfo.cc.

◆ inverted()

TanPix2RaDec lsst::jointcal::TanRaDec2Pix::inverted ( ) const

exact typed inverse:

Definition at line 1643 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 109 of file Gtransfo.cc.

◆ offsetParams()

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

Definition at line 191 of file Gtransfo.cc.

◆ paramDerivatives()

void lsst::jointcal::Gtransfo::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::GtransfoPoly.

Definition at line 205 of file Gtransfo.cc.

◆ paramRef() [1/2]

double lsst::jointcal::Gtransfo::paramRef ( const int  i) const
virtualinherited

Reimplemented in lsst::jointcal::GtransfoPoly.

Definition at line 196 of file Gtransfo.cc.

◆ paramRef() [2/2]

double & lsst::jointcal::Gtransfo::paramRef ( const int  i)
virtualinherited

Reimplemented in lsst::jointcal::GtransfoPoly.

Definition at line 201 of file Gtransfo.cc.

◆ roughInverse()

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

Overload the "generic routine" (available for all Gtransfo types.

Reimplemented from lsst::jointcal::Gtransfo.

Definition at line 1652 of file Gtransfo.cc.

◆ setTangentPoint()

void lsst::jointcal::TanRaDec2Pix::setTangentPoint ( Point const &  tangentPoint)

Resets the projection (or tangent) point.

Definition at line 1552 of file Gtransfo.cc.

◆ toAstMap()

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

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

Definition at line 166 of file Gtransfo.h.

◆ 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 133 of file Gtransfo.cc.

◆ transformPosAndErrors()

void lsst::jointcal::TanRaDec2Pix::transformPosAndErrors ( const FatPoint in,
FatPoint out 
) const
virtual

transform with analytical derivatives

Reimplemented from lsst::jointcal::Gtransfo.

Definition at line 1572 of file Gtransfo.cc.

◆ transformStar()

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

allows to write MyTransfo(MyStar)

Definition at line 85 of file Gtransfo.h.

◆ write() [1/2]

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

Definition at line 215 of file Gtransfo.cc.

◆ write() [2/2]

void lsst::jointcal::Gtransfo::write ( std::ostream stream) const
virtualinherited

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

Definition at line 225 of file Gtransfo.cc.


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