lsst.jointcal g99855d9996+3156753ef5
Loading...
Searching...
No Matches
Public Member Functions | List of all members
lsst::jointcal::AstrometryTransformIdentity Class Reference

A do-nothing transformation. It anyway has dummy routines to mimick a AstrometryTransform. More...

#include <AstrometryTransform.h>

Inheritance diagram for lsst::jointcal::AstrometryTransformIdentity:
lsst::jointcal::AstrometryTransform

Public Member Functions

 AstrometryTransformIdentity ()=default
 constructor.
 
void apply (const double xIn, const double yIn, double &xOut, double &yOut) const override
 xOut = xIn; yOut = yIn !
 
double fit (StarMatchList const &starMatchList) override
 fits a transform to a std::list of Point pairs (p1,p2, the Point fields in StarMatch).
 
std::unique_ptr< AstrometryTransformcomposeAndReduce (AstrometryTransform const &right) const override
 Return a reduced composition of newTransform = this(right()), or nullptr if it cannot be reduced.
 
void print (std::ostream &out) const override
 prints the transform coefficients to stream.
 
std::size_t getNpar () const override
 returns the number of parameters (to compute chi2's)
 
std::unique_ptr< AstrometryTransformclone () const override
 returns a copy (allocated by new) of the transformation.
 
void computeDerivative (Point const &where, AstrometryTransformLinear &derivative, double step=0.01) const override
 Computes the local Derivative of a transform, w.r.t.
 
virtual AstrometryTransformLinear linearApproximation (Point const &where, double step=0.01) const override
 linear approximation.
 
std::shared_ptr< ast::MappingtoAstMap (jointcal::Frame const &domain) const override
 Create an equivalent AST mapping for this transformation, including an analytic inverse if possible.
 
void write (std::ostream &s) const override
 
void read (std::istream &s)
 
void apply (Point const &in, Point &out) const
 applies the tranfo to in and writes into out. Is indeed virtual.
 
Point apply (Point const &in) const
 All these apply(..) shadow the virtual one in derived classes, unless one writes "using AstrometryTransform::apply".
 
Frame apply (Frame const &inputframe, bool inscribed) const
 Transform a bounding box, taking either the inscribed or circumscribed box.
 
std::string __str__ () const
 
void transformStar (FatPoint &in) const
 
virtual double getJacobian (Point const &point) const
 returns the local jacobian.
 
virtual double getJacobian (double x, double y) const
 returns the local jacobian.
 
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))
 
virtual std::unique_ptr< AstrometryTransforminverseTransform (double precision, const Frame &region) const
 returns an inverse transform. Numerical if not overloaded.
 
void getParams (double *params) const
 params should be at least Npar() long
 
void offsetParams (Eigen::VectorXd const &delta)
 
virtual double paramRef (Eigen::Index i) const
 
virtual doubleparamRef (Eigen::Index i)
 
virtual void paramDerivatives (Point const &where, double *dx, double *dy) const
 Derivative w.r.t parameters.
 
virtual std::unique_ptr< AstrometryTransformroughInverse (const Frame &region) const
 Rough inverse.
 
void write (const std::string &fileName) const
 

Detailed Description

A do-nothing transformation. It anyway has dummy routines to mimick a AstrometryTransform.

Definition at line 219 of file AstrometryTransform.h.

Constructor & Destructor Documentation

◆ AstrometryTransformIdentity()

lsst::jointcal::AstrometryTransformIdentity::AstrometryTransformIdentity ( )
default

constructor.

Member Function Documentation

◆ __str__()

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

Definition at line 94 of file AstrometryTransform.h.

◆ apply() [1/4]

void lsst::jointcal::AstrometryTransformIdentity::apply ( const double xIn,
const double yIn,
double & xOut,
double & yOut ) const
inlineoverridevirtual

xOut = xIn; yOut = yIn !

Implements lsst::jointcal::AstrometryTransform.

Definition at line 225 of file AstrometryTransform.h.

◆ apply() [2/4]

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

◆ apply() [3/4]

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

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.

◆ clone()

std::unique_ptr< AstrometryTransform > lsst::jointcal::AstrometryTransformIdentity::clone ( ) const
inlineoverridevirtual

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

Implements lsst::jointcal::AstrometryTransform.

Definition at line 244 of file AstrometryTransform.h.

◆ composeAndReduce()

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

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 from lsst::jointcal::AstrometryTransform.

Definition at line 236 of file AstrometryTransform.h.

◆ computeDerivative()

void lsst::jointcal::AstrometryTransformIdentity::computeDerivative ( Point const & where,
AstrometryTransformLinear & derivative,
double step = 0.01 ) const
overridevirtual

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 from lsst::jointcal::AstrometryTransform.

Definition at line 440 of file AstrometryTransform.cc.

◆ fit()

double lsst::jointcal::AstrometryTransformIdentity::fit ( StarMatchList const & starMatchList)
inlineoverridevirtual

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

Implements lsst::jointcal::AstrometryTransform.

Definition at line 230 of file AstrometryTransform.h.

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

◆ getNpar()

std::size_t lsst::jointcal::AstrometryTransformIdentity::getNpar ( ) const
inlineoverridevirtual

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

Reimplemented from lsst::jointcal::AstrometryTransform.

Definition at line 242 of file AstrometryTransform.h.

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

◆ 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::AstrometryTransformIdentity::linearApproximation ( Point const & where,
double step = 0.01 ) const
overridevirtual

linear approximation.

Reimplemented from lsst::jointcal::AstrometryTransform.

Definition at line 445 of file AstrometryTransform.cc.

◆ offsetParams()

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

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

◆ print()

void lsst::jointcal::AstrometryTransformIdentity::print ( std::ostream & out) const
inlineoverridevirtual

prints the transform coefficients to stream.

Implements lsst::jointcal::AstrometryTransform.

Definition at line 240 of file AstrometryTransform.h.

◆ read()

void lsst::jointcal::AstrometryTransformIdentity::read ( std::istream & s)

Definition at line 459 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::AstrometryTransformInverse, lsst::jointcal::TanPixelToRaDec, and lsst::jointcal::TanRaDecToPixel.

Definition at line 196 of file AstrometryTransform.cc.

◆ toAstMap()

std::shared_ptr< ast::Mapping > lsst::jointcal::AstrometryTransformIdentity::toAstMap ( jointcal::Frame const & domain) const
overridevirtual

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 from lsst::jointcal::AstrometryTransform.

Definition at line 451 of file AstrometryTransform.cc.

◆ 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::AstrometryTransformIdentity::write ( std::ostream & s) const
overridevirtual

Reimplemented from lsst::jointcal::AstrometryTransform.

Definition at line 455 of file AstrometryTransform.cc.


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