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 }
typedef Eigen::Matrix2d	Jacobian

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

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 42 of file EllipticityBase.h.

Member Typedef Documentation

typedef Eigen::Matrix2d lsst::afw::geom::ellipses::detail::EllipticityBase::Jacobian

Definition at line 45 of file EllipticityBase.h.

Member Enumeration Documentation

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

Enumerator
E1
E2

Definition at line 47 of file EllipticityBase.h.

{ E1=0, E2=1 };

Constructor & Destructor Documentation

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

inlineexplicitprotected

Definition at line 80 of file EllipticityBase.h.

: _complex(complex) {}

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

inlineexplicitprotected

Definition at line 82 of file EllipticityBase.h.

: _complex(e1, e2) {}

Member Function Documentation

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

inline

Definition at line 49 of file EllipticityBase.h.

{ return _complex; }

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

inline

Definition at line 51 of file EllipticityBase.h.

{ return _complex; }

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

inline

Definition at line 73 of file EllipticityBase.h.

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

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

inline

Definition at line 55 of file EllipticityBase.h.

{ return _complex.real(); }

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

inline

Definition at line 64 of file EllipticityBase.h.

{ return _complex.imag(); }

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

inline

Definition at line 76 of file EllipticityBase.h.

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

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

inline

Definition at line 53 of file EllipticityBase.h.

{ _complex = v; }

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

inline

Definition at line 74 of file EllipticityBase.h.

{ _complex *= e / getE(); }

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

inline

Definition at line 56 of file EllipticityBase.h.

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

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

inline

Definition at line 65 of file EllipticityBase.h.

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

Member Data Documentation

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

protected

Definition at line 84 of file EllipticityBase.h.

---

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

• /home/lsstsw/stack/Linux64/afw/11.0-2-g04d2804/include/lsst/afw/geom/ellipses/EllipticityBase.h