lsst::gauss2d::GaussianIntegralValue Class Reference

A GaussianIntegral storing a float value. More...

#include <gaussian.h>

Inheritance diagram for lsst::gauss2d::GaussianIntegralValue:

Public Member Functions
	GaussianIntegralValue (double value=1.)
	GaussianIntegralValue (std::shared_ptr< double > value)
double	get_value () const override
void	set_value (double value) override
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.
Public Member Functions inherited from lsst::gauss2d::GaussianIntegral
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

A GaussianIntegral storing a float value.

Note

At the moments, limits are not enforced as there is no way to prevent external methods setting the value negative and/or non-finite.

Member Function Documentation

get_value()

double lsst::gauss2d::GaussianIntegralValue::get_value ( ) const

inlineoverridevirtual

Implements lsst::gauss2d::GaussianIntegral.

repr()

std::string lsst::gauss2d::GaussianIntegralValue::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::GaussianIntegral.

set_value()

void lsst::gauss2d::GaussianIntegralValue::set_value ( double value )

inlineoverridevirtual

Implements lsst::gauss2d::GaussianIntegral.

str()

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

overridevirtual

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

Implements lsst::gauss2d::GaussianIntegral.

---

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

• include/lsst/gauss2d/gaussian.h
• src/gaussian.cc