lsst.afw  20.0.0-13-gad96b2d30+614f89f815
Public Types | Public Member Functions | Protected Member Functions | List of all members
lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ > Class Template Reference

An ellipse core with a complex ellipticity and radius parameterization. More...

#include <radii.h>

Public Types

enum  ParameterEnum { E1 = 0, E2 = 1, RADIUS = 2 }
 
typedef Ellipticity_ Ellipticity
 
typedef Radius_ Radius
 

Public Member Functions

double const getE1 () const
 
void setE1 (double e1)
 
double const getE2 () const
 
void setE2 (double e2)
 
Radius const & getRadius () const
 
RadiusgetRadius ()
 
void setRadius (double radius)
 
void setRadius (Radius const &radius)
 
Ellipticity const & getEllipticity () const
 
EllipticitygetEllipticity ()
 
std::shared_ptr< Separableclone () const
 Deep copy the ellipse core. More...
 
std::string getName () const override
 Return a string that identifies this parametrization. More...
 
void normalize () override
 Put the parameters into a "standard form", and throw InvalidParameterError if they cannot be normalized. More...
 
void readParameters (double const *iter) override
 
void writeParameters (double *iter) const override
 
Separableoperator= (Separable const &other)
 Standard assignment. More...
 
Separableoperator= (Separable &&other)
 
Separableoperator= (BaseCore const &other)
 Converting assignment. More...
 
 Separable (double e1=0.0, double e2=0.0, double radius=Radius(), bool normalize=true)
 Construct from parameter values. More...
 
 Separable (std::complex< double > const &complex, double radius=Radius(), bool normalize=true)
 Construct from parameter values. More...
 
 Separable (Ellipticity const &ellipticity, double radius=Radius(), bool normalize=true)
 Construct from parameter values. More...
 
 Separable (BaseCore::ParameterVector const &vector, bool normalize=false)
 Construct from a parameter vector. More...
 
 Separable (Separable const &other)
 Copy constructor. More...
 
 Separable (Separable &&other)
 
 ~Separable () override=default
 
 Separable (BaseCore const &other)
 Converting copy constructor. More...
 
 Separable (BaseCore::Transformer const &transformer)
 Converting copy constructor. More...
 
 Separable (BaseCore::Convolution const &convolution)
 Converting copy constructor. More...
 

Protected Member Functions

std::shared_ptr< BaseCore_clone () const override
 
void _assignToQuadrupole (double &ixx, double &iyy, double &ixy) const override
 
void _assignFromQuadrupole (double ixx, double iyy, double ixy) override
 
void _assignToAxes (double &a, double &b, double &theta) const override
 
void _assignFromAxes (double a, double b, double theta) override
 
Jacobian _dAssignToQuadrupole (double &ixx, double &iyy, double &ixy) const override
 
Jacobian _dAssignFromQuadrupole (double ixx, double iyy, double ixy) override
 
Jacobian _dAssignToAxes (double &a, double &b, double &theta) const override
 
Jacobian _dAssignFromAxes (double a, double b, double theta) override
 

Detailed Description

template<typename Ellipticity_, typename Radius_>
class lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >

An ellipse core with a complex ellipticity and radius parameterization.

Definition at line 44 of file radii.h.

Member Typedef Documentation

◆ Ellipticity

template<typename Ellipticity_ , typename Radius_ >
typedef Ellipticity_ lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::Ellipticity

Definition at line 54 of file Separable.h.

◆ Radius

template<typename Ellipticity_ , typename Radius_ >
typedef Radius_ lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::Radius

Definition at line 55 of file Separable.h.

Member Enumeration Documentation

◆ ParameterEnum

template<typename Ellipticity_ , typename Radius_ >
enum lsst::afw::geom::ellipses::Separable::ParameterEnum
Enumerator
E1 
E2 
RADIUS 

Definition at line 52 of file Separable.h.

Constructor & Destructor Documentation

◆ Separable() [1/9]

template<typename Ellipticity_ , typename Radius_ >
lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::Separable ( double  e1 = 0.0,
double  e2 = 0.0,
double  radius = Radius(),
bool  normalize = true 
)
explicit

Construct from parameter values.

Definition at line 78 of file Separable.cc.

◆ Separable() [2/9]

template<typename Ellipticity_ , typename Radius_ >
lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::Separable ( std::complex< double > const &  complex,
double  radius = Radius(),
bool  normalize = true 
)
explicit

Construct from parameter values.

Definition at line 84 of file Separable.cc.

◆ Separable() [3/9]

template<typename Ellipticity_ , typename Radius_ >
lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::Separable ( Ellipticity const &  ellipticity,
double  radius = Radius(),
bool  normalize = true 
)
explicit

Construct from parameter values.

Definition at line 91 of file Separable.cc.

◆ Separable() [4/9]

template<typename Ellipticity_ , typename Radius_ >
lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::Separable ( BaseCore::ParameterVector const &  vector,
bool  normalize = false 
)
explicit

Construct from a parameter vector.

Definition at line 97 of file Separable.cc.

◆ Separable() [5/9]

template<typename Ellipticity_ , typename Radius_ >
lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::Separable ( Separable< Ellipticity_, Radius_ > const &  other)
inline

Copy constructor.

Definition at line 111 of file Separable.h.

◆ Separable() [6/9]

template<typename Ellipticity_ , typename Radius_ >
lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::Separable ( Separable< Ellipticity_, Radius_ > &&  other)
inline

Definition at line 114 of file Separable.h.

◆ ~Separable()

template<typename Ellipticity_ , typename Radius_ >
lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::~Separable ( )
overridedefault

◆ Separable() [7/9]

template<typename Ellipticity_ , typename Radius_ >
lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::Separable ( BaseCore const &  other)
inline

Converting copy constructor.

Definition at line 119 of file Separable.h.

◆ Separable() [8/9]

template<typename Ellipticity_ , typename Radius_ >
lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::Separable ( BaseCore::Transformer const &  transformer)
inline

Converting copy constructor.

Definition at line 122 of file Separable.h.

◆ Separable() [9/9]

template<typename Ellipticity_ , typename Radius_ >
lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::Separable ( BaseCore::Convolution const &  convolution)
inline

Converting copy constructor.

Definition at line 125 of file Separable.h.

Member Function Documentation

◆ _assignFromAxes()

template<typename Ellipticity_ , typename Radius_ >
void lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::_assignFromAxes ( double  a,
double  b,
double  theta 
)
overrideprotected

Definition at line 152 of file Separable.cc.

◆ _assignFromQuadrupole()

template<typename Ellipticity_ , typename Radius_ >
void lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::_assignFromQuadrupole ( double  ixx,
double  iyy,
double  ixy 
)
overrideprotected

Definition at line 135 of file Separable.cc.

◆ _assignToAxes()

template<typename Ellipticity_ , typename Radius_ >
void lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::_assignToAxes ( double &  a,
double &  b,
double &  theta 
) const
overrideprotected

Definition at line 119 of file Separable.cc.

◆ _assignToQuadrupole()

template<typename Ellipticity_ , typename Radius_ >
void lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::_assignToQuadrupole ( double &  ixx,
double &  iyy,
double &  ixy 
) const
overrideprotected

Definition at line 103 of file Separable.cc.

◆ _clone()

template<typename Ellipticity_ , typename Radius_ >
std::shared_ptr<BaseCore> lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::_clone ( ) const
inlineoverrideprotected

Definition at line 128 of file Separable.h.

◆ _dAssignFromAxes()

template<typename Ellipticity_ , typename Radius_ >
BaseCore::Jacobian lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::_dAssignFromAxes ( double  a,
double  b,
double  theta 
)
overrideprotected

Definition at line 159 of file Separable.cc.

◆ _dAssignFromQuadrupole()

template<typename Ellipticity_ , typename Radius_ >
BaseCore::Jacobian lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::_dAssignFromQuadrupole ( double  ixx,
double  iyy,
double  ixy 
)
overrideprotected

Definition at line 142 of file Separable.cc.

◆ _dAssignToAxes()

template<typename Ellipticity_ , typename Radius_ >
BaseCore::Jacobian lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::_dAssignToAxes ( double &  a,
double &  b,
double &  theta 
) const
overrideprotected

Definition at line 126 of file Separable.cc.

◆ _dAssignToQuadrupole()

template<typename Ellipticity_ , typename Radius_ >
BaseCore::Jacobian lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::_dAssignToQuadrupole ( double &  ixx,
double &  iyy,
double &  ixy 
) const
overrideprotected

Definition at line 109 of file Separable.cc.

◆ clone()

template<typename Ellipticity_ , typename Radius_ >
std::shared_ptr<Separable> lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::clone ( ) const
inline

Deep copy the ellipse core.

Definition at line 72 of file Separable.h.

◆ getE1()

template<typename Ellipticity_ , typename Radius_ >
double const lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::getE1 ( ) const
inline

Definition at line 57 of file Separable.h.

◆ getE2()

template<typename Ellipticity_ , typename Radius_ >
double const lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::getE2 ( ) const
inline

Definition at line 60 of file Separable.h.

◆ getEllipticity() [1/2]

template<typename Ellipticity_ , typename Radius_ >
Ellipticity& lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::getEllipticity ( )
inline

Definition at line 69 of file Separable.h.

◆ getEllipticity() [2/2]

template<typename Ellipticity_ , typename Radius_ >
Ellipticity const& lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::getEllipticity ( ) const
inline

Definition at line 68 of file Separable.h.

◆ getName()

template<typename Ellipticity_ , typename Radius_ >
std::string lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::getName
override

Return a string that identifies this parametrization.

Definition at line 39 of file Separable.cc.

◆ getRadius() [1/2]

template<typename Ellipticity_ , typename Radius_ >
Radius& lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::getRadius ( )
inline

Definition at line 64 of file Separable.h.

◆ getRadius() [2/2]

template<typename Ellipticity_ , typename Radius_ >
Radius const& lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::getRadius ( ) const
inline

Definition at line 63 of file Separable.h.

◆ normalize()

template<typename Ellipticity_ , typename Radius_ >
void lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::normalize
override

Put the parameters into a "standard form", and throw InvalidParameterError if they cannot be normalized.

Definition at line 44 of file Separable.cc.

◆ operator=() [1/3]

template<typename Ellipticity_ , typename Radius_ >
Separable& lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::operator= ( BaseCore const &  other)
inline

Converting assignment.

Definition at line 93 of file Separable.h.

◆ operator=() [2/3]

template<typename Ellipticity_ , typename Radius_ >
Separable< Ellipticity_, Radius_ > & lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::operator= ( Separable< Ellipticity_, Radius_ > &&  other)

Definition at line 73 of file Separable.cc.

◆ operator=() [3/3]

template<typename Ellipticity_ , typename Radius_ >
Separable< Ellipticity_, Radius_ > & lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::operator= ( Separable< Ellipticity_, Radius_ > const &  other)

Standard assignment.

Definition at line 64 of file Separable.cc.

◆ readParameters()

template<typename Ellipticity_ , typename Radius_ >
void lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::readParameters ( double const *  iter)
override

Definition at line 50 of file Separable.cc.

◆ setE1()

template<typename Ellipticity_ , typename Radius_ >
void lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::setE1 ( double  e1)
inline

Definition at line 58 of file Separable.h.

◆ setE2()

template<typename Ellipticity_ , typename Radius_ >
void lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::setE2 ( double  e2)
inline

Definition at line 61 of file Separable.h.

◆ setRadius() [1/2]

template<typename Ellipticity_ , typename Radius_ >
void lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::setRadius ( double  radius)
inline

Definition at line 65 of file Separable.h.

◆ setRadius() [2/2]

template<typename Ellipticity_ , typename Radius_ >
void lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::setRadius ( Radius const &  radius)
inline

Definition at line 66 of file Separable.h.

◆ writeParameters()

template<typename Ellipticity_ , typename Radius_ >
void lsst::afw::geom::ellipses::Separable< Ellipticity_, Radius_ >::writeParameters ( double *  iter) const
override

Definition at line 57 of file Separable.cc.


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