lsst.jointcal  19.0.0-11-g2ce9f25+3
Public Member Functions | Protected Attributes | List of all members
lsst::jointcal::TanSipPixelToRaDec Class Reference

Implements the (forward) SIP distorsion scheme. More...

#include <AstrometryTransform.h>

Inheritance diagram for lsst::jointcal::TanSipPixelToRaDec:
lsst::jointcal::BaseTanWcs lsst::jointcal::AstrometryTransform

Public Member Functions

 TanSipPixelToRaDec (AstrometryTransformLinear const &pixToTan, Point const &tangentPoint, const AstrometryTransformPolynomial *corrections=nullptr)
 pixToTan describes the transform from pix to tangent plane (degrees). More...
 
AstrometryTransformPolynomial getPixelToTangentPlane () const
 the transformation from pixels to tangent plane (degrees) More...
 
virtual void pixToTangentPlane (double xPixel, double yPixel, double &xTangentPlane, double &yTangentPlane) const
 transforms from pixel space to tangent plane (degrees) More...
 
 TanSipPixelToRaDec ()
 
std::unique_ptr< AstrometryTransforminverseTransform (const double precision, const Frame &region) const
 Inverse transform: returns a TanRaDecToPixel if there are no corrections, or the iterative solver if there are. More...
 
std::unique_ptr< AstrometryTransformclone () const
 returns a copy (allocated by new) of the transformation. More...
 
void print (std::ostream &out) const
 prints the transform coefficients to stream. More...
 
double fit (StarMatchList const &starMatchList)
 Not implemented yet, because we do it otherwise. More...
 
void apply (const double xIn, const double yIn, double &xOut, double &yOut) const
 Transform pixels to ICRS RA, Dec in degrees. 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...
 
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...
 
Point getTangentPoint () const
 Get the sky origin (CRVAL in FITS WCS terminology) in degrees. More...
 
AstrometryTransformLinear getLinPart () const
 The Linear part (corresponding to CD's and CRPIX's) More...
 
const AstrometryTransformPolynomialgetCorr () const
 Get a non-owning pointer to the correction transform polynomial. More...
 
void setCorrections (std::unique_ptr< AstrometryTransformPolynomial > 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...
 
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::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
 

Protected Attributes

AstrometryTransformLinear linPixelToTan
 
std::unique_ptr< AstrometryTransformPolynomialcorr
 
double ra0
 
double dec0
 
double cos0
 
double sin0
 

Detailed Description

Implements the (forward) SIP distorsion scheme.

Definition at line 672 of file AstrometryTransform.h.

Constructor & Destructor Documentation

◆ TanSipPixelToRaDec() [1/2]

lsst::jointcal::TanSipPixelToRaDec::TanSipPixelToRaDec ( AstrometryTransformLinear const &  pixToTan,
Point const &  tangentPoint,
const AstrometryTransformPolynomial corrections = nullptr 
)

pixToTan describes the transform from pix to tangent plane (degrees).

TangentPoint in degrees. Corrections are applied before Lin.

Definition at line 1589 of file AstrometryTransform.cc.

◆ TanSipPixelToRaDec() [2/2]

lsst::jointcal::TanSipPixelToRaDec::TanSipPixelToRaDec ( )

Definition at line 1594 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/8]

void lsst::jointcal::BaseTanWcs::apply ( const double  xIn,
const double  yIn,
double &  xOut,
double &  yOut 
) const
virtualinherited

Transform pixels to ICRS RA, Dec in degrees.

Implements lsst::jointcal::AstrometryTransform.

Definition at line 1426 of file AstrometryTransform.cc.

◆ apply() [2/8]

virtual void lsst::jointcal::AstrometryTransform::apply
inherited

◆ 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
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 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
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() [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
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::TanSipPixelToRaDec::clone ( ) const
virtual

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

Implements lsst::jointcal::AstrometryTransform.

Definition at line 1630 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::TanSipPixelToRaDec::fit ( StarMatchList const &  starMatchList)
virtual

Not implemented yet, because we do it otherwise.

Implements lsst::jointcal::AstrometryTransform.

Definition at line 1644 of file AstrometryTransform.cc.

◆ getCorr()

const AstrometryTransformPolynomial* lsst::jointcal::BaseTanWcs::getCorr ( ) const
inlineinherited

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

Definition at line 595 of file AstrometryTransform.h.

◆ getCrPix()

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

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

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

◆ getLinPart()

AstrometryTransformLinear lsst::jointcal::BaseTanWcs::getLinPart ( ) const
inherited

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

Definition at line 1454 of file AstrometryTransform.cc.

◆ 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.

◆ getPixelToTangentPlane()

AstrometryTransformPolynomial lsst::jointcal::TanSipPixelToRaDec::getPixelToTangentPlane ( ) const
virtual

the transformation from pixels to tangent plane (degrees)

Implements lsst::jointcal::BaseTanWcs.

Definition at line 1612 of file AstrometryTransform.cc.

◆ getTangentPoint()

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

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

Definition at line 1452 of file AstrometryTransform.cc.

◆ inverseTransform()

std::unique_ptr< AstrometryTransform > lsst::jointcal::TanSipPixelToRaDec::inverseTransform ( const double  precision,
const Frame region 
) const
virtual

Inverse transform: returns a TanRaDecToPixel if there are no corrections, or the iterative solver if there are.

Reimplemented from lsst::jointcal::AstrometryTransform.

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

◆ pixToTangentPlane()

void lsst::jointcal::TanSipPixelToRaDec::pixToTangentPlane ( double  xPixel,
double  yPixel,
double &  xTangentPlane,
double &  yTangentPlane 
) const
virtual

transforms from pixel space to tangent plane (degrees)

Implements lsst::jointcal::BaseTanWcs.

Definition at line 1619 of file AstrometryTransform.cc.

◆ print()

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

prints the transform coefficients to stream.

Implements lsst::jointcal::AstrometryTransform.

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

◆ setCorrections()

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

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

Definition at line 1456 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

Member Data Documentation

◆ corr

std::unique_ptr<AstrometryTransformPolynomial> lsst::jointcal::BaseTanWcs::corr
protectedinherited

Definition at line 616 of file AstrometryTransform.h.

◆ cos0

double lsst::jointcal::BaseTanWcs::cos0
protectedinherited

Definition at line 618 of file AstrometryTransform.h.

◆ dec0

double lsst::jointcal::BaseTanWcs::dec0
protectedinherited

Definition at line 617 of file AstrometryTransform.h.

◆ linPixelToTan

AstrometryTransformLinear lsst::jointcal::BaseTanWcs::linPixelToTan
protectedinherited

Definition at line 614 of file AstrometryTransform.h.

◆ ra0

double lsst::jointcal::BaseTanWcs::ra0
protectedinherited

Definition at line 617 of file AstrometryTransform.h.

◆ sin0

double lsst::jointcal::BaseTanWcs::sin0
protectedinherited

Definition at line 618 of file AstrometryTransform.h.


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