LSST Applications g2079a07aa2+86d27d4dc4,g2305ad1205+a659bff248,g2bbee38e9b+3c60f8fe34,g337abbeb29+3c60f8fe34,g33d1c0ed96+3c60f8fe34,g3502564af9+d77d6d1350,g3a166c0a6a+3c60f8fe34,g487adcacf7+25d9892218,g4be5004598+d77d6d1350,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+4d81263f9a,g5cd07815a0+980d2b1c3b,g607f77f49a+d77d6d1350,g858d7b2824+d77d6d1350,g88963caddf+83e433e629,g99cad8db69+a4d3c48eeb,g9ddcbc5298+9a081db1e4,ga1e77700b3+bcf1af89ad,ga57fefb910+9a39d7b2d7,gae0086650b+585e252eca,gb065fddaf9+4f9fd82a2c,gb0e22166c9+60f28cb32d,gb363559e06+d84b1d3d07,gb3b7280ab2+4563d032e1,gb4b16eec92+babe958938,gba4ed39666+c2a2e4ac27,gbb8dafda3b+ed6854b564,gc120e1dc64+b72d212f87,gc28159a63d+3c60f8fe34,gc3e9b769f7+921dbcd359,gcf0d15dbbd+9a39d7b2d7,gdaeeff99f8+f9a426f77a,gddc38dedce+585e252eca,ge79ae78c31+3c60f8fe34,w.2024.21
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
lsst::afw::geom::ellipses::detail::EllipticityBase Class Reference

EllipticityBase is a base class for complex ellipticity types. More...

#include <EllipticityBase.h>

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

Public Types

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

Public Member Functions

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
 
 EllipticityBase (EllipticityBase const &)=default
 
 EllipticityBase (EllipticityBase &&)=default
 
EllipticityBaseoperator= (EllipticityBase const &)=default
 
EllipticityBaseoperator= (EllipticityBase &&)=default
 
 ~EllipticityBase ()=default
 

Protected Member Functions

 EllipticityBase (std::complex< double > const &complex)
 
 EllipticityBase (double e1=0.0, double e2=0.0)
 

Protected Attributes

std::complex< double > _complex
 

Detailed Description

EllipticityBase is a base class for complex ellipticity types.

EllipticityBase does not have a virtual destructor, and only exists for code reuse purposes. The ellipticity classes are not polymorphic simply to keep them small.

Definition at line 45 of file EllipticityBase.h.

Member Typedef Documentation

◆ Jacobian

Definition at line 47 of file EllipticityBase.h.

Member Enumeration Documentation

◆ ParameterEnum

Constructor & Destructor Documentation

◆ EllipticityBase() [1/4]

lsst::afw::geom::ellipses::detail::EllipticityBase::EllipticityBase ( EllipticityBase const & )
default

◆ EllipticityBase() [2/4]

lsst::afw::geom::ellipses::detail::EllipticityBase::EllipticityBase ( EllipticityBase && )
default

◆ ~EllipticityBase()

lsst::afw::geom::ellipses::detail::EllipticityBase::~EllipticityBase ( )
default

◆ EllipticityBase() [3/4]

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

Definition at line 87 of file EllipticityBase.h.

87: _complex(complex) {}

◆ EllipticityBase() [4/4]

lsst::afw::geom::ellipses::detail::EllipticityBase::EllipticityBase ( double e1 = 0.0,
double e2 = 0.0 )
inlineexplicitprotected

Definition at line 89 of file EllipticityBase.h.

89: _complex(e1, e2) {}

Member Function Documentation

◆ getComplex() [1/2]

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

Definition at line 51 of file EllipticityBase.h.

51{ return _complex; }

◆ getComplex() [2/2]

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

Definition at line 53 of file EllipticityBase.h.

53{ return _complex; }

◆ getE()

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

Definition at line 75 of file EllipticityBase.h.

75{ return std::sqrt(std::norm(_complex)); }
T sqrt(T... args)

◆ getE1()

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

Definition at line 57 of file EllipticityBase.h.

57{ return _complex.real(); }
T real(T... args)

◆ getE2()

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

Definition at line 66 of file EllipticityBase.h.

66{ return _complex.imag(); }
T imag(T... args)

◆ getTheta()

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

Definition at line 78 of file EllipticityBase.h.

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

◆ operator=() [1/2]

EllipticityBase & lsst::afw::geom::ellipses::detail::EllipticityBase::operator= ( EllipticityBase && )
default

◆ operator=() [2/2]

EllipticityBase & lsst::afw::geom::ellipses::detail::EllipticityBase::operator= ( EllipticityBase const & )
default

◆ setComplex()

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

Definition at line 55 of file EllipticityBase.h.

55{ _complex = v; }

◆ setE()

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

Definition at line 76 of file EllipticityBase.h.

◆ setE1()

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

Definition at line 58 of file EllipticityBase.h.

58 {
59#if __cplusplus < 201103L
61#else
62 _complex.real(e1);
63#endif
64 }

◆ setE2()

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

Definition at line 67 of file EllipticityBase.h.

67 {
68#if __cplusplus < 201103L
70#else
71 _complex.imag(e2);
72#endif
73 }

Member Data Documentation

◆ _complex

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

Definition at line 91 of file EllipticityBase.h.


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