lsst.jointcal  15.0-17-g076ea75+5
Public Member Functions | List of all members
lsst::jointcal::GtransfoIdentity Class Reference

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

#include <Gtransfo.h>

Inheritance diagram for lsst::jointcal::GtransfoIdentity:
lsst::jointcal::Gtransfo

Public Member Functions

 GtransfoIdentity ()
 constructor. More...
 
void apply (const double xIn, const double yIn, double &xOut, double &yOut) const override
 xOut = xIn; yOut = yIn ! More...
 
double fit (StarMatchList const &starMatchList) override
 fits a transfo to a std::list of Point pairs (p1,p2, the Point fields in StarMatch). More...
 
std::unique_ptr< GtransfocomposeAndReduce (Gtransfo const &right) const override
 Return a reduced composition of newTransfo = this(right()), or nullptr if it cannot be reduced. More...
 
void dump (std::ostream &stream=std::cout) const override
 dumps the transfo coefficients to stream. More...
 
int getNpar () const override
 returns the number of parameters (to compute chi2's) More...
 
std::unique_ptr< Gtransfoclone () const override
 returns a copy (allocated by new) of the transformation. More...
 
void computeDerivative (Point const &where, GtransfoLin &derivative, const double step=0.01) const override
 Computes the local Derivative of a transfo, w.r.t. More...
 
virtual GtransfoLin linearApproximation (Point const &where, const double step=0.01) const override
 linear approximation. More...
 
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. More...
 
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. 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 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...
 
void write (const std::string &fileName) const
 

Detailed Description

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

Definition at line 196 of file Gtransfo.h.

Constructor & Destructor Documentation

◆ GtransfoIdentity()

lsst::jointcal::GtransfoIdentity::GtransfoIdentity ( )
inline

constructor.

Definition at line 199 of file Gtransfo.h.

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::GtransfoIdentity::apply ( const double  xIn,
const double  yIn,
double &  xOut,
double &  yOut 
) const
inlineoverridevirtual

xOut = xIn; yOut = yIn !

Implements lsst::jointcal::Gtransfo.

Definition at line 202 of file Gtransfo.h.

◆ clone()

std::unique_ptr<Gtransfo> lsst::jointcal::GtransfoIdentity::clone ( ) const
inlineoverridevirtual

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

Implements lsst::jointcal::Gtransfo.

Definition at line 219 of file Gtransfo.h.

◆ composeAndReduce()

std::unique_ptr<Gtransfo> lsst::jointcal::GtransfoIdentity::composeAndReduce ( Gtransfo const &  right) const
inlineoverridevirtual

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

Definition at line 213 of file Gtransfo.h.

◆ computeDerivative()

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

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

Definition at line 396 of file Gtransfo.cc.

◆ dump()

void lsst::jointcal::GtransfoIdentity::dump ( std::ostream stream = std::cout) const
inlineoverridevirtual

dumps the transfo coefficients to stream.

Implements lsst::jointcal::Gtransfo.

Definition at line 215 of file Gtransfo.h.

◆ fit()

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

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 207 of file Gtransfo.h.

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

◆ getNpar()

int lsst::jointcal::GtransfoIdentity::getNpar ( ) const
inlineoverridevirtual

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

Reimplemented from lsst::jointcal::Gtransfo.

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

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

linear approximation.

Reimplemented from lsst::jointcal::Gtransfo.

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

◆ read()

void lsst::jointcal::GtransfoIdentity::read ( std::istream s)

Definition at line 411 of file Gtransfo.cc.

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

◆ toAstMap()

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

Reimplemented from lsst::jointcal::Gtransfo.

Definition at line 405 of file Gtransfo.cc.

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

Reimplemented from lsst::jointcal::Gtransfo.

Definition at line 409 of file Gtransfo.cc.


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