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::ReducedShear Class Reference

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

#include <ReducedShear.h>

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

Public Member Functions

 ReducedShear (std::complex< double > const &complex)
 
 ReducedShear (double e1=0.0, double e2=0.0)
 
 ReducedShear (ReducedShear const &other)
 
 ReducedShear (Distortion const &other)
 
 ReducedShear (ConformalShear const &other)
 
ReducedShearoperator= (ReducedShear const &other)
 
ReducedShearoperator= (Distortion const &other)
 
ReducedShearoperator= (ConformalShear const &other)
 
Jacobian dAssign (ReducedShear const &other)
 
Jacobian dAssign (Distortion const &other)
 
Jacobian dAssign (ConformalShear 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-b}{a+b} \).

For a more complete definition, see Bernstein and Jarvis (2002); this the same as their reduced shear \(g\) (eq. 2.8).

Definition at line 42 of file ReducedShear.h.

Constructor & Destructor Documentation

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

Definition at line 45 of file ReducedShear.h.

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

Definition at line 47 of file ReducedShear.h.

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

Definition at line 49 of file ReducedShear.h.

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

Definition at line 51 of file ReducedShear.h.

51 { this->operator=(other); }
ReducedShear & operator=(ReducedShear const &other)
Definition: ReducedShear.h:55
lsst::afw::geom::ellipses::ReducedShear::ReducedShear ( ConformalShear const &  other)
inlineexplicit

Definition at line 53 of file ReducedShear.h.

53 { this->operator=(other); }
ReducedShear & operator=(ReducedShear const &other)
Definition: ReducedShear.h:55

Member Function Documentation

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

Definition at line 64 of file ReducedShear.h.

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

Definition at line 77 of file ReducedShear.h.

77 { return "ReducedShear"; }
void lsst::afw::geom::ellipses::ReducedShear::normalize ( )
inline

Definition at line 75 of file ReducedShear.h.

75 {}
ReducedShear& lsst::afw::geom::ellipses::ReducedShear::operator= ( ReducedShear const &  other)
inline

Definition at line 55 of file ReducedShear.h.

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

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