Loading [MathJax]/extensions/tex2jax.js
LSST Applications g04a91732dc+cc8870d3f5,g07dc498a13+5aa0b8792f,g0fba68d861+80045be308,g1409bbee79+5aa0b8792f,g1a7e361dbc+5aa0b8792f,g1fd858c14a+f64bc332a9,g208c678f98+1ae86710ed,g35bb328faa+fcb1d3bbc8,g4d2262a081+47ad8a29a8,g4d39ba7253+9633a327c1,g4e0f332c67+5d362be553,g53246c7159+fcb1d3bbc8,g60b5630c4e+9633a327c1,g668ecb457e+25d63fd678,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g7b71ed6315+fcb1d3bbc8,g8852436030+8b64ca622a,g89139ef638+5aa0b8792f,g89e1512fd8+04325574d3,g8d6b6b353c+9633a327c1,g9125e01d80+fcb1d3bbc8,g989de1cb63+5aa0b8792f,g9f33ca652e+b196626af7,ga9baa6287d+9633a327c1,gaaedd4e678+5aa0b8792f,gabe3b4be73+1e0a283bba,gb1101e3267+71e32094df,gb58c049af0+f03b321e39,gb90eeb9370+2807b1ad02,gcf25f946ba+8b64ca622a,gd315a588df+a39986a76f,gd6cbbdb0b4+c8606af20c,gd9a9a58781+fcb1d3bbc8,gde0f65d7ad+4e42d81ab7,ge278dab8ac+932305ba37,ge82c20c137+76d20ab76d,gfe73954cf8+a1301e4c20,w.2025.11
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
lsst::gauss2d::GaussianIntegral Class Referenceabstract

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

#include <gaussian.h>

Inheritance diagram for lsst::gauss2d::GaussianIntegral:
lsst::gauss2d::Object lsst::gauss2d::GaussianIntegralValue lsst::gauss2d::fit::GaussianModelIntegral lsst::gauss2d::fit::SersicModelIntegral

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

◆ 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.

49 {
50 return namespace_separator == CC_NAMESPACE_SEPARATOR ? "nullptr" : NULL_STR_GENERAL;
51 }
static constexpr std::string_view CC_NAMESPACE_SEPARATOR
The C++ namespace separator.
Definition object.h:45
static constexpr std::string_view NULL_STR_GENERAL
Definition object.h:46

◆ operator!=()

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

Definition at line 62 of file gaussian.h.

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

◆ operator==()

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

Definition at line 59 of file gaussian.h.

59 {
60 return this->get_value() == other.get_value();
61 }
virtual double get_value() const =0

◆ 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_keywordsWhether to prefix arguments with "{name}=", where name is the arg name in the header (as with keyword arguments in Python).
namespace_separatorThe 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

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