lsst::gauss2d::Gaussian Class Reference

A 2D Gaussian with a Centroid, Ellipse, and integral. More...

#include <gaussian.h>

Inheritance diagram for lsst::gauss2d::Gaussian:

Public Member Functions
	Gaussian (std::shared_ptr< Centroid > centroid=nullptr, std::shared_ptr< Ellipse > ellipse=nullptr, std::shared_ptr< GaussianIntegral > integral=nullptr)
	Construct a new Gaussian object.
	~Gaussian ()
double	get_const_normal () const
	Get the multiplicative factor for Gaussian function evaluations: integral/(2*area)
double	get_integral_value () const
	Get the integral value.
Centroid &	get_centroid ()
	Get the centroid object.
Ellipse &	get_ellipse ()
	Get the ellipse object.
GaussianIntegral &	get_integral ()
	Get the integral object.
std::shared_ptr< Centroid >	get_centroid_ptr ()
std::shared_ptr< Ellipse >	get_ellipse_ptr ()
std::shared_ptr< GaussianIntegral >	get_integral_ptr ()
const Centroid &	get_centroid_const () const
const Ellipse &	get_ellipse_const () const
const GaussianIntegral &	get_integral_const () const
void	set_const_normal (double const_normal)
void	set_integral_value (double integral)
void	set_centroid_ptr (std::shared_ptr< Centroid > centroid)
void	set_ellipse_ptr (std::shared_ptr< Ellipse > ellipse)
void	set_integral_ptr (std::shared_ptr< GaussianIntegral > integral)
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 Gaussian &other) const
bool	operator!= (const Gaussian &other) const

Static Public Member Functions
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

A 2D Gaussian with a Centroid, Ellipse, and integral.

Gaussian offers some convenience functions but is otherwise a container for its three component subclasses.

Definition at line 99 of file gaussian.h.

Constructor & Destructor Documentation

Gaussian()

lsst::gauss2d::Gaussian::Gaussian ( std::shared_ptr< Centroid > centroid = nullptr, std::shared_ptr< Ellipse > ellipse = nullptr, std::shared_ptr< GaussianIntegral > integral = nullptr )

explicit

Construct a new Gaussian object.

Parameters

centroid	The centroid. Defaults to a new, default Centroid.
ellipse	The ellipse. Defaults to a new, default Ellipse.
integral	The integral. Defaults to a new, default GaussianIntegralValue.

Definition at line 47 of file gaussian.cc.

        : _centroid(centroid != nullptr ? std::move(centroid) : std::make_shared<Centroid>()),
          _ellipse(ellipse != nullptr ? std::move(ellipse) : std::make_shared<Ellipse>()),
          _integral(integral != nullptr ? std::move(integral) : std::make_shared<GaussianIntegralValue>()) {}

~Gaussian()

lsst::gauss2d::Gaussian::~Gaussian

(

)

Definition at line 52 of file gaussian.cc.

{};

Member Function Documentation

get_centroid()

Centroid & lsst::gauss2d::Gaussian::get_centroid

(

)

Get the centroid object.

Definition at line 57 of file gaussian.cc.

{ return *_centroid; }

get_centroid_const()

const Centroid & lsst::gauss2d::Gaussian::get_centroid_const

(

)

const

Definition at line 65 of file gaussian.cc.

{ return *_centroid; }

get_centroid_ptr()

std::shared_ptr< Centroid > lsst::gauss2d::Gaussian::get_centroid_ptr

(

)

Definition at line 61 of file gaussian.cc.

{ return _centroid; }

get_const_normal()

double lsst::gauss2d::Gaussian::get_const_normal

(

)

const

Get the multiplicative factor for Gaussian function evaluations: integral/(2*area)

Definition at line 54 of file gaussian.cc.

{ return _integral->get_value() / (2 * _ellipse->get_area()); }

get_ellipse()

Ellipse & lsst::gauss2d::Gaussian::get_ellipse

(

)

Get the ellipse object.

Definition at line 58 of file gaussian.cc.

{ return *_ellipse; }

get_ellipse_const()

const Ellipse & lsst::gauss2d::Gaussian::get_ellipse_const

(

)

const

Definition at line 66 of file gaussian.cc.

{ return *_ellipse; }

get_ellipse_ptr()

std::shared_ptr< Ellipse > lsst::gauss2d::Gaussian::get_ellipse_ptr

(

)

Definition at line 62 of file gaussian.cc.

{ return _ellipse; }

get_integral()

GaussianIntegral & lsst::gauss2d::Gaussian::get_integral

(

)

Get the integral object.

Definition at line 59 of file gaussian.cc.

{ return *_integral; }

get_integral_const()

const GaussianIntegral & lsst::gauss2d::Gaussian::get_integral_const

(

)

const

Definition at line 67 of file gaussian.cc.

{ return *_integral; }

get_integral_ptr()

std::shared_ptr< GaussianIntegral > lsst::gauss2d::Gaussian::get_integral_ptr

(

)

Definition at line 63 of file gaussian.cc.

{ return _integral; }

get_integral_value()

double lsst::gauss2d::Gaussian::get_integral_value

(

)

const

Get the integral value.

Definition at line 55 of file gaussian.cc.

{ return _integral->get_value(); };

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::Gaussian::operator!=

(

const Gaussian &

other

)

const

Definition at line 101 of file gaussian.cc.

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

operator==()

bool lsst::gauss2d::Gaussian::operator==

(

const Gaussian &

other

)

const

Definition at line 96 of file gaussian.cc.

                                                     {
    return (*_centroid == other.get_centroid_const()) && (*_ellipse == other.get_ellipse_const())
           && (*_integral == other.get_integral_const());
}

repr()

std::string lsst::gauss2d::Gaussian::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 84 of file gaussian.cc.

                                                                                     {
    return type_name_str<Gaussian>(false, namespace_separator) + "(" + (name_keywords ? "centroid=" : "")
           + _centroid->repr(name_keywords, namespace_separator) + ", " + (name_keywords ? "ellipse=" : "")
           + _ellipse->repr(name_keywords, namespace_separator) + ", " + (name_keywords ? "integral=" : "")
           + _integral->repr(name_keywords, namespace_separator) + ")";
}

set_centroid_ptr()

void lsst::gauss2d::Gaussian::set_centroid_ptr

(

std::shared_ptr< Centroid >

centroid

)

Definition at line 74 of file gaussian.cc.

                                                                {
    _centroid = this->_check_not_nullptr<Centroid>(centroid, "centroid");
}

set_const_normal()

void lsst::gauss2d::Gaussian::set_const_normal

(

double

const_normal

)

Definition at line 69 of file gaussian.cc.

                                                   {
    _integral->set_value(get_const_normal() * 2 * _ellipse->get_area());
}

set_ellipse_ptr()

void lsst::gauss2d::Gaussian::set_ellipse_ptr

(

std::shared_ptr< Ellipse >

ellipse

)

Definition at line 77 of file gaussian.cc.

                                                             {
    _ellipse = this->_check_not_nullptr<Ellipse>(ellipse, "ellipse");
}

set_integral_ptr()

void lsst::gauss2d::Gaussian::set_integral_ptr

(

std::shared_ptr< GaussianIntegral >

integral

)

Definition at line 80 of file gaussian.cc.

                                                                        {
    _integral = this->_check_not_nullptr<GaussianIntegral>(integral, "integral");
}

set_integral_value()

void lsst::gauss2d::Gaussian::set_integral_value

(

double

integral

)

Definition at line 72 of file gaussian.cc.

{ _integral->set_value(integral); }

str()

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

overridevirtual

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

Implements lsst::gauss2d::Object.

Definition at line 91 of file gaussian.cc.

                              {
    return type_name_str<Gaussian>(true) + "(centroid=" + _centroid->str() + ", ellipse=" + _ellipse->str()
           + ", integral=" + _integral->str() + ")";
}

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-12.2.0/Linux64/gauss2d/gbf99507273+b0138be388/include/lsst/gauss2d/gaussian.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.2.0/Linux64/gauss2d/gbf99507273+b0138be388/src/gaussian.cc