Interface for the normalization (total integrated value) of a 2D Gaussian. More...

#include <gaussian.h>

Inheritance diagram for lsst::gauss2d::GaussianIntegral:

Public Member Functions
virtual double	get_value () const =0

virtual void	set_value (double value)=0

virtual std::string	repr (bool name_keywords=false, std::string_view namespace_separator=Object::CC_NAMESPACE_SEPARATOR) const override=0

virtual std::string	str () const override=0
	Return a brief, human-readable string representation of this.

virtual bool	operator== (const GaussianIntegral &other) const

virtual bool	operator!= (const GaussianIntegral &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

Interface for the normalization (total integrated value) of a 2D Gaussian.

Member Function Documentation

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

overridepure virtual

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.

virtual std::string lsst::gauss2d::GaussianIntegral::str ( ) const

overridepure virtual

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

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