lsst.jointcal  16.0-18-gdf247dd+1
Public Member Functions | Protected Attributes | List of all members
lsst::jointcal::BaseTanWcs Class Referenceabstract

#include <Gtransfo.h>

Inheritance diagram for lsst::jointcal::BaseTanWcs:
lsst::jointcal::Gtransfo lsst::jointcal::TanPix2RaDec lsst::jointcal::TanSipPix2RaDec

Public Member Functions

 BaseTanWcs (GtransfoLin const &pix2Tan, Point const &tangentPoint, const GtransfoPoly *corrections=nullptr)
 
 BaseTanWcs (const BaseTanWcs &original)
 
void operator= (const BaseTanWcs &original)
 
void apply (const double xIn, const double yIn, double &xOut, double &yOut) const
 Transform pixels to ICRS RA, Dec in degrees. More...
 
Point getTangentPoint () const
 Get the sky origin (CRVAL in FITS WCS terminology) in degrees. More...
 
GtransfoLin getLinPart () const
 The Linear part (corresponding to CD's and CRPIX's) More...
 
const GtransfoPolygetCorr () const
 Get a non-owning pointer to the correction transform polynomial. More...
 
void setCorrections (std::unique_ptr< GtransfoPoly > corrections)
 Assign the correction polynomial (what it means is left to derived classes) More...
 
Point getCrPix () const
 Get the pixel origin of the WCS (CRPIX in FITS WCS terminology, but zero-based) More...
 
virtual GtransfoPoly getPix2TangentPlane () const =0
 Get a transform from pixels to tangent plane (degrees) This is a linear transform plus the effects of the correction. More...
 
virtual void pix2TP (double xPixel, double yPixel, double &xTangentPlane, double &yTangentPlane) const =0
 Transform from pixels to tangent plane (degrees) More...
 
 ~BaseTanWcs ()
 
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...
 
virtual void dump (std::ostream &stream=std::cout) const =0
 dumps the transfo coefficients to stream. More...
 
std::string __str__ ()
 
virtual double fit (StarMatchList const &starMatchList)=0
 fits a transfo to a std::list of Point pairs (p1,p2, the Point fields in StarMatch). More...
 
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< Gtransfoclone () const =0
 returns a copy (allocated by new) of the transformation. 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 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< GtransfoinverseTransfo (const double precision, const Frame &region) const
 returns an inverse transfo. 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 (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 std::unique_ptr< GtransforoughInverse (const Frame &region) const
 Rough inverse. 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
 

Protected Attributes

GtransfoLin linPix2Tan
 
std::unique_ptr< GtransfoPolycorr
 
double ra0
 
double dec0
 
double cos0
 
double sin0
 

Detailed Description

Definition at line 528 of file Gtransfo.h.

Constructor & Destructor Documentation

◆ BaseTanWcs() [1/2]

lsst::jointcal::BaseTanWcs::BaseTanWcs ( GtransfoLin const &  pix2Tan,
Point const &  tangentPoint,
const GtransfoPoly corrections = nullptr 
)

Definition at line 1296 of file Gtransfo.cc.

◆ BaseTanWcs() [2/2]

lsst::jointcal::BaseTanWcs::BaseTanWcs ( const BaseTanWcs original)

Definition at line 1312 of file Gtransfo.cc.

◆ ~BaseTanWcs()

lsst::jointcal::BaseTanWcs::~BaseTanWcs ( )

Definition at line 1371 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::BaseTanWcs::apply ( const double  xIn,
const double  yIn,
double &  xOut,
double &  yOut 
) const
virtual

Transform pixels to ICRS RA, Dec in degrees.

Implements lsst::jointcal::Gtransfo.

Definition at line 1327 of file Gtransfo.cc.

◆ clone()

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

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

virtual void lsst::jointcal::Gtransfo::dump ( std::ostream stream = std::cout) const
pure virtualinherited

◆ fit()

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

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.

Implemented in lsst::jointcal::UserTransfo, lsst::jointcal::TanRaDec2Pix, lsst::jointcal::TanSipPix2RaDec, lsst::jointcal::TanPix2RaDec, lsst::jointcal::GtransfoSkyWcs, lsst::jointcal::GtransfoLinRot, lsst::jointcal::GtransfoLinShift, lsst::jointcal::GtransfoComposition, lsst::jointcal::GtransfoPoly, lsst::jointcal::GtransfoInverse, and lsst::jointcal::GtransfoIdentity.

◆ getCorr()

const GtransfoPoly* lsst::jointcal::BaseTanWcs::getCorr ( ) const
inline

Get a non-owning pointer to the correction transform polynomial.

Definition at line 549 of file Gtransfo.h.

◆ getCrPix()

Point lsst::jointcal::BaseTanWcs::getCrPix ( ) const

Get the pixel origin of the WCS (CRPIX in FITS WCS terminology, but zero-based)

Definition at line 1359 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::BaseTanWcs::getLinPart ( ) const

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

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

◆ getPix2TangentPlane()

virtual GtransfoPoly lsst::jointcal::BaseTanWcs::getPix2TangentPlane ( ) const
pure virtual

Get a transform from pixels to tangent plane (degrees) This is a linear transform plus the effects of the correction.

Implemented in lsst::jointcal::TanSipPix2RaDec, and lsst::jointcal::TanPix2RaDec.

◆ getTangentPoint()

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

Get the sky origin (CRVAL in FITS WCS terminology) in degrees.

Definition at line 1353 of file Gtransfo.cc.

◆ inverseTransfo()

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

returns an inverse transfo. Numerical if not overloaded.

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

Reimplemented in lsst::jointcal::TanRaDec2Pix, lsst::jointcal::TanSipPix2RaDec, lsst::jointcal::TanPix2RaDec, lsst::jointcal::GtransfoLin, and lsst::jointcal::GtransfoInverse.

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

◆ operator=()

void lsst::jointcal::BaseTanWcs::operator= ( const BaseTanWcs original)

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

◆ pix2TP()

virtual void lsst::jointcal::BaseTanWcs::pix2TP ( double  xPixel,
double  yPixel,
double &  xTangentPlane,
double &  yTangentPlane 
) const
pure virtual

Transform from pixels to tangent plane (degrees)

Implemented in lsst::jointcal::TanSipPix2RaDec, and lsst::jointcal::TanPix2RaDec.

◆ roughInverse()

std::unique_ptr< Gtransfo > lsst::jointcal::Gtransfo::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::TanRaDec2Pix, lsst::jointcal::TanPix2RaDec, and lsst::jointcal::GtransfoInverse.

Definition at line 166 of file Gtransfo.cc.

◆ setCorrections()

void lsst::jointcal::BaseTanWcs::setCorrections ( std::unique_ptr< GtransfoPoly corrections)

Assign the correction polynomial (what it means is left to derived classes)

Definition at line 1357 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::Gtransfo::transformPosAndErrors ( const FatPoint in,
FatPoint out 
) const
virtualinherited

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

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

Member Data Documentation

◆ corr

std::unique_ptr<GtransfoPoly> lsst::jointcal::BaseTanWcs::corr
protected

Definition at line 569 of file Gtransfo.h.

◆ cos0

double lsst::jointcal::BaseTanWcs::cos0
protected

Definition at line 571 of file Gtransfo.h.

◆ dec0

double lsst::jointcal::BaseTanWcs::dec0
protected

Definition at line 570 of file Gtransfo.h.

◆ linPix2Tan

GtransfoLin lsst::jointcal::BaseTanWcs::linPix2Tan
protected

Definition at line 567 of file Gtransfo.h.

◆ ra0

double lsst::jointcal::BaseTanWcs::ra0
protected

Definition at line 570 of file Gtransfo.h.

◆ sin0

double lsst::jointcal::BaseTanWcs::sin0
protected

Definition at line 571 of file Gtransfo.h.


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