LSSTApplications  10.0+286,10.0+36,10.0+46,10.0-2-g4f67435,10.1+152,10.1+37,11.0,11.0+1,11.0-1-g47edd16,11.0-1-g60db491,11.0-1-g7418c06,11.0-2-g04d2804,11.0-2-g68503cd,11.0-2-g818369d,11.0-2-gb8b8ce7
LSSTDataManagementBasePackage
Public Member Functions | Static Public Member Functions | List of all members
lsst::afw::geom::ellipses::Distortion Class Reference

A complex ellipticity with magnitude \(|e| = \frac{a^2 - b^2}{a^2 + b^2}\). More...

#include <Distortion.h>

Inheritance diagram for lsst::afw::geom::ellipses::Distortion:
lsst::afw::geom::ellipses::detail::EllipticityBase

Public Member Functions

 Distortion (std::complex< double > const &complex)
 
 Distortion (double e1=0.0, double e2=0.0)
 
 Distortion (Distortion const &other)
 
 Distortion (ConformalShear const &other)
 
 Distortion (ReducedShear const &other)
 
Distortionoperator= (Distortion const &other)
 
Distortionoperator= (ConformalShear const &other)
 
Distortionoperator= (ReducedShear const &other)
 
Jacobian dAssign (Distortion const &other)
 
Jacobian dAssign (ConformalShear const &other)
 
Jacobian dAssign (ReducedShear const &other)
 
double getAxisRatio () const
 
void normalize ()
 
- Public Member Functions inherited from lsst::afw::geom::ellipses::detail::EllipticityBase
std::complex< double > & getComplex ()
 
std::complex< double > const & getComplex () const
 
void setComplex (std::complex< double > const &v)
 
double getE1 () const
 
void setE1 (double e1)
 
double getE2 () const
 
void setE2 (double e2)
 
double getE () const
 
void setE (double e)
 
double getTheta () const
 

Static Public Member Functions

static std::string getName ()
 

Additional Inherited Members

- Public Types inherited from lsst::afw::geom::ellipses::detail::EllipticityBase
enum  ParameterEnum { E1 =0, E2 =1 }
 
typedef Eigen::Matrix2d Jacobian
 
- Protected Member Functions inherited from lsst::afw::geom::ellipses::detail::EllipticityBase
 EllipticityBase (std::complex< double > const &complex)
 
 EllipticityBase (double e1=0.0, double e2=0.0)
 
- Protected Attributes inherited from lsst::afw::geom::ellipses::detail::EllipticityBase
std::complex< double > _complex
 

Detailed Description

A complex ellipticity with magnitude \(|e| = \frac{a^2 - b^2}{a^2 + b^2}\).

For a more complete definition, see Bernstein and Jarvis (2002); this the same as their distortion \(\delta\) (eq. 2.7).

Definition at line 41 of file Distortion.h.

Constructor & Destructor Documentation

lsst::afw::geom::ellipses::Distortion::Distortion ( std::complex< double > const &  complex)
inlineexplicit

Definition at line 44 of file Distortion.h.

44 : detail::EllipticityBase(complex) {}
lsst::afw::geom::ellipses::Distortion::Distortion ( double  e1 = 0.0,
double  e2 = 0.0 
)
inlineexplicit

Definition at line 46 of file Distortion.h.

46 : detail::EllipticityBase(e1, e2) {}
lsst::afw::geom::ellipses::Distortion::Distortion ( Distortion const &  other)
inline

Definition at line 48 of file Distortion.h.

48 : detail::EllipticityBase(other.getComplex()) {}
lsst::afw::geom::ellipses::Distortion::Distortion ( ConformalShear const &  other)
inlineexplicit

Definition at line 50 of file Distortion.h.

50 { this->operator=(other); }
Distortion & operator=(Distortion const &other)
Definition: Distortion.h:54
lsst::afw::geom::ellipses::Distortion::Distortion ( ReducedShear const &  other)
inlineexplicit

Definition at line 52 of file Distortion.h.

52 { this->operator=(other); }
Distortion & operator=(Distortion const &other)
Definition: Distortion.h:54

Member Function Documentation

Jacobian lsst::afw::geom::ellipses::Distortion::dAssign ( Distortion const &  other)
inline

Definition at line 63 of file Distortion.h.

63  {
64  _complex = other._complex;
65  return Jacobian::Identity();
66  }
Jacobian lsst::afw::geom::ellipses::Distortion::dAssign ( ConformalShear const &  other)
Jacobian lsst::afw::geom::ellipses::Distortion::dAssign ( ReducedShear const &  other)
double lsst::afw::geom::ellipses::Distortion::getAxisRatio ( ) const
static std::string lsst::afw::geom::ellipses::Distortion::getName ( )
inlinestatic

Definition at line 76 of file Distortion.h.

76 { return "Distortion"; }
void lsst::afw::geom::ellipses::Distortion::normalize ( )
Distortion& lsst::afw::geom::ellipses::Distortion::operator= ( Distortion const &  other)
inline

Definition at line 54 of file Distortion.h.

54  {
55  _complex = other._complex;
56  return *this;
57  }
Distortion& lsst::afw::geom::ellipses::Distortion::operator= ( ConformalShear const &  other)
Distortion& lsst::afw::geom::ellipses::Distortion::operator= ( ReducedShear const &  other)

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