lsst::gauss2d::Gaussians Class Reference

An array of Gaussian objects. More...

#include <gaussian.h>

Inheritance diagram for lsst::gauss2d::Gaussians:

Public Types
typedef std::vector< std::shared_ptr< Gaussian > >	Data
using	iterator = typename Data::iterator
using	const_iterator = typename Data::const_iterator

Public Member Functions
	Gaussians (std::optional< const Data > data)
	Gaussians (std::vector< std::optional< const Data > > data)
Gaussian &	operator[] (size_t i)
const Gaussian &	operator[] (size_t i) const
Gaussian &	at (size_t i) const
const Gaussian &	at_const (size_t i) const
std::shared_ptr< Gaussian >	at_ptr (size_t i) const
Data::iterator	begin () noexcept
Data::const_iterator	cbegin () const noexcept
Data::const_iterator	begin () const noexcept
Data::const_iterator	end () const noexcept
Data::iterator	end () noexcept
Data::const_iterator	cend () const noexcept
Data	get_data () const
size_t	size () const
std::string	repr (bool name_keywords=false, std::string_view namespace_separator=Object::CC_NAMESPACE_SEPARATOR) const override
std::string	str () const override
	Return a brief, human-readable string representation of this.

Additional Inherited Members
Static Public Member Functions inherited from lsst::gauss2d::Object
static std::string_view	null_str (const std::string_view &namespace_separator)
Static Public Attributes inherited from lsst::gauss2d::Object
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

An array of Gaussian objects.

This class exists partly to be an immutable container of Gaussians with convenient constructors, but also so that it can be neatly wrapped with pybind11.

Member Function Documentation

repr()

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

str()

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

overridevirtual

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

Implements lsst::gauss2d::Object.

---

The documentation for this class was generated from the following files:

• include/lsst/gauss2d/gaussian.h
• src/gaussian.cc