lsst.astshim  21.0.0-2-g45278ab+e70536a077
Public Member Functions | Public Attributes | List of all members
ast::QuadApprox Class Reference

#include <QuadApprox.h>

Public Member Functions

 QuadApprox (Mapping const &map, std::vector< double > const &lbnd, std::vector< double > const &ubnd, int nx=3, int ny=3)
 
 QuadApprox (QuadApprox const &)=default
 
 QuadApprox (QuadApprox &&)=default
 
QuadApproxoperator= (QuadApprox const &)=default
 
QuadApproxoperator= (QuadApprox &&)=default
 

Public Attributes

std::vector< double > fit
 
double rms
 

Detailed Description

A quadratic approximation to a 2D Mapping.

Construct the class to compute the contained fields:

Constructor & Destructor Documentation

◆ QuadApprox() [1/3]

ast::QuadApprox::QuadApprox ( Mapping const &  map,
std::vector< double > const &  lbnd,
std::vector< double > const &  ubnd,
int  nx = 3,
int  ny = 3 
)
explicit

Obtain a quadratic approximation to a 2D Mapping.

Compute the coefficients of a quadratic fit to the supplied Mapping over the input area specified by lbnd and ubnd. The Mapping must have 2 inputs, but may have any number of outputs. The i'th Mapping output is modeled as a quadratic function of the 2 inputs (x,y):

output_i = a_i_0 + a_i_1*x + a_i_2*y + a_i_3*x*y + a_i_4*x*x + a_i_5*y*y

The fit vector is set tothe values of the co-efficients a_0_0, a_0_1, etc.

Parameters
[in]mapMapping to fit.
[in]lbndThe lower bounds of a box defined within the input coordinate system of the Mapping. The number of elements in this vector should equal map.getNIn(). This box should specify the region over which the fit is to be performed.
[in]ubndThe upper bounds of the box specifying the region over which the fit is to be performed.
[in]nxThe number of points to place along the first Mapping input. The first point is at lbnd[0] and the last is at ubnd[0]". If a value less than three is supplied a value of three will be used.
[in]nyThe number of points to place along the second Mapping input. The first point is at lbnd[1] and the last is at ubnd[1]. If a value less than three is supplied a value of three will be used.
Exceptions
std::invalid_argumentif the mapping does not have 2 inputs, or if lbnd or ubnd do not each contain 2 elements.
std::runtime_errorif the fit cannot be computed.

◆ QuadApprox() [2/3]

ast::QuadApprox::QuadApprox ( QuadApprox const &  )
default

◆ QuadApprox() [3/3]

ast::QuadApprox::QuadApprox ( QuadApprox &&  )
default

Member Function Documentation

◆ operator=() [1/2]

QuadApprox& ast::QuadApprox::operator= ( QuadApprox &&  )
default

◆ operator=() [2/2]

QuadApprox& ast::QuadApprox::operator= ( QuadApprox const &  )
default

Member Data Documentation

◆ fit

std::vector<double> ast::QuadApprox::fit

A vector of coefficients of the quadratic approximation to the specified transformation.

This vector will contain "6*NOut", elements: the first 6 elements hold the fit to the first Mapping output, the next 6 elements hold the fit to the second Mapping output, etc. So if the Mapping has 2 inputs and 2 outputs the quadratic approximation to the forward transformation is:

X_out = fit[0] + fit[1]*X_in + fit[2]*Y_in + fit[3]*X_in*Y_in +
        fit[4]*X_in*X_in + fit[5]*Y_in*Y_in
Y_out = fit[6] + fit[7]*X_in + fit[8]*Y_in + fit[9]*X_in*Y_in +
        fit[10]*X_in*X_in + fit[11]*Y_in*Y_in
X_out = fit(1) + fit(2)*X_in + fit(3)*Y_in + fit(4)*X_in*Y_in +
        fit(5)*X_in*X_in + fit(6)*Y_in*Y_in
Y_out = fit(7) + fit(8)*X_in + fit(9)*Y_in + fit(10)*X_in*Y_in +
        fit(11)*X_in*X_in + fit(12)*Y_in*Y_in

◆ rms

double ast::QuadApprox::rms

The RMS residual between the fit and the Mapping, summed over all Mapping outputs.


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