LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
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 ()
 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 transform to a std::list of Point pairs (p1,p2, the Point fields in StarMatch). More...
 
std::unique_ptr< AstrometryTransformcomposeAndReduce (AstrometryTransform const &right) const override
 Return a reduced composition of newTransform = this(right()), or nullptr if it cannot be reduced. More...
 
void print (std::ostream &out) const override
 prints the transform coefficients to stream. More...
 
std::size_t getNpar () const override
 returns the number of parameters (to compute chi2's) More...
 
std::unique_ptr< AstrometryTransformclone () const override
 returns a copy (allocated by new) of the transformation. More...
 
void computeDerivative (Point const &where, AstrometryTransformLinear &derivative, const double step=0.01) const override
 Computes the local Derivative of a transform, w.r.t. More...
 
virtual AstrometryTransformLinear 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 AstrometryTransform::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
 
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< AstrometryTransforminverseTransform (const 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 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...
 
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 ( )
inline

constructor.

Definition at line 222 of file AstrometryTransform.h.

222 {}

Member Function Documentation

◆ __str__()

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

Definition at line 94 of file AstrometryTransform.h.

94  {
96  print(s);
97  return s.str();
98  }
virtual void print(std::ostream &out) const =0
prints the transform coefficients to stream.
T str(T... args)

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

225  {
226  xOut = xIn;
227  yOut = yIn;
228  } // to speed up

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

76  {
77  // 2 opposite corners
78  double xtmin1, xtmax1, ytmin1, ytmax1;
79  apply(inputframe.xMin, inputframe.yMin, xtmin1, ytmin1);
80  apply(inputframe.xMax, inputframe.yMax, xtmax1, ytmax1);
81  Frame fr1(std::min(xtmin1, xtmax1), std::min(ytmin1, ytmax1), std::max(xtmin1, xtmax1),
82  std::max(ytmin1, ytmax1));
83  // 2 other corners
84  double xtmin2, xtmax2, ytmin2, ytmax2;
85  apply(inputframe.xMin, inputframe.yMax, xtmin2, ytmax2);
86  apply(inputframe.xMax, inputframe.yMin, xtmax2, ytmin2);
87  Frame fr2(std::min(xtmin2, xtmax2), std::min(ytmin2, ytmax2), std::max(xtmin2, xtmax2),
88  std::max(ytmin2, ytmax2));
89 
90  if (inscribed) return fr1 * fr2;
91  return fr1 + fr2;
92 }
virtual void apply(const double xIn, const double yIn, double &xOut, double &yOut) const =0
T max(T... args)
T min(T... args)

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

75  {
76  double xout, yout;
77  apply(in.x, in.y, xout, yout);
78  return Point(xout, yout);
79  }

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

71 { apply(in.x, in.y, out.x, out.y); }

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

236  {
237  return right.clone();
238  }
T right(T... args)

◆ computeDerivative()

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

440  {
441  derivative = AstrometryTransformLinear();
442 }

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

230  {
231  throw pexExcept::TypeError(
232  "AstrometryTransformIdentity is the identity transformation: it cannot be fit to anything.");
233  }
Reports errors from accepting an object of an unexpected or inappropriate type.
Definition: Runtime.h:167

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

99  {
100  double x2, y2;
101  double eps = x * 0.01;
102  if (eps == 0) eps = 0.01;
103  apply(x, y, x2, y2);
104  double dxdx, dydx;
105  apply(x + eps, y, dxdx, dydx);
106  dxdx -= x2;
107  dydx -= y2;
108  double dxdy, dydy;
109  apply(x, y + eps, dxdy, dydy);
110  dxdy -= x2;
111  dydy -= y2;
112  return ((dxdx * dydy - dxdy * dydx) / (eps * eps));
113 }
double x
int y
Definition: SpanSet.cc:48

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

110 { return getJacobian(point.x, point.y); }
virtual double getJacobian(Point const &point) const
returns the local jacobian.

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

242 { return 0; }

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

216  {
217  std::size_t npar = getNpar();
218  for (std::size_t i = 0; i < npar; ++i) params[i] = paramRef(i);
219 }
virtual double paramRef(Eigen::Index const i) const
virtual std::size_t getNpar() const
returns the number of parameters (to compute chi2's)

◆ inverseTransform()

std::unique_ptr< AstrometryTransform > lsst::jointcal::AstrometryTransform::inverseTransform ( const 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::AstrometryTransformInverse, lsst::jointcal::AstrometryTransformLinear, lsst::jointcal::TanRaDecToPixel, lsst::jointcal::TanSipPixelToRaDec, and lsst::jointcal::TanPixelToRaDec.

Definition at line 303 of file AstrometryTransform.cc.

304  {
305  return std::unique_ptr<AstrometryTransform>(new AstrometryTransformInverse(this, precision, region));
306 }

◆ linearApproximation()

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

linear approximation.

Reimplemented from lsst::jointcal::AstrometryTransform.

Definition at line 444 of file AstrometryTransform.cc.

445  {
446  AstrometryTransformLinear result;
447  return result; // rely on default AstrometryTransformlin constructor;
448 }
py::object result
Definition: _schema.cc:429

◆ offsetParams()

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

Definition at line 221 of file AstrometryTransform.cc.

221  {
222  std::size_t npar = getNpar();
223  for (std::size_t i = 0; i < npar; ++i) paramRef(i) += delta[i];
224 }

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

236  {
237  throw LSST_EXCEPT(pex::exceptions::InvalidParameterError,
238  "AstrometryTransform::paramDerivatives() should never be called ");
239 }
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48

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

231  {
232  throw LSST_EXCEPT(pex::exceptions::InvalidParameterError,
233  "AstrometryTransform::paramRef should never be called ");
234 }

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

226  {
227  throw LSST_EXCEPT(pex::exceptions::InvalidParameterError,
228  std::string("AstrometryTransform::paramRef should never be called "));
229 }

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

240 { out << "x' = x\ny' = y" << std::endl; }
T endl(T... args)

◆ read()

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

Definition at line 458 of file AstrometryTransform.cc.

458  {
459  int format;
460  stream >> format;
461  if (format != 1)
462  throw LSST_EXCEPT(pex::exceptions::InvalidParameterError,
463  " AstrometryTransformIdentity::read : format is not 1 ");
464 }
def format(config, name=None, writeSourceLine=True, prefix="", verbose=False)
Definition: history.py:174

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

195  {
196  // "in" and "out" refer to the inverse direction.
197  Point centerOut = region.getCenter();
198  Point centerIn = apply(centerOut);
199  AstrometryTransformLinear der;
200  computeDerivative(centerOut, der, std::sqrt(region.getArea()) / 5.);
201  der = der.inverted();
202  der = AstrometryTransformLinearShift(centerOut.x, centerOut.y) * der *
203  AstrometryTransformLinearShift(-centerIn.x, -centerIn.y);
204  return std::unique_ptr<AstrometryTransform>(new AstrometryTransformLinear(der));
205 }
virtual void computeDerivative(Point const &where, AstrometryTransformLinear &derivative, const double step=0.01) const
Computes the local Derivative of a transform, w.r.t.
T sqrt(T... args)

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

450  {
451  return std::make_shared<ast::UnitMap>(2); // a AstrometryTransformIdentity is identically ast::UnitMap(2)
452 }

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

162  {
163  AstrometryTransformLinear der;
164  computeDerivative(where, der, 0.01);
165  double a11 = der.A11();
166  double a22 = der.A22();
167  double a21 = der.A21();
168  double a12 = der.A12();
169 
170  /* (a11 a12) (vxx vxy)
171  M = ( ) and V = ( )
172  (a21 a22) (xvy vyy)
173 
174  Vxx = Vin[0], vyy = Vin[1], Vxy = Vin[2];
175  we want to compute M*V*tp(M)
176  A lin alg light package would be perfect...
177  */
178  int xx = 0;
179  int yy = 1;
180  int xy = 2;
181  // M*V :
182 
183  double b11 = a11 * vIn[xx] + a12 * vIn[xy];
184  double b22 = a21 * vIn[xy] + a22 * vIn[yy];
185  double b12 = a11 * vIn[xy] + a12 * vIn[yy];
186  double b21 = a21 * vIn[xx] + a22 * vIn[xy];
187 
188  // (M*V) * tp(M)
189 
190  vOut[xx] = b11 * a11 + b12 * a12;
191  vOut[xy] = b11 * a21 + b12 * a22;
192  vOut[yy] = b21 * a21 + b22 * a22;
193 }

◆ transformPosAndErrors()

void lsst::jointcal::AstrometryTransform::transformPosAndErrors ( const FatPoint in,
FatPoint out 
) const
virtualinherited

Reimplemented in lsst::jointcal::AstrometryTransformPolynomial, and lsst::jointcal::TanRaDecToPixel.

Definition at line 145 of file AstrometryTransform.cc.

145  {
146  FatPoint res; // in case in and out are the same address...
147  res = apply(in);
148  AstrometryTransformLinear der;
149  // could save a call here, since Derivative needs the transform of where that we already have
150  // 0.01 may not be a very good idea in all cases. May be we should provide a way of altering that.
151  computeDerivative(in, der, 0.01);
152  double a11 = der.A11();
153  double a22 = der.A22();
154  double a21 = der.A21();
155  double a12 = der.A12();
156  res.vx = a11 * (a11 * in.vx + 2 * a12 * in.vxy) + a12 * a12 * in.vy;
157  res.vy = a21 * a21 * in.vx + a22 * a22 * in.vy + 2. * a21 * a22 * in.vxy;
158  res.vxy = a21 * a11 * in.vx + a22 * a12 * in.vy + (a21 * a12 + a11 * a22) * in.vxy;
159  out = res;
160 }

◆ transformStar()

void lsst::jointcal::AstrometryTransform::transformStar ( FatPoint in) const
inlineinherited

Definition at line 107 of file AstrometryTransform.h.

107 { transformPosAndErrors(in, in); }
virtual void transformPosAndErrors(const FatPoint &in, FatPoint &out) const

◆ write() [1/2]

void lsst::jointcal::AstrometryTransform::write ( const std::string fileName) const
inherited

Definition at line 246 of file AstrometryTransform.cc.

246  {
247  ofstream s(fileName.c_str());
248  write(s);
249  bool ok = !s.fail();
250  s.close();
251  if (!ok)
252  throw LSST_EXCEPT(pex::exceptions::InvalidParameterError,
253  "AstrometryTransform::write, something went wrong for file " + fileName);
254 }
T c_str(T... args)
void write(const std::string &fileName) const

◆ write() [2/2]

void lsst::jointcal::AstrometryTransformIdentity::write ( std::ostream s) const
overridevirtual

Reimplemented from lsst::jointcal::AstrometryTransform.

Definition at line 454 of file AstrometryTransform.cc.

454  {
455  stream << "AstrometryTransformIdentity 1" << endl;
456 }

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