lsst::afw::geom::ellipses::ConformalShear Class Reference

A logarithmic complex ellipticity with magnitude \(|e| = \ln (a/b) \). More...

#include <ConformalShear.h>

Inheritance diagram for lsst::afw::geom::ellipses::ConformalShear:

Public Types
enum	ParameterEnum { E1 = 0 , E2 = 1 }
using	Jacobian = Eigen::Matrix2d

Public Member Functions
	ConformalShear (std::complex< double > const &complex)
	ConformalShear (double e1=0.0, double e2=0.0)
	ConformalShear (ConformalShear const &other)
	ConformalShear (ConformalShear &&other)
	~ConformalShear ()=default
	ConformalShear (Distortion const &other)
	ConformalShear (ReducedShear const &other)
ConformalShear &	operator= (ConformalShear const &other)
ConformalShear &	operator= (ConformalShear &&other)
ConformalShear &	operator= (Distortion const &other)
ConformalShear &	operator= (ReducedShear const &other)
Jacobian	dAssign (ConformalShear const &other)
Jacobian	dAssign (Distortion const &other)
Jacobian	dAssign (ReducedShear const &other)
double	getAxisRatio () const
void	normalize ()
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 ()

Protected Attributes
std::complex< double >	_complex

Detailed Description

A logarithmic complex ellipticity with magnitude \(|e| = \ln (a/b) \).

For a more complete definition, see Bernstein and Jarvis (2002); this the same as their conformal shear \(\eta\) (eq. 2.3-2.6).

Definition at line 45 of file ConformalShear.h.

Member Typedef Documentation

Jacobian

using lsst::afw::geom::ellipses::detail::EllipticityBase::Jacobian = Eigen::Matrix2d

inherited

Definition at line 47 of file EllipticityBase.h.

Member Enumeration Documentation

ParameterEnum

enum lsst::afw::geom::ellipses::detail::EllipticityBase::ParameterEnum

inherited

Enumerator
E1
E2

Definition at line 49 of file EllipticityBase.h.

{ E1 = 0, E2 = 1 };

Constructor & Destructor Documentation

ConformalShear() [1/6]

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

inlineexplicit

Definition at line 47 of file ConformalShear.h.

: detail::EllipticityBase(complex) {}

ConformalShear() [2/6]

lsst::afw::geom::ellipses::ConformalShear::ConformalShear ( double  e1 = 0.0, double  e2 = 0.0  )

inlineexplicit

Definition at line 49 of file ConformalShear.h.

: detail::EllipticityBase(e1, e2) {}

ConformalShear() [3/6]

lsst::afw::geom::ellipses::ConformalShear::ConformalShear ( ConformalShear const &  other )

inline

Definition at line 51 of file ConformalShear.h.

: detail::EllipticityBase(other.getComplex()) {}

ConformalShear() [4/6]

lsst::afw::geom::ellipses::ConformalShear::ConformalShear ( ConformalShear &&  other )

inline

Definition at line 53 of file ConformalShear.h.

: ConformalShear(other) {}

~ConformalShear()

lsst::afw::geom::ellipses::ConformalShear::~ConformalShear ( )

default

ConformalShear() [5/6]

lsst::afw::geom::ellipses::ConformalShear::ConformalShear ( Distortion const &  other )

inlineexplicit

Definition at line 56 of file ConformalShear.h.

{ this->operator=(other); }

ConformalShear() [6/6]

lsst::afw::geom::ellipses::ConformalShear::ConformalShear ( ReducedShear const &  other )

inlineexplicit

Definition at line 58 of file ConformalShear.h.

{ this->operator=(other); }

Member Function Documentation

dAssign() [1/3]

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

inline

Definition at line 71 of file ConformalShear.h.

                                                  {
        _complex = other._complex;
        return Jacobian::Identity();
    }

dAssign() [2/3]

detail::EllipticityBase::Jacobian lsst::afw::geom::ellipses::ConformalShear::dAssign

(

Distortion const &

other

)

Definition at line 62 of file ConformalShear.cc.

                                                                             {
    Jacobian result = Jacobian::Zero();
    double delta = other.getE();
    double alpha, beta;
    if (delta < 1E-8) {
        alpha = 1.0 + delta * delta / 3.0;
        beta = 2.0 / 3.0;
    } else {
        double eta = std::atanh(delta);
        alpha = eta / delta;
        beta = (1.0 / (1.0 - delta * delta) - alpha) / (delta * delta);
    }
    _complex = other.getComplex() * alpha;
    result(0, 0) = alpha + other.getE1() * other.getE1() * beta;
    result(1, 1) = alpha + other.getE2() * other.getE2() * beta;
    result(1, 0) = result(0, 1) = other.getE1() * other.getE2() * beta;
    return result;
}

dAssign() [3/3]

detail::EllipticityBase::Jacobian lsst::afw::geom::ellipses::ConformalShear::dAssign

(

ReducedShear const &

other

)

Definition at line 81 of file ConformalShear.cc.

                                                                               {
    Jacobian result = Jacobian::Zero();
    double g = other.getE();
    double alpha, beta;
    if (g < 1E-8) {
        alpha = 2.0 * (1.0 + g * g / 3.0);
        beta = 4.0 / 3.0;
    } else {
        double eta = 2.0 * std::atanh(g);
        alpha = eta / g;
        beta = 1.0 * (2.0 / (1.0 - g * g) - alpha) / (g * g);
    }
    _complex = other.getComplex() * alpha;
    result(0, 0) = alpha + other.getE1() * other.getE1() * beta;
    result(1, 1) = alpha + other.getE2() * other.getE2() * beta;
    result(1, 0) = result(0, 1) = other.getE1() * other.getE2() * beta;
    return result;
}

getAxisRatio()

double lsst::afw::geom::ellipses::ConformalShear::getAxisRatio

(

)

const

Definition at line 35 of file ConformalShear.cc.

                                          {
    double e = getE();
    return std::exp(-e);
}

getComplex() [1/2]

std::complex<double>& lsst::afw::geom::ellipses::detail::EllipticityBase::getComplex ( )

inlineinherited

Definition at line 51 of file EllipticityBase.h.

{ return _complex; }

getComplex() [2/2]

std::complex<double> const& lsst::afw::geom::ellipses::detail::EllipticityBase::getComplex ( ) const

inlineinherited

Definition at line 53 of file EllipticityBase.h.

{ return _complex; }

getE()

double lsst::afw::geom::ellipses::detail::EllipticityBase::getE ( ) const

inlineinherited

Definition at line 75 of file EllipticityBase.h.

{ return std::sqrt(std::norm(_complex)); }

getE1()

double lsst::afw::geom::ellipses::detail::EllipticityBase::getE1 ( ) const

inlineinherited

Definition at line 57 of file EllipticityBase.h.

{ return _complex.real(); }

getE2()

double lsst::afw::geom::ellipses::detail::EllipticityBase::getE2 ( ) const

inlineinherited

Definition at line 66 of file EllipticityBase.h.

{ return _complex.imag(); }

getName()

static std::string lsst::afw::geom::ellipses::ConformalShear::getName ( )

inlinestatic

Definition at line 84 of file ConformalShear.h.

{ return "ConformalShear"; }

getTheta()

double lsst::afw::geom::ellipses::detail::EllipticityBase::getTheta ( ) const

inlineinherited

Definition at line 78 of file EllipticityBase.h.

{ return 0.5 * std::arg(_complex); }

normalize()

void lsst::afw::geom::ellipses::ConformalShear::normalize ( )

inline

Definition at line 82 of file ConformalShear.h.

{}

operator=() [1/4]

ConformalShear& lsst::afw::geom::ellipses::ConformalShear::operator= ( ConformalShear &&  other )

inline

Definition at line 65 of file ConformalShear.h.

{ return *this = other; }

operator=() [2/4]

ConformalShear& lsst::afw::geom::ellipses::ConformalShear::operator= ( ConformalShear const &  other )

inline

Definition at line 60 of file ConformalShear.h.

                                                           {
        _complex = other._complex;
        return *this;
    }

operator=() [3/4]

ConformalShear & lsst::afw::geom::ellipses::ConformalShear::operator=

(

Distortion const &

other

)

Definition at line 40 of file ConformalShear.cc.

                                                                 {
    double delta = other.getE();
    if (delta < 1E-8) {
        _complex = other.getComplex() * (1.0 + delta * delta / 3.0);
    } else {
        double eta = std::atanh(delta);
        _complex = other.getComplex() * eta / delta;
    }
    return *this;
}

operator=() [4/4]

ConformalShear & lsst::afw::geom::ellipses::ConformalShear::operator=

(

ReducedShear const &

other

)

Definition at line 51 of file ConformalShear.cc.

                                                                   {
    double g = other.getE();
    if (g < 1E-8) {
        _complex = other.getComplex() * 2.0 * (1.0 + g * g / 3.0);
    } else {
        double eta = 2.0 * std::atanh(g);
        _complex = other.getComplex() * eta / g;
    }
    return *this;
}

setComplex()

void lsst::afw::geom::ellipses::detail::EllipticityBase::setComplex ( std::complex< double > const &  v )

inlineinherited

Definition at line 55 of file EllipticityBase.h.

{ _complex = v; }

setE()

void lsst::afw::geom::ellipses::detail::EllipticityBase::setE ( double  e )

inlineinherited

Definition at line 76 of file EllipticityBase.h.

{ _complex *= e / getE(); }

setE1()

void lsst::afw::geom::ellipses::detail::EllipticityBase::setE1 ( double  e1 )

inlineinherited

Definition at line 58 of file EllipticityBase.h.

                          {
#if __cplusplus < 201103L
        _complex = std::complex<double>(e1, _complex.imag());
#else
        _complex.real(e1);
#endif
    }

setE2()

void lsst::afw::geom::ellipses::detail::EllipticityBase::setE2 ( double  e2 )

inlineinherited

Definition at line 67 of file EllipticityBase.h.

                          {
#if __cplusplus < 201103L
        _complex = std::complex<double>(_complex.real(), e2);
#else
        _complex.imag(e2);
#endif
    }

Member Data Documentation

_complex

std::complex<double> lsst::afw::geom::ellipses::detail::EllipticityBase::_complex

protectedinherited

Definition at line 91 of file EllipticityBase.h.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/include/lsst/afw/geom/ellipses/ConformalShear.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-0.7.0/Linux64/afw/22.0.1-42-gca6935d93+ba5e5ca3eb/src/geom/ellipses/ConformalShear.cc