lsst::gauss2d::ConvolvedGaussians Class Reference

A collection of ConvolvedGaussian objects. More...

#include <gaussian.h>

Inheritance diagram for lsst::gauss2d::ConvolvedGaussians:

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

Public Member Functions
	ConvolvedGaussians (std::optional< const Data > data)
	ConvolvedGaussians (std::vector< std::optional< const Data > > data)
ConvolvedGaussian &	at (size_t i) const
const ConvolvedGaussian &	at_const (size_t i) const
std::shared_ptr< ConvolvedGaussian >	at_ptr (size_t i) const
Data::iterator	begin () noexcept
Data::iterator	end () noexcept
Data::const_iterator	begin () const noexcept
Data::const_iterator	end () const noexcept
Data::const_iterator	cbegin () const 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.
ConvolvedGaussian &	operator[] (size_t i)
const ConvolvedGaussian &	operator[] (size_t i) 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 collection of ConvolvedGaussian objects.

This class exists largely for the same reason as Gaussians, and to be passed to evaluators.

Definition at line 249 of file gaussian.h.

Member Typedef Documentation

const_iterator

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

Definition at line 262 of file gaussian.h.

Data

typedef std::vector<std::shared_ptr<ConvolvedGaussian> > lsst::gauss2d::ConvolvedGaussians::Data

Definition at line 251 of file gaussian.h.

iterator

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

Definition at line 261 of file gaussian.h.

Constructor & Destructor Documentation

ConvolvedGaussians() [1/2]

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

explicit

Definition at line 184 of file gaussian.cc.

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

ConvolvedGaussians() [2/2]

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

explicit

Definition at line 193 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()

ConvolvedGaussian & lsst::gauss2d::ConvolvedGaussians::at

(

size_t

i

)

const

Definition at line 250 of file gaussian.cc.

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

at_const()

const ConvolvedGaussian & lsst::gauss2d::ConvolvedGaussians::at_const

(

size_t

i

)

const

Definition at line 251 of file gaussian.cc.

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

at_ptr()

std::shared_ptr< ConvolvedGaussian > lsst::gauss2d::ConvolvedGaussians::at_ptr

(

size_t

i

)

const

Definition at line 252 of file gaussian.cc.

{ return _data.at(i); }

begin() [1/2]

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

noexcept

Definition at line 257 of file gaussian.cc.

                                                                                       {
    return _data.begin();
}

begin() [2/2]

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

noexcept

Definition at line 254 of file gaussian.cc.

{ return _data.begin(); }

cbegin()

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

noexcept

Definition at line 264 of file gaussian.cc.

                                                                                        {
    return _data.begin();
}

cend()

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

noexcept

Definition at line 267 of file gaussian.cc.

                                                                                      {
    return _data.cend();
}

end() [1/2]

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

noexcept

Definition at line 260 of file gaussian.cc.

                                                                                     {
    return _data.cend();
}

end() [2/2]

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

noexcept

Definition at line 255 of file gaussian.cc.

{ return _data.end(); }

get_data()

ConvolvedGaussians::Data lsst::gauss2d::ConvolvedGaussians::get_data

(

)

const

Definition at line 271 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]

ConvolvedGaussian & lsst::gauss2d::ConvolvedGaussians::operator[]

(

size_t

i

)

Definition at line 288 of file gaussian.cc.

{ return *(_data[i]); }

operator[]() [2/2]

const ConvolvedGaussian & lsst::gauss2d::ConvolvedGaussians::operator[]

(

size_t

i

)

const

Definition at line 289 of file gaussian.cc.

{ return *(_data[i]); }

repr()

std::string lsst::gauss2d::ConvolvedGaussians::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 275 of file gaussian.cc.

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

size()

size_t lsst::gauss2d::ConvolvedGaussians::size

(

)

const

Definition at line 273 of file gaussian.cc.

{ return _data.size(); }

str()

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

overridevirtual

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

Implements lsst::gauss2d::Object.

Definition at line 282 of file gaussian.cc.

                                        {
    std::string str = type_name_str<ConvolvedGaussians>(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