lsst::gauss2d::ConvolvedGaussian Class Reference

A convolution of a Gaussian source and kernel. More...

#include <gaussian.h>

Inheritance diagram for lsst::gauss2d::ConvolvedGaussian:

Public Member Functions
	ConvolvedGaussian (std::shared_ptr< const Gaussian > source=nullptr, std::shared_ptr< const Gaussian > kernel=nullptr)
const Gaussian &	get_source () const
const Gaussian &	get_kernel () const
std::unique_ptr< Gaussian >	make_convolution () const
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.
bool	operator== (const ConvolvedGaussian &other) const
bool	operator!= (const ConvolvedGaussian &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 convolution of a Gaussian source and kernel.

Definition at line 220 of file gaussian.h.

Constructor & Destructor Documentation

ConvolvedGaussian()

lsst::gauss2d::ConvolvedGaussian::ConvolvedGaussian ( std::shared_ptr< const Gaussian > source = nullptr, std::shared_ptr< const Gaussian > kernel = nullptr )

explicit

Definition at line 179 of file gaussian.cc.

        : _source(source != nullptr ? source : GAUSS_ZERO),
          _kernel(kernel != nullptr ? kernel : GAUSS_ZERO) {}

Member Function Documentation

get_kernel()

const Gaussian & lsst::gauss2d::ConvolvedGaussian::get_kernel

(

)

const

Definition at line 223 of file gaussian.cc.

{ return *_kernel; }

get_source()

const Gaussian & lsst::gauss2d::ConvolvedGaussian::get_source

(

)

const

Definition at line 222 of file gaussian.cc.

{ return *_source; }

make_convolution()

std::unique_ptr< Gaussian > lsst::gauss2d::ConvolvedGaussian::make_convolution

(

)

const

Definition at line 225 of file gaussian.cc.

                                                                  {
    return std::make_unique<Gaussian>(
            _source->get_centroid_const().make_convolution(_kernel->get_centroid_const()),
            _source->get_ellipse_const().make_convolution(_kernel->get_ellipse_const()),
            std::make_shared<GaussianIntegralValue>(_source->get_integral_value()
                                                    + _kernel->get_integral_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!=()

bool lsst::gauss2d::ConvolvedGaussian::operator!=

(

const ConvolvedGaussian &

other

)

const

Definition at line 248 of file gaussian.cc.

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

operator==()

bool lsst::gauss2d::ConvolvedGaussian::operator==

(

const ConvolvedGaussian &

other

)

const

Definition at line 244 of file gaussian.cc.

                                                                       {
    return (this->get_source() == other.get_source()) && (this->get_kernel() == other.get_kernel());
}

repr()

std::string lsst::gauss2d::ConvolvedGaussian::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::Object.

Definition at line 233 of file gaussian.cc.

                                                                                              {
    return type_name_str<ConvolvedGaussian>(false, namespace_separator) + "("
           + (name_keywords ? "source=" : "") + _source->repr(name_keywords, namespace_separator) + ", "
           + (name_keywords ? "kernel=" : "") + _kernel->repr(name_keywords, namespace_separator) + ")";
}

str()

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

overridevirtual

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

Implements lsst::gauss2d::Object.

Definition at line 239 of file gaussian.cc.

                                       {
    return type_name_str<ConvolvedGaussian>(true) + "(source=" + _source->str() + ", kernel=" + _kernel->str()
           + ")";
}

Member Data Documentation

CC_NAMESPACE_SEPARATOR

constexpr 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

constexpr std::string_view lsst::gauss2d::Object::NULL_STR_GENERAL = "None"

staticconstexprinherited

Definition at line 46 of file object.h.

PY_NAMESPACE_SEPARATOR

constexpr 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-9.0.0/Linux64/gauss2d/g9125e01d80+a8ce1bb630/include/lsst/gauss2d/gaussian.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/gauss2d/g9125e01d80+a8ce1bb630/src/gaussian.cc