lsst::gauss2d::GaussianIntegral Class Reference

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	~GaussianIntegral ()=default
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
	Return a full, callable string representation of this.
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

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

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

Definition at line 47 of file gaussian.h.

Constructor & Destructor Documentation

~GaussianIntegral()

virtual lsst::gauss2d::GaussianIntegral::~GaussianIntegral ( )

virtualdefault

Member Function Documentation

get_value()

virtual double lsst::gauss2d::GaussianIntegral::get_value ( ) const

pure virtual

Implemented in lsst::gauss2d::fit::GaussianModelIntegral, lsst::gauss2d::fit::SersicModelIntegral, and lsst::gauss2d::GaussianIntegralValue.

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!=()

virtual bool lsst::gauss2d::GaussianIntegral::operator!= ( const GaussianIntegral & other ) const

inlinevirtual

Definition at line 62 of file gaussian.h.

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

operator==()

virtual bool lsst::gauss2d::GaussianIntegral::operator== ( const GaussianIntegral & other ) const

inlinevirtual

Definition at line 59 of file gaussian.h.

                                                                 {
        return this->get_value() == other.get_value();
    }

repr()

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.

Implements lsst::gauss2d::Object.

Implemented in lsst::gauss2d::fit::GaussianModelIntegral, lsst::gauss2d::fit::SersicModelIntegral, and lsst::gauss2d::GaussianIntegralValue.

set_value()

virtual void lsst::gauss2d::GaussianIntegral::set_value ( double value )

pure virtual

Implemented in lsst::gauss2d::fit::GaussianModelIntegral, lsst::gauss2d::fit::SersicModelIntegral, and lsst::gauss2d::GaussianIntegralValue.

str()

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

overridepure virtual

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

Implements lsst::gauss2d::Object.

Implemented in lsst::gauss2d::fit::GaussianModelIntegral, lsst::gauss2d::fit::SersicModelIntegral, and lsst::gauss2d::GaussianIntegralValue.

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 file:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/gauss2d/gbf99507273+edbf708997/include/lsst/gauss2d/gaussian.h