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 | Protected Member Functions | List of all members
lsst::jointcal::FluxTransformChebyshev Class Reference

nth-order 2d Chebyshev photometry transform, times the input flux. More...

#include <PhotometryTransform.h>

Inheritance diagram for lsst::jointcal::FluxTransformChebyshev:
lsst::jointcal::PhotometryTransformChebyshev lsst::jointcal::PhotometryTransform

Public Member Functions

 FluxTransformChebyshev (size_t order, geom::Box2D const &bbox)
 
 FluxTransformChebyshev (ndarray::Array< double, 2, 2 > const &coefficients, geom::Box2D const &bbox)
 
double transform (double x, double y, double value) const override
 Return the transform of value at (x,y). More...
 
void computeParameterDerivatives (double x, double y, double value, Eigen::Ref< Eigen::VectorXd > derivatives) const override
 Compute the derivatives with respect to the parameters (i.e. More...
 
std::shared_ptr< PhotometryTransformclone () const override
 return a copy (allocated by new) of the transformation. More...
 
double transformError (double x, double y, double value, double valueErr) const override
 Return the transformed valueErr at Point(x,y). More...
 
double transformError (Point const &in, double value, double valueErr) const
 Return the transformed valueErr at Point(x,y). More...
 
void print (std::ostream &out) const override
 Print the transform coefficients to stream. More...
 
std::size_t getNpar () const override
 Return the number of parameters (used to compute chisq) More...
 
void offsetParams (Eigen::VectorXd const &delta) override
 Offset the parameters by some (negative) amount during fitting. More...
 
ndarray::Array< double, 2, 2 > getCoefficients () const
 Get a copy of the coefficients of the polynomials, as a 2d array (NOTE: layout is [y][x]) More...
 
Eigen::VectorXd getParameters () const override
 Get a copy of the parameters of this model, in the same order as offsetParams. More...
 
ndarray::Size getOrder () const
 
geom::Box2D getBBox () const
 
double mean (geom::Box2D const &bbox) const
 Compute the mean of this tranform on the bbox (default to our bbox). More...
 
double mean () const
 
double integrate (geom::Box2D const &bbox) const
 
double integrate () const
 
double transform (Point const &in, double value) const
 Return the transformed value at Point(x,y). More...
 

Protected Member Functions

double computeChebyshev (double x, double y) const
 Return the value of this polynomial at x,y. More...
 
void computeChebyshevDerivatives (double x, double y, Eigen::Ref< Eigen::VectorXd > derivatives) const
 Set the derivatives of this polynomial at x,y. More...
 

Detailed Description

nth-order 2d Chebyshev photometry transform, times the input flux.

Definition at line 303 of file PhotometryTransform.h.

Constructor & Destructor Documentation

◆ FluxTransformChebyshev() [1/2]

lsst::jointcal::FluxTransformChebyshev::FluxTransformChebyshev ( size_t  order,
geom::Box2D const &  bbox 
)
inline

Definition at line 305 of file PhotometryTransform.h.

AmpInfoBoxKey bbox
Definition: Amplifier.cc:117
PhotometryTransformChebyshev(size_t order, geom::Box2D const &bbox, bool identity)
Create a Chebyshev transform with terms up to order in (x*y).
table::Key< int > order

◆ FluxTransformChebyshev() [2/2]

lsst::jointcal::FluxTransformChebyshev::FluxTransformChebyshev ( ndarray::Array< double, 2, 2 > const &  coefficients,
geom::Box2D const &  bbox 
)
inline

Definition at line 308 of file PhotometryTransform.h.

ndarray::Array< double const, 2, 2 > coefficients

Member Function Documentation

◆ clone()

std::shared_ptr<PhotometryTransform> lsst::jointcal::FluxTransformChebyshev::clone ( ) const
inlineoverridevirtual

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

Implements lsst::jointcal::PhotometryTransform.

Definition at line 324 of file PhotometryTransform.h.

324  {
325  return std::make_shared<FluxTransformChebyshev>(getCoefficients(), getBBox());
326  }
ndarray::Array< double, 2, 2 > getCoefficients() const
Get a copy of the coefficients of the polynomials, as a 2d array (NOTE: layout is [y][x])

◆ computeChebyshev()

double lsst::jointcal::PhotometryTransformChebyshev::computeChebyshev ( double  x,
double  y 
) const
protectedinherited

Return the value of this polynomial at x,y.

For use in the sublcass transform() methods.

Definition at line 224 of file PhotometryTransform.cc.

224  {
225  geom::Point2D p = _toChebyshevRange(geom::Point2D(x, y));
226  return evaluateFunction1d(RecursionArrayImitator(_coefficients, p.getX()), p.getY(),
227  _coefficients.getSize<0>());
228 }
int y
Definition: SpanSet.cc:48
double x

◆ computeChebyshevDerivatives()

void lsst::jointcal::PhotometryTransformChebyshev::computeChebyshevDerivatives ( double  x,
double  y,
Eigen::Ref< Eigen::VectorXd >  derivatives 
) const
protectedinherited

Set the derivatives of this polynomial at x,y.

For use in the sublcass computeParameterDerivatives() methods.

Definition at line 230 of file PhotometryTransform.cc.

231  {
232  geom::Point2D p = _toChebyshevRange(geom::Point2D(x, y));
233  // Algorithm: compute all the individual components recursively (since we'll need them anyway),
234  // then combine them into the final answer vectors.
235  Eigen::VectorXd Tnx(_order + 1);
236  Eigen::VectorXd Tmy(_order + 1);
237  Tnx[0] = 1;
238  Tmy[0] = 1;
239  if (_order >= 1) {
240  Tnx[1] = p.getX();
241  Tmy[1] = p.getY();
242  }
243  for (ndarray::Size i = 2; i <= _order; ++i) {
244  Tnx[i] = 2 * p.getX() * Tnx[i - 1] - Tnx[i - 2];
245  Tmy[i] = 2 * p.getY() * Tmy[i - 1] - Tmy[i - 2];
246  }
247 
248  // NOTE: the indexing in this method and offsetParams must be kept consistent!
249  Eigen::VectorXd::Index k = 0;
250  for (ndarray::Size j = 0; j <= _order; ++j) {
251  ndarray::Size const iMax = _order - j; // to save re-computing `i+j <= order` every inner step.
252  for (ndarray::Size i = 0; i <= iMax; ++i, ++k) {
253  derivatives[k] = Tmy[j] * Tnx[i];
254  }
255  }
256 }

◆ computeParameterDerivatives()

void lsst::jointcal::FluxTransformChebyshev::computeParameterDerivatives ( double  x,
double  y,
double  value,
Eigen::Ref< Eigen::VectorXd >  derivatives 
) const
inlineoverridevirtual

Compute the derivatives with respect to the parameters (i.e.

the coefficients).

Parameters
[in]xThe x coordinate to compute at (in the appropriate units for this transform).
[in]yThe y coordinate to compute at (in the appropriate units for this transform).
[in]valueThe instrument flux or magnitude to compute the derivative at.
[out]derivativesThe computed derivatives, in the same order as the deltas in offsetParams.

Implements lsst::jointcal::PhotometryTransform.

Definition at line 317 of file PhotometryTransform.h.

318  {
319  computeChebyshevDerivatives(x, y, derivatives);
320  derivatives *= value;
321  }
double x
void computeChebyshevDerivatives(double x, double y, Eigen::Ref< Eigen::VectorXd > derivatives) const
Set the derivatives of this polynomial at x,y.

◆ getBBox()

geom::Box2D lsst::jointcal::PhotometryTransformChebyshev::getBBox ( ) const
inlineinherited

Definition at line 264 of file PhotometryTransform.h.

264 { return _bbox; }

◆ getCoefficients()

ndarray::Array<double, 2, 2> lsst::jointcal::PhotometryTransformChebyshev::getCoefficients ( ) const
inlineinherited

Get a copy of the coefficients of the polynomials, as a 2d array (NOTE: layout is [y][x])

Definition at line 257 of file PhotometryTransform.h.

257 { return ndarray::copy(_coefficients); }

◆ getNpar()

std::size_t lsst::jointcal::PhotometryTransformChebyshev::getNpar ( ) const
inlineoverridevirtualinherited

Return the number of parameters (used to compute chisq)

Implements lsst::jointcal::PhotometryTransform.

Definition at line 251 of file PhotometryTransform.h.

251 { return _nParameters; }

◆ getOrder()

ndarray::Size lsst::jointcal::PhotometryTransformChebyshev::getOrder ( ) const
inlineinherited

Definition at line 262 of file PhotometryTransform.h.

262 { return _order; }

◆ getParameters()

Eigen::VectorXd lsst::jointcal::PhotometryTransformChebyshev::getParameters ( ) const
overridevirtualinherited

Get a copy of the parameters of this model, in the same order as offsetParams.

Implements lsst::jointcal::PhotometryTransform.

Definition at line 210 of file PhotometryTransform.cc.

210  {
211  Eigen::VectorXd parameters(_nParameters);
212  // NOTE: the indexing in this method and offsetParams must be kept consistent!
213  Eigen::VectorXd::Index k = 0;
214  for (ndarray::Size j = 0; j <= _order; ++j) {
215  ndarray::Size const iMax = _order - j; // to save re-computing `i+j <= order` every inner step.
216  for (ndarray::Size i = 0; i <= iMax; ++i, ++k) {
217  parameters[k] = _coefficients[j][i];
218  }
219  }
220 
221  return parameters;
222 }

◆ integrate() [1/2]

double lsst::jointcal::PhotometryTransformChebyshev::integrate ( ) const
inherited

Definition at line 193 of file PhotometryTransform.cc.

193  {
194  double result = 0;
195  double determinant = _bbox.getArea() / 4.0;
196  for (ndarray::Size j = 0; j < _coefficients.getSize<0>(); j++) {
197  for (ndarray::Size i = 0; i < _coefficients.getSize<1>(); i++) {
198  result += _coefficients[j][i] * integrateTn(i) * integrateTn(j);
199  }
200  }
201  return result * determinant;
202 }
py::object result
Definition: _schema.cc:429
double getArea() const noexcept
1-d interval accessors
Definition: Box.h:531

◆ integrate() [2/2]

double lsst::jointcal::PhotometryTransformChebyshev::integrate ( geom::Box2D const &  bbox) const
inherited

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 181 of file PhotometryTransform.cc.

181  {
182  double result = 0;
183 
184  result += oneIntegral(bbox.getMaxX(), bbox.getMaxY());
185  result += oneIntegral(bbox.getMinX(), bbox.getMinY());
186  result -= oneIntegral(bbox.getMaxX(), bbox.getMinY());
187  result -= oneIntegral(bbox.getMinX(), bbox.getMaxY());
188 
189  // scale factor due to the change of limits in the integral
190  return result / _toChebyshevRange.getLinear().computeDeterminant();
191 }
LinearTransform const & getLinear() const noexcept
double computeDeterminant() const noexcept
Return the determinant of the 2x2 matrix.

◆ mean() [1/2]

double lsst::jointcal::PhotometryTransformChebyshev::mean ( ) const
inherited

Definition at line 208 of file PhotometryTransform.cc.

208 { return integrate() / _bbox.getArea(); }

◆ mean() [2/2]

double lsst::jointcal::PhotometryTransformChebyshev::mean ( geom::Box2D const &  bbox) const
inherited

Compute the mean of this tranform on the bbox (default to our bbox).

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 204 of file PhotometryTransform.cc.

204  {
205  return integrate(bbox) / bbox.getArea();
206 }

◆ offsetParams()

void lsst::jointcal::PhotometryTransformChebyshev::offsetParams ( Eigen::VectorXd const &  delta)
overridevirtualinherited

Offset the parameters by some (negative) amount during fitting.

Equivalent to flatten(parameters) -= delta

Ordering of delta is the same as the ordering of the derivatives returned from computeParameterDerivatives.

Implements lsst::jointcal::PhotometryTransform.

Definition at line 107 of file PhotometryTransform.cc.

107  {
108  // NOTE: the indexing in this method and computeParameterDerivatives must be kept consistent!
109  Eigen::VectorXd::Index k = 0;
110  for (ndarray::Size j = 0; j <= _order; ++j) {
111  ndarray::Size const iMax = _order - j; // to save re-computing `i+j <= order` every inner step.
112  for (ndarray::Size i = 0; i <= iMax; ++i, ++k) {
113  _coefficients[j][i] -= delta[k];
114  }
115  }
116 }

◆ print()

void lsst::jointcal::PhotometryTransformChebyshev::print ( std::ostream out) const
inlineoverridevirtualinherited

Print the transform coefficients to stream.

Implements lsst::jointcal::PhotometryTransform.

Definition at line 248 of file PhotometryTransform.h.

248 { out << "PhotometryTransformChebyshev: " << _coefficients; }

◆ transform() [1/2]

double lsst::jointcal::FluxTransformChebyshev::transform ( double  x,
double  y,
double  value 
) const
inlineoverridevirtual

Return the transform of value at (x,y).

Implements lsst::jointcal::PhotometryTransform.

Definition at line 312 of file PhotometryTransform.h.

312  {
313  return value * computeChebyshev(x, y);
314  }
double computeChebyshev(double x, double y) const
Return the value of this polynomial at x,y.

◆ transform() [2/2]

double lsst::jointcal::PhotometryTransform::transform ( Point const &  in,
double  value 
) const
inlineinherited

Return the transformed value at Point(x,y).

Definition at line 58 of file PhotometryTransform.h.

58 { return transform(in.x, in.y, value); }
virtual double transform(double x, double y, double value) const =0
Return the transform of value at (x,y).

◆ transformError() [1/2]

double lsst::jointcal::PhotometryTransformChebyshev::transformError ( double  x,
double  y,
double  value,
double  valueErr 
) const
inlineoverridevirtualinherited

Return the transformed valueErr at Point(x,y).

Implements lsst::jointcal::PhotometryTransform.

Definition at line 245 of file PhotometryTransform.h.

245 { return 0; }

◆ transformError() [2/2]

double lsst::jointcal::PhotometryTransform::transformError ( Point const &  in,
double  value,
double  valueErr 
) const
inlineinherited

Return the transformed valueErr at Point(x,y).

Definition at line 64 of file PhotometryTransform.h.

64  {
65  return transformError(in.x, in.y, value, valueErr);
66  }
virtual double transformError(double x, double y, double value, double valueErr) const =0
Return the transformed valueErr at Point(x,y).

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