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.

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

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

Additional Inherited Members
Static Public Member Functions inherited from lsst::gauss2d::Object
static std::string_view	null_str (const std::string_view &namespace_separator)

Static Public Attributes inherited from lsst::gauss2d::Object
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.

Constructor & Destructor Documentation

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.

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.

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

overridevirtual

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

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