lsst.jointcal g47fe537ac6+ccb7ee848a
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
lsst::jointcal::BaseTanWcs Class Referenceabstract

#include <AstrometryTransform.h>

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

Public Member Functions

 BaseTanWcs (AstrometryTransformLinear const &pixToTan, Point const &tangentPoint, const AstrometryTransformPolynomial *corrections=nullptr)
 
 BaseTanWcs (const BaseTanWcs &original)
 
BaseTanWcsoperator= (const BaseTanWcs &original)
 
void apply (double xIn, 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...
 
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...
 
virtual AstrometryTransformPolynomial getPixelToTangentPlane () 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 pixToTangentPlane (double xPixel, double yPixel, double &xTangentPlane, double &yTangentPlane) const =0
 Transform from pixels to tangent plane (degrees) More...
 
 ~BaseTanWcs ()
 
virtual void apply (double xIn, 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__ () const
 
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 double getJacobian (double x, double y) 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 void computeDerivative (Point const &where, AstrometryTransformLinear &derivative, double step=0.01) const
 Computes the local Derivative of a transform, w.r.t. More...
 
virtual AstrometryTransformLinear linearApproximation (Point const &where, 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 (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 i) const
 
virtual double & paramRef (Eigen::Index 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

Definition at line 574 of file AstrometryTransform.h.

Constructor & Destructor Documentation

◆ BaseTanWcs() [1/2]

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

Definition at line 1394 of file AstrometryTransform.cc.

◆ BaseTanWcs() [2/2]

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

Definition at line 1410 of file AstrometryTransform.cc.

◆ ~BaseTanWcs()

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

Member Function Documentation

◆ __str__()

std::string lsst::jointcal::AstrometryTransform::__str__ ( ) const
inlineinherited

Definition at line 94 of file AstrometryTransform.h.

◆ apply() [1/5]

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

Transform pixels to ICRS RA, Dec in degrees.

Implements lsst::jointcal::AstrometryTransform.

Reimplemented in lsst::jointcal::TanPixelToRaDec.

Definition at line 1426 of file AstrometryTransform.cc.

◆ apply() [2/5]

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

◆ apply() [3/5]

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 89 of file AstrometryTransform.cc.

◆ apply() [4/5]

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

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 virtualinherited

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

Definition at line 95 of file AstrometryTransform.cc.

◆ computeDerivative()

void lsst::jointcal::AstrometryTransform::computeDerivative ( Point const &  where,
AstrometryTransformLinear derivative,
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::AstrometryTransformIdentity, lsst::jointcal::AstrometryTransformPolynomial, and lsst::jointcal::AstrometryTransformLinear.

Definition at line 119 of file AstrometryTransform.cc.

◆ fit()

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

◆ getCorr()

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

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

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 ( double  x,
double  y 
) const
virtualinherited

returns the local jacobian.

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

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 217 of file AstrometryTransform.cc.

◆ getPixelToTangentPlane()

virtual AstrometryTransformPolynomial lsst::jointcal::BaseTanWcs::getPixelToTangentPlane ( ) 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::TanPixelToRaDec, and lsst::jointcal::TanSipPixelToRaDec.

◆ getTangentPoint()

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

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::AstrometryTransform::inverseTransform ( double  precision,
const Frame region 
) const
virtualinherited

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::TanPixelToRaDec, lsst::jointcal::TanSipPixelToRaDec, lsst::jointcal::TanRaDecToPixel, lsst::jointcal::AstrometryTransformLinear, and lsst::jointcal::AstrometryTransformInverse.

Definition at line 304 of file AstrometryTransform.cc.

◆ linearApproximation()

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

linear (local) approximation.

Reimplemented in lsst::jointcal::AstrometryTransformIdentity, and lsst::jointcal::AstrometryTransformLinear.

Definition at line 137 of file AstrometryTransform.cc.

◆ offsetParams()

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

Definition at line 222 of file AstrometryTransform.cc.

◆ operator=()

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

Definition at line 1415 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 237 of file AstrometryTransform.cc.

◆ paramRef() [1/2]

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

Reimplemented in lsst::jointcal::AstrometryTransformPolynomial.

Definition at line 232 of file AstrometryTransform.cc.

◆ paramRef() [2/2]

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

Reimplemented in lsst::jointcal::AstrometryTransformPolynomial.

Definition at line 227 of file AstrometryTransform.cc.

◆ pixToTangentPlane()

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

Transform from pixels to tangent plane (degrees)

Implemented in lsst::jointcal::TanPixelToRaDec, and lsst::jointcal::TanSipPixelToRaDec.

◆ print()

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

◆ 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::AstrometryTransformInverse, lsst::jointcal::TanPixelToRaDec, and lsst::jointcal::TanRaDecToPixel.

Definition at line 196 of file AstrometryTransform.cc.

◆ setCorrections()

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

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

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 163 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 247 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
protected

Definition at line 616 of file AstrometryTransform.h.

◆ cos0

double lsst::jointcal::BaseTanWcs::cos0 {}
protected

Definition at line 618 of file AstrometryTransform.h.

◆ dec0

double lsst::jointcal::BaseTanWcs::dec0 {}
protected

Definition at line 617 of file AstrometryTransform.h.

◆ linPixelToTan

AstrometryTransformLinear lsst::jointcal::BaseTanWcs::linPixelToTan
protected

Definition at line 614 of file AstrometryTransform.h.

◆ ra0

double lsst::jointcal::BaseTanWcs::ra0 {}
protected

Definition at line 617 of file AstrometryTransform.h.

◆ sin0

double lsst::jointcal::BaseTanWcs::sin0 {}
protected

Definition at line 618 of file AstrometryTransform.h.


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