LSSTApplications  18.1.0
LSSTDataManagementBasePackage
Public Member Functions | Static Public Member Functions | Friends | List of all members
lsst::afw::geom::ellipses::TraceRadius Class Referencefinal

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)
 
 TraceRadius (TraceRadius const &)=default
 
 TraceRadius (TraceRadius &&)=default
 
 ~TraceRadius ()=default
 
 operator double const & () const
 
 operator double & ()
 
TraceRadiusoperator= (double value)
 
TraceRadiusoperator= (LogTraceRadius const &other)
 
TraceRadiusoperator= (TraceRadius const &)=default
 
TraceRadiusoperator= (TraceRadius &&)=default
 
TraceRadiusoperator= (DeterminantRadius const &)=delete
 Conversion between trace and determinant radii requires ellipticity. More...
 
TraceRadiusoperator= (LogDeterminantRadius const &)=delete
 Conversion between trace and determinant radii requires ellipticity. More...
 

Static Public Member Functions

static std::string getName ()
 

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 114 of file radii.h.

Constructor & Destructor Documentation

◆ TraceRadius() [1/4]

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

Definition at line 124 of file radii.h.

124 : _value(value) {}

◆ TraceRadius() [2/4]

lsst::afw::geom::ellipses::TraceRadius::TraceRadius ( LogTraceRadius const &  other)
inlineexplicit

Definition at line 269 of file radii.h.

269 : _value(std::exp(other)) {}
T exp(T... args)
ItemVariant const * other
Definition: Schema.cc:56

◆ TraceRadius() [3/4]

lsst::afw::geom::ellipses::TraceRadius::TraceRadius ( TraceRadius const &  )
default

◆ TraceRadius() [4/4]

lsst::afw::geom::ellipses::TraceRadius::TraceRadius ( TraceRadius &&  )
default

◆ ~TraceRadius()

lsst::afw::geom::ellipses::TraceRadius::~TraceRadius ( )
default

Member Function Documentation

◆ getName()

static std::string lsst::afw::geom::ellipses::TraceRadius::getName ( )
inlinestatic

Definition at line 122 of file radii.h.

122 { return "TraceRadius"; }

◆ normalize()

void lsst::afw::geom::ellipses::TraceRadius::normalize ( )
inline

Definition at line 116 of file radii.h.

116  {
117  if (_value < 0)
119  "Ellipse radius cannot be negative.");
120  }
#define LSST_EXCEPT(type,...)
Create an exception with a given type.
Definition: Exception.h:48
Reports invalid arguments.
Definition: Runtime.h:66

◆ operator double &()

lsst::afw::geom::ellipses::TraceRadius::operator double & ( )
inline

Definition at line 134 of file radii.h.

134 { return _value; }

◆ operator double const &()

lsst::afw::geom::ellipses::TraceRadius::operator double const & ( ) const
inline

Definition at line 132 of file radii.h.

132 { return _value; }

◆ operator=() [1/6]

TraceRadius& lsst::afw::geom::ellipses::TraceRadius::operator= ( double  value)
inline

Definition at line 136 of file radii.h.

136  {
137  _value = value;
138  return *this;
139  }

◆ operator=() [2/6]

TraceRadius & lsst::afw::geom::ellipses::TraceRadius::operator= ( LogTraceRadius const &  other)
inline

Definition at line 278 of file radii.h.

278  {
279  _value = std::exp(other);
280  return *this;
281 }
T exp(T... args)
ItemVariant const * other
Definition: Schema.cc:56

◆ operator=() [3/6]

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

◆ operator=() [4/6]

TraceRadius& lsst::afw::geom::ellipses::TraceRadius::operator= ( TraceRadius &&  )
default

◆ operator=() [5/6]

TraceRadius& lsst::afw::geom::ellipses::TraceRadius::operator= ( DeterminantRadius const &  )
delete

Conversion between trace and determinant radii requires ellipticity.

◆ operator=() [6/6]

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

Conversion between trace and determinant radii requires ellipticity.

Friends And Related Function Documentation

◆ Separable

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

Definition at line 152 of file radii.h.


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