lsst::gauss2d::VectorImage< T > Class Template Reference

#include <vectorimage.h>

Inheritance diagram for lsst::gauss2d::VectorImage< T >:

Public Member Functions
	VectorImage (size_t n_rows, size_t n_cols, const T *value_init=Image< T, VectorImage< T > >::_value_default_ptr(), std::shared_ptr< const CoordinateSystem > coordsys=nullptr)
	~VectorImage ()=default
T &	_get_value_impl (size_t row, size_t col)
T &	_get_value_unchecked_impl (size_t row, size_t col)
void	add_value_unchecked_impl (size_t row, size_t col, T value)
T	get_value_unchecked_impl (size_t row, size_t col) const
void	set_value_impl (size_t row, size_t col, T value)
void	set_value_unchecked_impl (size_t row, size_t col, T value)
size_t	get_n_cols_impl () const
size_t	get_n_rows_impl () const
T &	_get_value (size_t row, size_t col)
T &	_get_value_unchecked (size_t row, size_t col)
void	_check_row_col (size_t row, size_t col) const
void	_check_row_col_impl (size_t row, size_t col) const
const CoordinateSystem &	get_coordsys () const
std::shared_ptr< const CoordinateSystem >	get_coordsys_ptr_const () const
size_t	get_n_cols () const
size_t	get_n_rows () const
size_t	get_n_rows_impl ()=delete
void	add_value (size_t row, size_t col, T value)
void	add_value_impl (size_t row, size_t col, T value)
void	add_value_unchecked (size_t row, size_t col, T value)
void	fill (T value)
void	fill_impl (T value)
T	get_value (size_t row, size_t col) const
T	get_value_impl (size_t row, size_t col) const
T	get_value_unchecked (size_t row, size_t col) const
void	set_value (size_t row, size_t col, T value)
void	set_value_unchecked (size_t row, size_t col, T value)
std::array< size_t, 2 >	shape () const
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.
Image< T, VectorImage< T > > &	operator+= (T value)
Image< T, VectorImage< T > > &	operator*= (T value)
bool	operator== (const Image &other) const
const bool	operator!= (const Image &other) const

Static Public Member Functions
static const T *	_value_default_ptr ()
static std::string_view	null_str (const std::string_view &namespace_separator)

Static Public Attributes
static constexpr T	_value_default
static constexpr std::string_view	CC_NAMESPACE_SEPARATOR
	The C++ namespace separator.
static constexpr std::string_view	NULL_STR_GENERAL
static constexpr std::string_view	PY_NAMESPACE_SEPARATOR

Detailed Description

template<typename T>
class lsst::gauss2d::VectorImage< T >

Definition at line 43 of file vectorimage.h.

Constructor & Destructor Documentation

VectorImage()

template<typename T>

lsst::gauss2d::VectorImage< T >::VectorImage ( size_t n_rows, size_t n_cols, const T * value_init = Image<T, VectorImage<T>>::_value_default_ptr(), std::shared_ptr< const CoordinateSystem > coordsys = nullptr )

inlineexplicit

Definition at line 45 of file vectorimage.h.

            : Image<T, VectorImage<T>>(coordsys), _n_rows(n_rows), _n_cols(n_cols) {
        _data.resize(n_rows);
        // No real option but to resize with vectors
        // Just reserving would cause _unchecked calls to break
        T value_init_override
                = value_init != nullptr ? *value_init : (Image<T, VectorImage<T>>::_value_default);
        for (size_t row = 0; row < _n_rows; row++) {
            _data[row].resize(n_cols, value_init_override);
        }
    }

~VectorImage()

template<typename T>

lsst::gauss2d::VectorImage< T >::~VectorImage ( )

default

Member Function Documentation

_check_row_col()

void lsst::gauss2d::Image< T, VectorImage< T > >::_check_row_col ( size_t row, size_t col ) const

inlineinherited

Definition at line 133 of file image.h.

{ return self_const()._check_row_col_impl(row, col); }

_check_row_col_impl()

void lsst::gauss2d::Image< T, VectorImage< T > >::_check_row_col_impl ( size_t row, size_t col ) const

inlineinherited

Definition at line 134 of file image.h.

                                                           {
        if (!((row < this->get_n_rows()) && (col < this->get_n_cols()))) {
            throw std::out_of_range("row,col = " + std::to_string(row) + "," + std::to_string(col)
                                    + " n_rows,n_cols = " + std::to_string(this->get_n_rows()) + ","
                                    + std::to_string(this->get_n_cols()));
        }
    }

_get_value()

T & lsst::gauss2d::Image< T, VectorImage< T > >::_get_value ( size_t row, size_t col )

inlineinherited

Definition at line 123 of file image.h.

{ return static_cast<C&>(*this)._get_value_impl(row, col); }

_get_value_impl()

template<typename T>

T & lsst::gauss2d::VectorImage< T >::_get_value_impl ( size_t row, size_t col )

inline

Definition at line 60 of file vectorimage.h.

                                               {
        // This doesn't work on vector<bool> because it's bit-packed
        // One could specialize: if constexpr (std::is_same_v<bool, T>)
        // ... if there were a workable alternative, but there isn't.
        if constexpr (std::is_same_v<bool, T>) {
            throw std::logic_error("VectorImage<bool> cannot use _get_value");
        } else {
            // TODO: Check at performance vs default implementation
            return this->_data.at(row).at(col);
        }
    }

_get_value_unchecked()

T & lsst::gauss2d::Image< T, VectorImage< T > >::_get_value_unchecked ( size_t row, size_t col )

inlineinherited

Definition at line 128 of file image.h.

                                                           {
        return self()._get_value_unchecked_impl(row, col);
    }

_get_value_unchecked_impl()

template<typename T>

T & lsst::gauss2d::VectorImage< T >::_get_value_unchecked_impl ( size_t row, size_t col )

inline

Definition at line 71 of file vectorimage.h.

                                                                {
        // See note in _get_value
        if constexpr (std::is_same_v<bool, T>) {
            throw std::logic_error("VectorImage<bool> cannot use _get_value_unchecked");
        } else {
            return this->_data[row][col];
        }
    }

_value_default_ptr()

static const T * lsst::gauss2d::Image< T, VectorImage< T > >::_value_default_ptr ( )

inlinestaticinherited

Definition at line 121 of file image.h.

{ return &_value_default; };

add_value()

void lsst::gauss2d::Image< T, VectorImage< T > >::add_value ( size_t row, size_t col, T value )

inlineinherited

Definition at line 150 of file image.h.

{ self().add_value_impl(row, col, value); }

add_value_impl()

void lsst::gauss2d::Image< T, VectorImage< T > >::add_value_impl ( size_t row, size_t col, T value )

inlineinherited

Definition at line 151 of file image.h.

{ this->_get_value(row, col) += value; }

add_value_unchecked()

void lsst::gauss2d::Image< T, VectorImage< T > >::add_value_unchecked ( size_t row, size_t col, T value )

inlineinherited

Definition at line 152 of file image.h.

                                                              {
        self().add_value_unchecked_impl(row, col, value);
    }

add_value_unchecked_impl()

template<typename T>

void lsst::gauss2d::VectorImage< T >::add_value_unchecked_impl ( size_t row, size_t col, T value )

inline

Definition at line 79 of file vectorimage.h.

{ this->_data[row][col] += value; }

fill()

void lsst::gauss2d::Image< T, VectorImage< T > >::fill ( T value )

inlineinherited

Definition at line 158 of file image.h.

{ self().fill_impl(value); }

fill_impl()

void lsst::gauss2d::Image< T, VectorImage< T > >::fill_impl ( T value )

inlineinherited

Definition at line 159 of file image.h.

                            {
        const size_t n_rows = get_n_rows();
        const size_t n_cols = get_n_cols();
        for (size_t row = 0; row < n_rows; ++row) {
            for (size_t col = 0; col < n_cols; ++col) {
                this->set_value_unchecked(row, col, value);
            }
        }
    }

get_coordsys()

const CoordinateSystem & lsst::gauss2d::Image< T, VectorImage< T > >::get_coordsys ( ) const

inlineinherited

Definition at line 142 of file image.h.

{ return _coordsys; };

get_coordsys_ptr_const()

std::shared_ptr< const CoordinateSystem > lsst::gauss2d::Image< T, VectorImage< T > >::get_coordsys_ptr_const ( ) const

inlineinherited

Definition at line 143 of file image.h.

{ return _coordsys_ptr; };

get_n_cols()

size_t lsst::gauss2d::Image< T, VectorImage< T > >::get_n_cols ( ) const

inlineinherited

Definition at line 145 of file image.h.

{ return static_cast<const C&>(*this).get_n_cols_impl(); }

get_n_cols_impl()

template<typename T>

size_t lsst::gauss2d::VectorImage< T >::get_n_cols_impl ( ) const

inline

Definition at line 84 of file vectorimage.h.

{ return _n_cols; };

get_n_rows()

size_t lsst::gauss2d::Image< T, VectorImage< T > >::get_n_rows ( ) const

inlineinherited

Definition at line 147 of file image.h.

{ return static_cast<const C&>(*this).get_n_rows_impl(); }

get_n_rows_impl() [1/2]

size_t lsst::gauss2d::Image< T, VectorImage< T > >::get_n_rows_impl ( )

deleteinherited

get_n_rows_impl() [2/2]

template<typename T>

size_t lsst::gauss2d::VectorImage< T >::get_n_rows_impl ( ) const

inline

Definition at line 85 of file vectorimage.h.

{ return _n_rows; };

get_value()

T lsst::gauss2d::Image< T, VectorImage< T > >::get_value ( size_t row, size_t col ) const

inlineinherited

Definition at line 168 of file image.h.

{ return self_const().get_value_impl(row, col); }

get_value_impl()

T lsst::gauss2d::Image< T, VectorImage< T > >::get_value_impl ( size_t row, size_t col ) const

inlineinherited

Definition at line 169 of file image.h.

                                                          {
        _check_row_col(row, col);
        return self_const().get_value_unchecked(row, col);
    }

get_value_unchecked()

T lsst::gauss2d::Image< T, VectorImage< T > >::get_value_unchecked ( size_t row, size_t col ) const

inlineinherited

Definition at line 173 of file image.h.

                                                               {
        return self_const().get_value_unchecked_impl(row, col);
    }

get_value_unchecked_impl()

template<typename T>

T lsst::gauss2d::VectorImage< T >::get_value_unchecked_impl ( size_t row, size_t col ) const

inline

Definition at line 80 of file vectorimage.h.

{ return this->_data[row][col]; }

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!=()

const bool lsst::gauss2d::Image< T, VectorImage< T > >::operator!= ( const Image< T, VectorImage< T > > & other ) const

inlineinherited

Definition at line 248 of file image.h.

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

operator*=()

Image< T, VectorImage< T > > & lsst::gauss2d::Image< T, VectorImage< T > >::operator*= ( T value )

inlineinherited

Definition at line 213 of file image.h.

                                     {
        const size_t n_rows = get_n_rows();
        const size_t n_cols = get_n_cols();
        for (size_t row = 0; row < n_rows; ++row) {
            for (size_t col = 0; col < n_cols; ++col) {
                // Avoid annoying warning for bool case
                if constexpr (std::is_same_v<T, bool>) {
                    this->set_value_unchecked(row, col, value && this->get_value_unchecked(row, col));
                } else {
                    this->set_value_unchecked(row, col, value * this->get_value_unchecked(row, col));
                }
            }
        }
        return *this;
    }

operator+=()

Image< T, VectorImage< T > > & lsst::gauss2d::Image< T, VectorImage< T > >::operator+= ( T value )

inlineinherited

Definition at line 202 of file image.h.

                                     {
        const size_t n_rows = get_n_rows();
        const size_t n_cols = get_n_cols();
        for (size_t row = 0; row < n_rows; ++row) {
            for (size_t col = 0; col < n_cols; ++col) {
                this->add_value_unchecked(row, col, value);
            }
        }
        return *this;
    }

operator==()

bool lsst::gauss2d::Image< T, VectorImage< T > >::operator== ( const Image< T, VectorImage< T > > & other ) const

inlineinherited

Definition at line 232 of file image.h.

                                              {
        if (images_compatible<T, C, T, C>(*this, other)) {
            const size_t n_rows = get_n_rows();
            const size_t n_cols = get_n_cols();
            for (size_t row = 0; row < n_rows; ++row) {
                for (size_t col = 0; col < n_cols; ++col) {
                    if (this->get_value_unchecked(row, col) != other.get_value_unchecked(row, col)) {
                        return false;
                    }
                }
            }
            return true;
        }
        return false;
    }

repr()

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

inlineoverridevirtualinherited

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

                                                                                          {
        return type_name_str<C>(false, namespace_separator) + "(" + (name_keywords ? "coordsys=" : "")
               + _coordsys.repr(name_keywords, namespace_separator) + ", " + (name_keywords ? "n_rows=" : "")
               + std::to_string(this->get_n_rows()) + ", " + (name_keywords ? "n_cols=" : "")
               + std::to_string(this->get_n_cols()) + ")";
    }

set_value()

void lsst::gauss2d::Image< T, VectorImage< T > >::set_value ( size_t row, size_t col, T value )

inlineinherited

Definition at line 177 of file image.h.

{ return self().set_value_impl(row, col, value); }

set_value_impl()

template<typename T>

void lsst::gauss2d::VectorImage< T >::set_value_impl ( size_t row, size_t col, T value )

inline

Definition at line 81 of file vectorimage.h.

{ this->_data.at(row).at(col) = value; }

set_value_unchecked()

void lsst::gauss2d::Image< T, VectorImage< T > >::set_value_unchecked ( size_t row, size_t col, T value )

inlineinherited

Definition at line 179 of file image.h.

                                                                     {
        self().set_value_unchecked_impl(row, col, value);
    }

set_value_unchecked_impl()

template<typename T>

void lsst::gauss2d::VectorImage< T >::set_value_unchecked_impl ( size_t row, size_t col, T value )

inline

Definition at line 82 of file vectorimage.h.

{ this->_data[row][col] = value; }

shape()

std::array< size_t, 2 > lsst::gauss2d::Image< T, VectorImage< T > >::shape ( ) const

inlineinherited

Definition at line 186 of file image.h.

{ return {this->get_n_rows(), this->get_n_cols()}; }

size()

size_t lsst::gauss2d::Image< T, VectorImage< T > >::size ( ) const

inlineinherited

Definition at line 188 of file image.h.

{ return this->get_n_rows() * this->get_n_cols(); };

str()

lsst.scarlet.lite.image.Image::str ( ) const

inlineoverridevirtualinherited

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

Implements lsst::gauss2d::Object.

Definition at line 197 of file image.h.

                                   {
        return type_name_str<C>(true) + "(coordsys=" + _coordsys.str() + ", n_rows="
               + std::to_string(this->get_n_rows()) + ", n_cols=" + std::to_string(this->get_n_cols()) + ")";
    }

Member Data Documentation

_value_default

T lsst::gauss2d::Image< T, VectorImage< T > >::_value_default

staticconstexprinherited

Definition at line 120 of file image.h.

CC_NAMESPACE_SEPARATOR

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

std::string_view lsst::gauss2d::Object::NULL_STR_GENERAL

staticconstexprinherited

Definition at line 46 of file object.h.

PY_NAMESPACE_SEPARATOR

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-10.0.0/Linux64/gauss2d/g2440f9efcc+8c5ae1fdc5/include/lsst/gauss2d/vectorimage.h