LSSTApplications  10.0+286,10.0+36,10.0+46,10.0-2-g4f67435,10.1+152,10.1+37,11.0,11.0+1,11.0-1-g47edd16,11.0-1-g60db491,11.0-1-g7418c06,11.0-2-g04d2804,11.0-2-g68503cd,11.0-2-g818369d,11.0-2-gb8b8ce7
LSSTDataManagementBasePackage
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
lsst::afw::geom::ellipses::TraceRadius Class Reference

The radius defined as \(\sqrt{0.5(I_{xx} + I_{yy})}\). More...

#include <radii.h>

Public Member Functions

void normalize ()
 
 TraceRadius (double value=1.0)
 
 TraceRadius (LogTraceRadius const &other)
 
 operator double const & () const
 
 operator double & ()
 
TraceRadiusoperator= (double value)
 
TraceRadiusoperator= (LogTraceRadius const &other)
 

Static Public Member Functions

static std::string getName ()
 

Private Member Functions

void operator= (DeterminantRadius const &)
 Undefined and disabled; conversion between trace and determinant radii requires ellipticity. More...
 
void operator= (LogDeterminantRadius const &)
 Undefined and disabled; conversion between trace and determinant radii requires ellipticity. More...
 
void assignFromQuadrupole (double ixx, double iyy, double ixy, Distortion &distortion)
 
BaseCore::Jacobian dAssignFromQuadrupole (double ixx, double iyy, double ixy, Distortion &distortion)
 
void assignToQuadrupole (Distortion const &distortion, double &ixx, double &iyy, double &ixy) const
 
BaseCore::Jacobian dAssignToQuadrupole (Distortion const &distortion, double &ixx, double &iyy, double &ixy) const
 

Private Attributes

double _value
 

Friends

template<typename T1 , typename T2 >
class Separable
 

Detailed Description

The radius defined as \(\sqrt{0.5(I_{xx} + I_{yy})}\).

The trace radius is equal to the standard radius for a circle

Definition at line 117 of file radii.h.

Constructor & Destructor Documentation

lsst::afw::geom::ellipses::TraceRadius::TraceRadius ( double  value = 1.0)
inlineexplicit

Definition at line 128 of file radii.h.

128 : _value(value) {}
lsst::afw::geom::ellipses::TraceRadius::TraceRadius ( LogTraceRadius const &  other)
inlineexplicit

Definition at line 281 of file radii.h.

281 : _value(std::exp(other)) {}

Member Function Documentation

void lsst::afw::geom::ellipses::TraceRadius::assignFromQuadrupole ( double  ixx,
double  iyy,
double  ixy,
Distortion distortion 
)
private
void lsst::afw::geom::ellipses::TraceRadius::assignToQuadrupole ( Distortion const &  distortion,
double &  ixx,
double &  iyy,
double &  ixy 
) const
private
BaseCore::Jacobian lsst::afw::geom::ellipses::TraceRadius::dAssignFromQuadrupole ( double  ixx,
double  iyy,
double  ixy,
Distortion distortion 
)
private
BaseCore::Jacobian lsst::afw::geom::ellipses::TraceRadius::dAssignToQuadrupole ( Distortion const &  distortion,
double &  ixx,
double &  iyy,
double &  ixy 
) const
private
static std::string lsst::afw::geom::ellipses::TraceRadius::getName ( )
inlinestatic

Definition at line 126 of file radii.h.

126 { return "TraceRadius"; }
void lsst::afw::geom::ellipses::TraceRadius::normalize ( )
inline

Definition at line 120 of file radii.h.

120  {
121  if (_value < 0)
122  throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError,
123  "Ellipse radius cannot be negative.");
124  }
#define LSST_EXCEPT(type,...)
Definition: Exception.h:46
lsst::afw::geom::ellipses::TraceRadius::operator double & ( )
inline

Definition at line 134 of file radii.h.

134 { return _value; }
lsst::afw::geom::ellipses::TraceRadius::operator double const & ( ) const
inline

Definition at line 132 of file radii.h.

132 { return _value; }
TraceRadius& lsst::afw::geom::ellipses::TraceRadius::operator= ( double  value)
inline

Definition at line 136 of file radii.h.

136 { _value = value; return *this; }
TraceRadius & lsst::afw::geom::ellipses::TraceRadius::operator= ( LogTraceRadius const &  other)
inline

Definition at line 290 of file radii.h.

290  {
291  _value = std::exp(other);
292  return *this;
293 }
void lsst::afw::geom::ellipses::TraceRadius::operator= ( DeterminantRadius const &  )
private

Undefined and disabled; conversion between trace and determinant radii requires ellipticity.

void lsst::afw::geom::ellipses::TraceRadius::operator= ( LogDeterminantRadius const &  )
private

Undefined and disabled; conversion between trace and determinant radii requires ellipticity.

Friends And Related Function Documentation

template<typename T1 , typename T2 >
friend class Separable
friend

Definition at line 142 of file radii.h.

Member Data Documentation

double lsst::afw::geom::ellipses::TraceRadius::_value
private

Definition at line 169 of file radii.h.


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