Loading [MathJax]/extensions/tex2jax.js
LSST Applications g04a91732dc+01eac3be2a,g07dc498a13+80b84b0d75,g0fba68d861+93ae69f531,g1409bbee79+80b84b0d75,g1a7e361dbc+80b84b0d75,g1fd858c14a+62fce11e04,g21d47ad084+612e5f560a,g35bb328faa+fcb1d3bbc8,g42c1b31a95+a1301e4c20,g4e0f332c67+5d362be553,g51f2318141+336db69876,g53246c7159+fcb1d3bbc8,g60b5630c4e+199bb0f7b6,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g7b71ed6315+fcb1d3bbc8,g7c8978a71e+63142fe354,g8852436030+144acb3a42,g89139ef638+80b84b0d75,g8d6b6b353c+199bb0f7b6,g9125e01d80+fcb1d3bbc8,g989de1cb63+80b84b0d75,g9f33ca652e+3c0760037a,ga9baa6287d+199bb0f7b6,ga9e4eb89a6+52c894a0f6,gaaedd4e678+80b84b0d75,gabe3b4be73+1e0a283bba,gb1101e3267+748a15ef4d,gb58c049af0+f03b321e39,gb90eeb9370+4ac62396ab,gcf25f946ba+144acb3a42,gd315a588df+d7f700c4fc,gd6cbbdb0b4+c8606af20c,gd9a9a58781+fcb1d3bbc8,gde0f65d7ad+495d0ed6c5,ge278dab8ac+932305ba37,ge82c20c137+76d20ab76d,gf0ff2d8333+199bb0f7b6,w.2025.09
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
lsst::gauss2d::fit::GaussianModelIntegral Class Reference

A single-channel GaussianIntegral referencing a Parametric IntegralModel. More...

#include <gaussianmodelintegral.h>

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

Public Member Functions

 GaussianModelIntegral (const Channel &channel, const std::shared_ptr< const IntegralModel > integralmodel)
 Construct a GaussianModelIntegral instance for one Channel.
 
 ~GaussianModelIntegral ()
 
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
 Return a full, callable string representation of this.
 
std::string str () const override
 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 = "."
 

Protected Attributes

const Channel_channel
 
const std::shared_ptr< const IntegralModel_integralmodel
 

Detailed Description

A single-channel GaussianIntegral referencing a Parametric IntegralModel.

Definition at line 15 of file gaussianmodelintegral.h.

Constructor & Destructor Documentation

◆ GaussianModelIntegral()

lsst::gauss2d::fit::GaussianModelIntegral::GaussianModelIntegral ( const Channel & channel,
const std::shared_ptr< const IntegralModel > integralmodel )
explicit

Construct a GaussianModelIntegral instance for one Channel.

Parameters
channelThe Channel for the integral.
integralmodelAn IntegralModel valid for channel.

Definition at line 9 of file gaussianmodelintegral.cc.

11 : _channel(channel), _integralmodel(std::move(integralmodel)) {
12 if (_integralmodel == nullptr)
13 throw std::invalid_argument("GaussianModelIntegral integralmodel can't be null");
14}
const std::shared_ptr< const IntegralModel > _integralmodel
T move(T... args)

◆ ~GaussianModelIntegral()

lsst::gauss2d::fit::GaussianModelIntegral::~GaussianModelIntegral ( )

Definition at line 15 of file gaussianmodelintegral.cc.

15{};

Member Function Documentation

◆ get_value()

double lsst::gauss2d::fit::GaussianModelIntegral::get_value ( ) const
overridevirtual

Implements lsst::gauss2d::GaussianIntegral.

Reimplemented in lsst::gauss2d::fit::SersicModelIntegral.

Definition at line 17 of file gaussianmodelintegral.cc.

17{ return _integralmodel->get_integral(_channel); }

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

Definition at line 62 of file gaussian.h.

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

◆ operator==()

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

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

std::string lsst::gauss2d::fit::GaussianModelIntegral::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_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::GaussianIntegral.

Reimplemented in lsst::gauss2d::fit::SersicModelIntegral.

Definition at line 22 of file gaussianmodelintegral.cc.

22 {
23 return type_name_str<GaussianModelIntegral>(false, namespace_separator) + "("
24 + (name_keywords ? "channel=" : "") + _channel.repr(name_keywords, namespace_separator) + ", "
25 + (name_keywords ? "integralmodel=" : "")
26 + _integralmodel->repr(name_keywords, namespace_separator) + ")";
27}
std::string type_name_str(bool strip_namespace=false, std::string_view namespace_str=detail::NAMESPACE_SEPARATOR)
Get a string representation of an arbitrary C++ type, potentially modifying its namespace prefix.
Definition type_name.h:104

◆ set_value()

void lsst::gauss2d::fit::GaussianModelIntegral::set_value ( double value)
overridevirtual

Implements lsst::gauss2d::GaussianIntegral.

Reimplemented in lsst::gauss2d::fit::SersicModelIntegral.

Definition at line 18 of file gaussianmodelintegral.cc.

18 {
19 throw std::runtime_error("Can't set_value on GaussianModelIntegral");
20}

◆ str()

std::string lsst::gauss2d::fit::GaussianModelIntegral::str ( ) const
overridevirtual

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

Implements lsst::gauss2d::GaussianIntegral.

Reimplemented in lsst::gauss2d::fit::SersicModelIntegral.

Definition at line 29 of file gaussianmodelintegral.cc.

29 {
30 return type_name_str<GaussianModelIntegral>(true) + "(channel=" + _channel.str()
31 + ", integralmodel=" + _integralmodel->str() + ")";
32}

Member Data Documentation

◆ _channel

const Channel& lsst::gauss2d::fit::GaussianModelIntegral::_channel
protected

Definition at line 35 of file gaussianmodelintegral.h.

◆ _integralmodel

const std::shared_ptr<const IntegralModel> lsst::gauss2d::fit::GaussianModelIntegral::_integralmodel
protected

Definition at line 36 of file gaussianmodelintegral.h.

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