lsst::gauss2d::EllipseMajor Class Reference

An Ellipse with r_major, axrat and angle values. More...

#include <ellipse.h>

Inheritance diagram for lsst::gauss2d::EllipseMajor:

Public Member Functions
	EllipseMajor (double r_major, double axrat, double angle, bool degrees=false)
	Construct a new EllipseMajor object with default float values.
	EllipseMajor (const Covariance &covar, bool degrees=false)
	EllipseMajor (const Ellipse &ellipse, bool degrees=false)
double	get_area () const
	Return the area of this ellipse, equal to pi*sigma_major*sigma_minor.
double	get_r_major () const
	Get the major axis length.
double	get_axrat () const
	Get the axis ratio.
double	get_angle () const
	Get the position angle in the configured units.
double	get_angle_degrees () const
	Get the position angle in degrees.
double	get_angle_radians () const
	Get the position angle in radians.
std::array< double, 3 >	get_rqa () const
	Get the array of r_major, axrat, angle.
bool	is_degrees () const
	Return if the units are degrees (true) or radians (false)
void	set (double r_major, double axrat, double angle)
void	set_r_major (double r_major)
void	set_axrat (double axrat)
void	set_angle (double angle)
void	set_degrees (bool degrees)
void	set_rqa (const std::array< double, 3 > &rqa)
std::string	repr (bool name_keywords=false, std::string_view namespace_separator=Object::CC_NAMESPACE_SEPARATOR) const override
	Return a full, callable string representation of this.
std::string	str () const override
	Return a brief, human-readable string representation of this.
bool	operator== (const EllipseMajor &other) const
bool	operator!= (const EllipseMajor &other) const

Static Public Member Functions
static void	check (double r_major, double axrat, double angle)
	Check whether the supplied values are valid, throwing if not.
static std::string_view	null_str (const std::string_view &namespace_separator)

Static Public Attributes
static constexpr std::string_view	CC_NAMESPACE_SEPARATOR = "::"
	The C++ namespace separator.
static constexpr std::string_view	NULL_STR_GENERAL = "None"
static constexpr std::string_view	PY_NAMESPACE_SEPARATOR = "."

Detailed Description

An Ellipse with r_major, axrat and angle values.

This ellipse representation is intended for intermediate calculations and does not use an abstract Data class. r_major must be >= 0, and 0 <= axrat <= 1.

Definition at line 337 of file ellipse.h.

Constructor & Destructor Documentation

EllipseMajor() [1/3]

lsst::gauss2d::EllipseMajor::EllipseMajor ( double r_major, double axrat, double angle, bool degrees = false )

explicit

Construct a new EllipseMajor object with default float values.

Parameters

r_major	The initial r_major value
axrat	The initial axrat value
angle	The intial angle value
degrees	Whether the angle unit is degrees (true) or radians (false)

Definition at line 361 of file ellipse.cc.

        : _r_major(r_major), _axrat(axrat), _angle(angle), _degrees(degrees) {
    EllipseMajor::check(r_major, axrat, angle);
}

EllipseMajor() [2/3]

lsst::gauss2d::EllipseMajor::EllipseMajor ( const Covariance & covar, bool degrees = false )

explicit

Definition at line 366 of file ellipse.cc.

                                                                : _degrees(degrees) {
    init(*this, covar, degrees);
}

EllipseMajor() [3/3]

lsst::gauss2d::EllipseMajor::EllipseMajor ( const Ellipse & ellipse, bool degrees = false )

explicit

Definition at line 370 of file ellipse.cc.

                                                               : _degrees(degrees) {
    init(*this, Covariance(ellipse), degrees);
}

Member Function Documentation

check()

static void lsst::gauss2d::EllipseMajor::check ( double r_major, double axrat, double angle )

inlinestatic

Check whether the supplied values are valid, throwing if not.

Definition at line 352 of file ellipse.h.

                                                                  {
        if (!(r_major >= 0) || !(axrat >= 0 && axrat <= 1)) {
            throw std::invalid_argument("Invalid r_major, axrat, angle=" + std::to_string(r_major) + ","
                                        + std::to_string(axrat) + "," + std::to_string(angle)
                                        + "; r_major >= 0, 1 >= axrat >= 0 required.");
        }
    }

get_angle()

double lsst::gauss2d::EllipseMajor::get_angle ( ) const

inline

Get the position angle in the configured units.

Definition at line 366 of file ellipse.h.

{ return _angle; }

get_angle_degrees()

double lsst::gauss2d::EllipseMajor::get_angle_degrees ( ) const

inline

Get the position angle in degrees.

Definition at line 368 of file ellipse.h.

{ return _degrees ? _angle : _angle * M_180_PI; }

get_angle_radians()

double lsst::gauss2d::EllipseMajor::get_angle_radians ( ) const

inline

Get the position angle in radians.

Definition at line 370 of file ellipse.h.

{ return _degrees ? _angle * M_PI_180 : _angle; }

get_area()

double lsst::gauss2d::EllipseMajor::get_area ( ) const

inline

Return the area of this ellipse, equal to pi*sigma_major*sigma_minor.

Definition at line 360 of file ellipse.h.

{ return M_PI * _r_major * _r_major * _axrat; }

get_axrat()

double lsst::gauss2d::EllipseMajor::get_axrat ( ) const

inline

Get the axis ratio.

Definition at line 364 of file ellipse.h.

{ return _axrat; }

get_r_major()

double lsst::gauss2d::EllipseMajor::get_r_major ( ) const

inline

Get the major axis length.

Definition at line 362 of file ellipse.h.

{ return _r_major; }

get_rqa()

std::array< double, 3 > lsst::gauss2d::EllipseMajor::get_rqa ( ) const

inline

Get the array of r_major, axrat, angle.

Definition at line 372 of file ellipse.h.

{ return {_r_major, _axrat, _angle}; }

is_degrees()

bool lsst::gauss2d::EllipseMajor::is_degrees ( ) const

inline

Return if the units are degrees (true) or radians (false)

Definition at line 374 of file ellipse.h.

{ return _degrees; }

null_str()

static std::string_view lsst::gauss2d::Object::null_str ( const std::string_view & namespace_separator )

inlinestaticinherited

Definition at line 49 of file object.h.

                                                                              {
        return namespace_separator == CC_NAMESPACE_SEPARATOR ? "nullptr" : NULL_STR_GENERAL;
    }

operator!=()

bool lsst::gauss2d::EllipseMajor::operator!=

(

const EllipseMajor &

other

)

const

Definition at line 429 of file ellipse.cc.

{ return !(*this == other); }

operator==()

bool lsst::gauss2d::EllipseMajor::operator==

(

const EllipseMajor &

other

)

const

Definition at line 424 of file ellipse.cc.

                                                             {
    return (get_r_major() == other.get_r_major()) && (get_axrat() == other.get_axrat())
           && (get_angle_degrees() == other.get_angle_degrees());
}

repr()

std::string lsst::gauss2d::EllipseMajor::repr ( bool name_keywords = false, std::string_view namespace_separator = Object::CC_NAMESPACE_SEPARATOR ) const

overridevirtual

Return a full, callable string representation of this.

Parameters

name_keywords	Whether to prefix arguments with "{name}=", where name is the arg name in the header (as with keyword arguments in Python).
namespace_separator	The string to use to delimit namespaces, i.e. :: in C++ and . in Python.

Returns

A callable string representation of this, which should return an an identical object to this.

Note

The representation with name_keywords=false must be callable in C++. The representation with name_keywords=true should be callable in Python, if there are any bindings.

Implements lsst::gauss2d::Object.

Definition at line 411 of file ellipse.cc.

                                                                                         {
    return type_name_str<EllipseMajor>(false, namespace_separator) + "(" + (name_keywords ? "r_major=" : "")
           + to_string_float(_r_major) + ", " + (name_keywords ? "axrat=" : "") + to_string_float(_axrat)
           + ", " + (name_keywords ? "angle=" : "") + to_string_float(_angle) + ", "
           + (name_keywords ? "degrees=" : "") + to_string_float(_degrees) + ")";
}

set()

void lsst::gauss2d::EllipseMajor::set	(	double	r_major,
		double	axrat,
		double	angle )

Definition at line 374 of file ellipse.cc.

                                                                 {
    check(r_major, axrat, angle);
    _r_major = r_major;
    _axrat = axrat;
    _angle = angle;
}

set_angle()

void lsst::gauss2d::EllipseMajor::set_angle

(

double

angle

)

Definition at line 397 of file ellipse.cc.

{ _angle = angle; }

set_axrat()

void lsst::gauss2d::EllipseMajor::set_axrat

(

double

axrat

)

Definition at line 389 of file ellipse.cc.

                                         {
    if (!(axrat >= 0 && axrat <= 1)) {
        throw std::invalid_argument("Invalid axrat=" + to_string_float(axrat)
                                    + "; 1 >= axrat >= 0 required.");
    }
    _axrat = axrat;
}

set_degrees()

void lsst::gauss2d::EllipseMajor::set_degrees

(

bool

degrees

)

Definition at line 399 of file ellipse.cc.

                                           {
    if (degrees && !_degrees) {
        _degrees = true;
        _angle *= M_180_PI;
    } else if (!degrees && _degrees) {
        _degrees = false;
        _angle *= M_PI_180;
    }
}

set_r_major()

void lsst::gauss2d::EllipseMajor::set_r_major

(

double

r_major

)

Definition at line 381 of file ellipse.cc.

                                             {
    if (!(r_major >= 0)) {
        throw std::invalid_argument("Invalid r_major=" + to_string_float(r_major)
                                    + "; r_major >= 0 required.");
    }
    _r_major = r_major;
}

set_rqa()

void lsst::gauss2d::EllipseMajor::set_rqa

(

const std::array< double, 3 > &

rqa

)

Definition at line 409 of file ellipse.cc.

{ this->set(rqa[0], rqa[1], rqa[2]); }

str()

std::string lsst::gauss2d::EllipseMajor::str ( ) const

overridevirtual

Return a brief, human-readable string representation of this.

Implements lsst::gauss2d::Object.

Definition at line 418 of file ellipse.cc.

                                  {
    return type_name_str<EllipseMajor>(true) + "(r_major=" + to_string_float(_r_major)
           + ", axrat=" + to_string_float(_axrat) + ", angle=" + to_string_float(_angle)
           + ", degrees=" + to_string_float(_degrees) + ")";
}

Member Data Documentation

CC_NAMESPACE_SEPARATOR

std::string_view lsst::gauss2d::Object::CC_NAMESPACE_SEPARATOR = "::"

staticconstexprinherited

The C++ namespace separator.

Definition at line 45 of file object.h.

NULL_STR_GENERAL

std::string_view lsst::gauss2d::Object::NULL_STR_GENERAL = "None"

staticconstexprinherited

Definition at line 46 of file object.h.

PY_NAMESPACE_SEPARATOR

std::string_view lsst::gauss2d::Object::PY_NAMESPACE_SEPARATOR = "."

staticconstexprinherited

Definition at line 47 of file object.h.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/gauss2d/g9125e01d80+e55fef2c71/include/lsst/gauss2d/ellipse.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/gauss2d/g9125e01d80+e55fef2c71/src/ellipse.cc