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
	Return a full, callable string representation of this.
std::string	str () const override
	Return a brief, human-readable string representation of this.

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

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.

Definition at line 175 of file gaussian.h.

Member Typedef Documentation

const_iterator

using lsst::gauss2d::Gaussians::const_iterator = typename Data::const_iterator

Definition at line 191 of file gaussian.h.

Data

typedef std::vector<std::shared_ptr<Gaussian> > lsst::gauss2d::Gaussians::Data

Definition at line 177 of file gaussian.h.

iterator

using lsst::gauss2d::Gaussians::iterator = typename Data::iterator

Definition at line 190 of file gaussian.h.

Constructor & Destructor Documentation

Gaussians() [1/2]

lsst::gauss2d::Gaussians::Gaussians ( std::optional< const Data > data )

explicit

Definition at line 108 of file gaussian.cc.

                                                 {
    if (data) {
        size_t n_data = data->size();
        if (n_data > 0) {
            _data.resize(n_data, nullptr);
            this->assign(*data);
        }
    }
}

Gaussians() [2/2]

lsst::gauss2d::Gaussians::Gaussians ( std::vector< std::optional< const Data > > data )

explicit

Definition at line 117 of file gaussian.cc.

                                                            {
    size_t n_data = 0;
    for (const auto& datum : data) {
        if (datum) n_data += datum->size();
    }
    if (n_data > 0) {
        size_t i = 0;
        _data.resize(n_data);
        for (const auto& datum : data) i = this->assign(*datum, i);
    }
}

Member Function Documentation

at()

Gaussian & lsst::gauss2d::Gaussians::at

(

size_t

i

)

const

Definition at line 148 of file gaussian.cc.

{ return *(_data.at(i)); }

at_const()

const Gaussian & lsst::gauss2d::Gaussians::at_const

(

size_t

i

)

const

Definition at line 149 of file gaussian.cc.

{ return *(_data.at(i)); }

at_ptr()

std::shared_ptr< Gaussian > lsst::gauss2d::Gaussians::at_ptr

(

size_t

i

)

const

Definition at line 150 of file gaussian.cc.

{ return _data.at(i); }

begin() [1/2]

Gaussians::Data::const_iterator lsst::gauss2d::Gaussians::begin ( ) const

noexcept

Definition at line 153 of file gaussian.cc.

{ return _data.cbegin(); }

begin() [2/2]

Gaussians::Data::iterator lsst::gauss2d::Gaussians::begin ( )

noexcept

Definition at line 152 of file gaussian.cc.

{ return _data.begin(); }

cbegin()

Gaussians::Data::const_iterator lsst::gauss2d::Gaussians::cbegin ( ) const

noexcept

Definition at line 154 of file gaussian.cc.

{ return _data.cbegin(); }

cend()

Gaussians::Data::const_iterator lsst::gauss2d::Gaussians::cend ( ) const

noexcept

Definition at line 158 of file gaussian.cc.

{ return _data.cend(); }

end() [1/2]

Gaussians::Data::const_iterator lsst::gauss2d::Gaussians::end ( ) const

noexcept

Definition at line 157 of file gaussian.cc.

{ return _data.cend(); }

end() [2/2]

Gaussians::Data::iterator lsst::gauss2d::Gaussians::end ( )

noexcept

Definition at line 156 of file gaussian.cc.

{ return _data.end(); }

get_data()

Gaussians::Data lsst::gauss2d::Gaussians::get_data

(

)

const

Definition at line 160 of file gaussian.cc.

{ return _data; }

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[]() [1/2]

Gaussian & lsst::gauss2d::Gaussians::operator[]

(

size_t

i

)

Definition at line 129 of file gaussian.cc.

{ return *(_data[i]); }

operator[]() [2/2]

const Gaussian & lsst::gauss2d::Gaussians::operator[]

(

size_t

i

)

const

Definition at line 130 of file gaussian.cc.

{ return *(_data[i]); }

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.

Definition at line 164 of file gaussian.cc.

                                                                                      {
    std::string str
            = type_name_str<Gaussians>(false, namespace_separator) + "(" + (name_keywords ? "data=" : "");
    str += repr_iter_ptr(_data, name_keywords, namespace_separator);
    return str + ")";
}

size()

size_t lsst::gauss2d::Gaussians::size

(

)

const

Definition at line 162 of file gaussian.cc.

{ return _data.size(); }

str()

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

overridevirtual

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

Implements lsst::gauss2d::Object.

Definition at line 171 of file gaussian.cc.

                               {
    std::string str = type_name_str<Gaussians>(true) + "(data=";
    str += str_iter_ptr(_data);
    return 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+34a971ddd9/include/lsst/gauss2d/gaussian.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/gauss2d/g9125e01d80+34a971ddd9/src/gaussian.cc