LSST Applications g013ef56533+63812263fb,g083dd6704c+a047e97985,g199a45376c+0ba108daf9,g1fd858c14a+fde7a7a78c,g210f2d0738+db0c280453,g262e1987ae+abed931625,g29ae962dfc+058d1915d8,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+64337f1634,g47891489e3+f459a6810c,g53246c7159+8c5ae1fdc5,g54cd7ddccb+890c8e1e5d,g5a60e81ecd+d9e514a434,g64539dfbff+db0c280453,g67b6fd64d1+f459a6810c,g6ebf1fc0d4+8c5ae1fdc5,g7382096ae9+36d16ea71a,g74acd417e5+c70e70fbf6,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+f459a6810c,g8d7436a09f+1b779678e3,g8ea07a8fe4+81eaaadc04,g90f42f885a+34c0557caf,g97be763408+9583a964dd,g98a1a72a9c+028271c396,g98df359435+530b675b85,gb8cb2b794d+4e54f68785,gbf99507273+8c5ae1fdc5,gc2a301910b+db0c280453,gca7fc764a6+f459a6810c,gd7ef33dd92+f459a6810c,gdab6d2f7ff+c70e70fbf6,ge410e46f29+f459a6810c,ge41e95a9f2+db0c280453,geaed405ab2+e3b4b2a692,gf9a733ac38+8c5ae1fdc5,w.2025.43
LSST Data Management Base Package
Loading...
Searching...
No Matches
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: