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

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.

: _value(value) {}

TraceRadius() [2/4]

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

inlineexplicit

Definition at line 269 of file radii.h.

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

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.

{ return "TraceRadius"; }

normalize()

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

inline

Definition at line 116 of file radii.h.

                     {
        if (_value < 0)
            throw LSST_EXCEPT(lsst::pex::exceptions::InvalidParameterError,
                              "Ellipse radius cannot be negative.");
    }

operator double &()

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

inline

Definition at line 134 of file radii.h.

{ return _value; }

operator double const &()

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

inline

Definition at line 132 of file radii.h.

{ return _value; }

operator=() [1/6]

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

delete

Conversion between trace and determinant radii requires ellipticity.

operator=() [2/6]

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

inline

Definition at line 136 of file radii.h.

                                         {
        _value = value;
        return *this;
    }

operator=() [3/6]

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

delete

Conversion between trace and determinant radii requires ellipticity.

operator=() [4/6]

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

inline

Definition at line 278 of file radii.h.

                                                                      {
    _value = std::exp(other);
    return *this;
}

operator=() [5/6]

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

default

operator=() [6/6]

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

default

Friends And Related Symbol 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:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+be83d3ecdb/include/lsst/afw/geom/ellipses/radii.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+be83d3ecdb/src/geom/ellipses/radii.cc