lsst::gauss2d::GaussianIntegralValue Class Reference

A GaussianIntegral storing a float value. More...

#include <gaussian.h>

Inheritance diagram for lsst::gauss2d::GaussianIntegralValue:

Public Member Functions
	GaussianIntegralValue (double value=1.)
	GaussianIntegralValue (std::shared_ptr< double > value)
	~GaussianIntegralValue ()
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 = "."

Detailed Description

A GaussianIntegral storing a float value.

Note

At the moments, limits are not enforced as there is no way to prevent external methods setting the value negative and/or non-finite.

Definition at line 72 of file gaussian.h.

Constructor & Destructor Documentation

GaussianIntegralValue() [1/2]

lsst::gauss2d::GaussianIntegralValue::GaussianIntegralValue ( double value = 1. )

explicit

Definition at line 35 of file gaussian.cc.

: _value(std::make_shared<double>(value)) {};

GaussianIntegralValue() [2/2]

lsst::gauss2d::GaussianIntegralValue::GaussianIntegralValue ( std::shared_ptr< double > value )

explicit

Definition at line 36 of file gaussian.cc.

        : _value(value == nullptr ? std::make_shared<double>(1) : std::move(value)) {};

~GaussianIntegralValue()

lsst::gauss2d::GaussianIntegralValue::~GaussianIntegralValue ( )

inline

Definition at line 77 of file gaussian.h.

{};

Member Function Documentation

get_value()

double lsst::gauss2d::GaussianIntegralValue::get_value ( ) const

inlineoverridevirtual

Implements lsst::gauss2d::GaussianIntegral.

Definition at line 79 of file gaussian.h.

{ return *_value; }

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::GaussianIntegralValue::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.

Definition at line 39 of file gaussian.cc.

                                                                                                  {
    return type_name_str<GaussianIntegralValue>(false, namespace_separator) + "("
           + (name_keywords ? "value=" : "") + to_string_float(*_value) + ")";
}

set_value()

void lsst::gauss2d::GaussianIntegralValue::set_value ( double value )

inlineoverridevirtual

Implements lsst::gauss2d::GaussianIntegral.

Definition at line 80 of file gaussian.h.

{ *_value = value; }

str()

std::string lsst::gauss2d::GaussianIntegralValue::str ( ) const

overridevirtual

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

Implements lsst::gauss2d::GaussianIntegral.

Definition at line 43 of file gaussian.cc.

                                           {
    return type_name_str<GaussianIntegralValue>(true) + "(value=" + to_string_float(*_value) + ")";
}

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.0.0/Linux/gauss2d/gbf99507273+8c5ae1fdc5/include/lsst/gauss2d/gaussian.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.0.0/Linux/gauss2d/gbf99507273+8c5ae1fdc5/src/gaussian.cc