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:

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

channel	The Channel for the integral.
integralmodel	An IntegralModel valid for channel.

Definition at line 9 of file gaussianmodelintegral.cc.

        : _channel(channel), _integralmodel(std::move(integralmodel)) {
    if (_integralmodel == nullptr)
        throw std::invalid_argument("GaussianModelIntegral integralmodel can't be null");
}

~GaussianModelIntegral()

lsst::gauss2d::fit::GaussianModelIntegral::~GaussianModelIntegral

(

)

Definition at line 15 of file gaussianmodelintegral.cc.

{};

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.

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

                                                                              {
        return namespace_separator == CC_NAMESPACE_SEPARATOR ? "nullptr" : NULL_STR_GENERAL;
    }

operator!=()

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

inlinevirtualinherited

Definition at line 62 of file gaussian.h.

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

operator==()

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

inlinevirtualinherited

Definition at line 59 of file gaussian.h.

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

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

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

Definition at line 22 of file gaussianmodelintegral.cc.

                                                                                                  {
    return type_name_str<GaussianModelIntegral>(false, namespace_separator) + "("
           + (name_keywords ? "channel=" : "") + _channel.repr(name_keywords, namespace_separator) + ", "
           + (name_keywords ? "integralmodel=" : "")
           + _integralmodel->repr(name_keywords, namespace_separator) + ")";
}

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.

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

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.

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

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:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-10.0.0/Linux64/gauss2d_fit/gb58c049af0+f03b321e39/include/lsst/gauss2d/fit/gaussianmodelintegral.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-10.0.0/Linux64/gauss2d_fit/gb58c049af0+f03b321e39/src/gaussianmodelintegral.cc