A purely radial polynomial distortion, up to 6th order. More...
#include <XYTransform.h>
Inheritance diagram for lsst::afw::geom::RadialXYTransform:
Public Member Functions | |
| RadialXYTransform (std::vector< double > const &coeffs) | |
| virtual boost::shared_ptr < XYTransform > | clone () const |
| returns a deep copy More... | |
| virtual boost::shared_ptr < XYTransform > | invert () const |
| returns a "deep inverse" in this sense that the forward+inverse transforms do not share state More... | |
| virtual Point2D | forwardTransform (Point2D const &point) const |
| virtuals for forward and reverse transforms More... | |
| virtual Point2D | reverseTransform (Point2D const &point) const |
| virtual AffineTransform | linearizeForwardTransform (Point2D const &point) const |
| linearized forward and reversed transforms More... | |
| virtual AffineTransform | linearizeReverseTransform (Point2D const &point) const |
| std::vector< double > | getCoeffs () const |
 Public Member Functions inherited from lsst::afw::geom::XYTransform | |
| XYTransform () | |
| virtual | ~XYTransform () |
| Public Member Functions inherited from lsst::daf::base::Citizen | |
| Citizen (const std::type_info &) | |
| Citizen (Citizen const &) | |
| ~Citizen () | |
| Citizen & | operator= (Citizen const &) |
| std::string | repr () const |
| Return a string representation of a Citizen. More... | |
| void | markPersistent (void) |
| Mark a Citizen as persistent and not destroyed until process end. More... | |
| memId | getId () const |
| Return the Citizen's ID. More... | |
Static Public Member Functions | |
| static std::vector< double > | polyInvert (std::vector< double > const &coeffs) |
| These static member functions operate on polynomials represented by vector<double>. More... | |
| static double | polyEval (std::vector< double > const &coeffs, double x) |
| static Point2D | polyEval (std::vector< double > const &coeffs, Point2D const &p) |
| static double | polyEvalDeriv (std::vector< double > const &coeffs, double x) |
| static AffineTransform | polyEvalJacobian (std::vector< double > const &coeffs, Point2D const &p) |
| static double | polyEvalInverse (std::vector< double > const &coeffs, std::vector< double > const &icoeffs, double x) |
| static Point2D | polyEvalInverse (std::vector< double > const &coeffs, std::vector< double > const &icoeffs, Point2D const &p) |
| static AffineTransform | polyEvalInverseJacobian (std::vector< double > const &coeffs, std::vector< double > const &icoeffs, Point2D const &p) |
| static AffineTransform | makeAffineTransform (double x, double y, double f, double g) |
| Static Public Member Functions inherited from lsst::daf::base::Citizen | |
| static bool | hasBeenCorrupted () |
| Check all allocated blocks for corruption. More... | |
| static memId | getNextMemId () |
| Return the memId of the next object to be allocated. More... | |
| static int | init () |
| Called once when the memory system is being initialised. More... | |
| static int | census (int, memId startingMemId=0) |
| How many active Citizens are there? More... | |
| static void | census (std::ostream &stream, memId startingMemId=0) |
| Print a list of all active Citizens to stream, sorted by ID. More... | |
| static const std::vector < const Citizen * > * | census () |
| Return a (newly allocated) std::vector of active Citizens sorted by ID. More... | |
| static memId | setNewCallbackId (memId id) |
| Call the NewCallback when block is allocated. More... | |
| static memId | setDeleteCallbackId (memId id) |
| Call the current DeleteCallback when block is deleted. More... | |
| static memNewCallback | setNewCallback (memNewCallback func) |
| Set the NewCallback function. More... | |
| static memCallback | setDeleteCallback (memCallback func) |
| Set the DeleteCallback function. More... | |
| static memCallback | setCorruptionCallback (memCallback func) |
| Set the CorruptionCallback function. More... | |
Protected Attributes | |
| std::vector< double > | _coeffs |
| std::vector< double > | _icoeffs |
Additional Inherited Members | |
| Public Types inherited from lsst::afw::geom::XYTransform | |
| typedef afw::geom::Point2D | Point2D |
| typedef afw::geom::AffineTransform | AffineTransform |
| Public Types inherited from lsst::daf::base::Citizen | |
| enum | { magicSentinel = 0xdeadbeef } |
| typedef unsigned long | memId |
| Type of the block's ID. More... | |
| typedef memId(* | memNewCallback )(const memId cid) |
| A function used to register a callback. More... | |
| typedef memId(* | memCallback )(const Citizen *ptr) |
Detailed Description
A purely radial polynomial distortion, up to 6th order.
forwardTransform(pt) = pt * scale where:
- scale = (coeffs[1] r + coeffs[2] r^2 + ...) / r
- r = magnitude of pt
- Warning
- reverseTransform will fail if the polynomial is too far from linear (ticket #3152)
- Exceptions
-
lsst::pex::exceptions::InvalidParameterError if coeffs.size() > 0 and any of the following are true: coeffs.size() == 1, coeffs[0] != 0 or coeffs[1] == 0
Definition at line 186 of file XYTransform.h.
Constructor & Destructor Documentation
| lsst::afw::geom::RadialXYTransform::RadialXYTransform | ( | std::vector< double > const & | coeffs | ) |
- Parameters
-
coeffs radial polynomial coefficients; if size == 0 then gives the identity transformation; otherwise must satisfy: size > 1, coeffs[0] == 0, and coeffs[1] != 0
Member Function Documentation
|
virtual |
returns a deep copy
Implements lsst::afw::geom::XYTransform.
|
virtual |
virtuals for forward and reverse transforms
These routines are responsible for throwing exceptions if the 'point' arg is outside the domain of the transform.
Implements lsst::afw::geom::XYTransform.
|
inline |
Definition at line 201 of file XYTransform.h.
std::vector< double > _coeffs
Definition: XYTransform.h:231
|
virtual |
returns a "deep inverse" in this sense that the forward+inverse transforms do not share state
Reimplemented from lsst::afw::geom::XYTransform.
|
virtual |
linearized forward and reversed transforms
These are virtual but not pure virtual; there is a default implementation which calls forwardTransform() or reverseTransform() and takes finite differences with step size equal to one.
The following should always be satisfied for an arbitrary Point2D p (and analogously for the reverse transform) this->forwardTransform(p) == this->linearizeForwardTransform(p)(p);
Reimplemented from lsst::afw::geom::XYTransform.
|
virtual |
Reimplemented from lsst::afw::geom::XYTransform.
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
These static member functions operate on polynomials represented by vector<double>.
They are intended mainly as helpers for the virtual member functions above, but are declared public since there are also some unit tests which call them.
|
virtual |
Implements lsst::afw::geom::XYTransform.
Member Data Documentation
|
protected |
Definition at line 231 of file XYTransform.h.
|
protected |
Definition at line 232 of file XYTransform.h.
The documentation for this class was generated from the following file:
- /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/include/lsst/afw/geom/XYTransform.h
