lsst::gauss2d::ImageArray< T, C > Class Template Reference

An array of compatible Images. More...

#include <image.h>

Inheritance diagram for lsst::gauss2d::ImageArray< T, C >:

Public Types
typedef Image< T, C >	ImageT
typedef std::vector< std::shared_ptr< C > >	Data
using	iterator = typename Data::iterator
using	const_iterator = typename Data::const_iterator

Public Member Functions
ImageT &	operator[] (size_t i)
const ImageT &	operator[] (size_t i) const
ImageT &	at (size_t i=0) const
Data::iterator	begin () noexcept
Data::iterator	end () noexcept
Data::const_iterator	cbegin () const noexcept
Data::const_iterator	cend () const noexcept
size_t	size () const
std::string	repr (bool name_keywords, std::string_view 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.
	ImageArray (const Data *data_in)

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

template<typename T, class C>
class lsst::gauss2d::ImageArray< T, C >

An array of compatible Images.

See images_compatible() for the definition of compatibility.

Template Parameters

T	The numeric type.
C	The specialized class.

Definition at line 268 of file image.h.

Member Typedef Documentation

const_iterator

template<typename T , class C >

using lsst::gauss2d::ImageArray< T, C >::const_iterator = typename Data::const_iterator

Definition at line 279 of file image.h.

Data

template<typename T , class C >

typedef std::vector<std::shared_ptr<C> > lsst::gauss2d::ImageArray< T, C >::Data

Definition at line 271 of file image.h.

ImageT

template<typename T , class C >

typedef Image<T, C> lsst::gauss2d::ImageArray< T, C >::ImageT

Definition at line 270 of file image.h.

iterator

template<typename T , class C >

using lsst::gauss2d::ImageArray< T, C >::iterator = typename Data::iterator

Definition at line 278 of file image.h.

Constructor & Destructor Documentation

ImageArray()

template<typename T , class C >

lsst::gauss2d::ImageArray< T, C >::ImageArray ( const Data * data_in )

inlineexplicit

Definition at line 301 of file image.h.

                                             {
        if (data_in != nullptr) {
            const Data& data = *data_in;
            size_t n_data = data.size();
            if (n_data > 0) {
                _images.resize(n_data);
                for (size_t i = 0; i < n_data; ++i) {
                    if (data[i] == nullptr) {
                        throw std::invalid_argument("ImageArray data[" + std::to_string(i)
                                                    + "] can't be null");
                    }
                    if (!images_compatible<T, C, T, C>(*data[i], *data[0])) {
                        throw std::invalid_argument("ImageArray data[" + std::to_string(i)
                                                    + "] must be compatible with data[0] (and all others)");
                    }
                    _images[i] = data[i];
                }
            }
        }
    };

Member Function Documentation

at()

template<typename T , class C >

ImageT & lsst::gauss2d::ImageArray< T, C >::at ( size_t i = 0 ) const

inline

Definition at line 276 of file image.h.

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

begin()

template<typename T , class C >

Data::iterator lsst::gauss2d::ImageArray< T, C >::begin ( )

inlinenoexcept

Definition at line 281 of file image.h.

{ return _images.begin(); }

cbegin()

template<typename T , class C >

Data::const_iterator lsst::gauss2d::ImageArray< T, C >::cbegin ( ) const

inlinenoexcept

Definition at line 284 of file image.h.

{ return _images.cbegin(); };

cend()

template<typename T , class C >

Data::const_iterator lsst::gauss2d::ImageArray< T, C >::cend ( ) const

inlinenoexcept

Definition at line 285 of file image.h.

{ return _images.begin(); };

end()

template<typename T , class C >

Data::iterator lsst::gauss2d::ImageArray< T, C >::end ( )

inlinenoexcept

Definition at line 282 of file image.h.

{ return _images.end(); };

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]

template<typename T , class C >

ImageT & lsst::gauss2d::ImageArray< T, C >::operator[] ( size_t i )

inline

Definition at line 273 of file image.h.

{ return *(_images[i]); }

operator[]() [2/2]

template<typename T , class C >

const ImageT & lsst::gauss2d::ImageArray< T, C >::operator[] ( size_t i ) const

inline

Definition at line 274 of file image.h.

{ return *(_images[i]); }

repr()

template<typename T , class C >

std::string lsst::gauss2d::ImageArray< T, C >::repr ( bool name_keywords, std::string_view namespace_separator ) const

inlineoverridevirtual

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 289 of file image.h.

                                                                                          {
        std::string str = type_name_str<ImageArray<T, C>>(false, namespace_separator) + "("
                          + (name_keywords ? "data=" : "")
                          + repr_iter_ptr(_images, name_keywords, namespace_separator) + ")";
        return str;
    }

size()

template<typename T , class C >

size_t lsst::gauss2d::ImageArray< T, C >::size ( ) const

inline

Definition at line 287 of file image.h.

{ return _images.size(); }

str()

template<typename T , class C >

std::string lsst::gauss2d::ImageArray< T, C >::str ( ) const

inlineoverridevirtual

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

Implements lsst::gauss2d::Object.

Definition at line 296 of file image.h.

                                   {
        std::string str = type_name_str<ImageArray<T, C>>(true) + "(data=" + str_iter_ptr(_images) + ")";
        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 file:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/gauss2d/g9125e01d80+a8ce1bb630/include/lsst/gauss2d/image.h