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:

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

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

Definition at line 47 of file EllipticityBase.h.

Member Enumeration Documentation

ParameterEnum

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

Enumerator
E1
E2

Definition at line 49 of file EllipticityBase.h.

{ E1 = 0, E2 = 1 };

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.

: _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.

: _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.

{ 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.

{ return _complex; }

getE()

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

inline

Definition at line 75 of file EllipticityBase.h.

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

getE1()

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

inline

Definition at line 57 of file EllipticityBase.h.

{ return _complex.real(); }

getE2()

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

inline

Definition at line 66 of file EllipticityBase.h.

{ return _complex.imag(); }

getTheta()

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

inline

Definition at line 78 of file EllipticityBase.h.

{ 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.

{ _complex = v; }

setE()

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

inline

Definition at line 76 of file EllipticityBase.h.

{ _complex *= e / getE(); }

setE1()

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

inline

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 )

inline

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

protected

Definition at line 91 of file EllipticityBase.h.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/afw/g7ae74a0b1c+a25e60b391/include/lsst/afw/geom/ellipses/EllipticityBase.h