lsst::gauss2d::detail::GradientsExtra< t, Data, Indices > Class Template Reference

#include <evaluate.h>

Inheritance diagram for lsst::gauss2d::detail::GradientsExtra< t, Data, Indices >:

Public Member Functions
	GradientsExtra (const Image< idx_type, Indices > &param_map_in, const Image< t, Data > &param_factor_in, std::shared_ptr< ImageArray< t, Data > > output, size_t n_gauss)
	GradientsExtra ()=delete
void	add_index_to_set (size_t g, std::set< size_t > &set)
void	add (size_t g, size_t dim1, size_t dim2, const ValuesGauss &gradients)
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

template<typename t, class Data, class Indices>
class lsst::gauss2d::detail::GradientsExtra< t, Data, Indices >

Definition at line 330 of file evaluate.h.

Constructor & Destructor Documentation

GradientsExtra() [1/2]

template<typename t , class Data , class Indices >

lsst::gauss2d::detail::GradientsExtra< t, Data, Indices >::GradientsExtra ( const Image< idx_type, Indices > & param_map_in, const Image< t, Data > & param_factor_in, std::shared_ptr< ImageArray< t, Data > > output, size_t n_gauss )

inline

Definition at line 332 of file evaluate.h.

            : _param_map(param_map_in), _param_factor(param_factor_in), _output(output) {
        if(output == nullptr) {
            throw std::invalid_argument("GradientsExtra output must not be a nullptr");
        }
        const auto n_extra_map_rows = param_map_in.get_n_rows();
        const auto n_extra_fac_rows = param_factor_in.get_n_rows();
        const auto n_extra_map_cols = param_map_in.get_n_cols();
        const auto n_extra_fac_cols = param_factor_in.get_n_cols();
        std::string errmsg = "";
        if (n_extra_map_rows != n_gauss) {
            errmsg += "extra_param_map n_rows=" + std::to_string(n_extra_map_rows)
                      + " != n_gauss=" + std::to_string(n_gauss) + ". ";
        }
        if (n_extra_fac_rows != n_gauss) {
            errmsg += "extra_param_factor n_rows=" + std::to_string(n_extra_fac_rows)
                      + " != n_gauss=" + std::to_string(n_gauss) + ". ";
        }
        if (n_extra_map_cols != N_EXTRA_MAP) {
            errmsg += "extra_param_map n_cols=" + std::to_string(n_extra_map_cols) + " != 2. ";
        }
        if (n_extra_fac_cols != N_EXTRA_FACTOR) {
            errmsg += "extra_param_factor n_cols=" + std::to_string(n_extra_fac_cols) + " != 3. ";
        }
        if (!errmsg.empty()) throw std::runtime_error(errmsg);
    }

GradientsExtra() [2/2]

template<typename t , class Data , class Indices >

lsst::gauss2d::detail::GradientsExtra< t, Data, Indices >::GradientsExtra ( )

delete

Member Function Documentation

add()

template<typename t , class Data , class Indices >

void lsst::gauss2d::detail::GradientsExtra< t, Data, Indices >::add ( size_t g, size_t dim1, size_t dim2, const ValuesGauss & gradients )

inline

Definition at line 364 of file evaluate.h.

                                                                                      {
        // Reset g_check to zero once g rolls back to zero itself
        _g_check *= (g != 0);
        const bool to_add = g == _param_map.get_value(_g_check, 0);
        const auto idx = _param_map.get_value(g, 1);
        double value = gradients.L * _param_factor.get_value(g, 0)
                       + gradients.sigma_x * _param_factor.get_value(g, 1)
                       + gradients.sigma_y * _param_factor.get_value(g, 2);
        (*_output)[idx].add_value_unchecked(dim1, dim2, value);
        _g_check += to_add;
    }

add_index_to_set()

template<typename t , class Data , class Indices >

void lsst::gauss2d::detail::GradientsExtra< t, Data, Indices >::add_index_to_set ( size_t g, std::set< size_t > & set )

inline

Definition at line 362 of file evaluate.h.

{ set.insert(_param_map.get_value(g, 1)); }

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;
    }

repr()

template<typename t , class Data , class Indices >

std::string lsst::gauss2d::detail::GradientsExtra< t, Data, Indices >::repr ( bool name_keywords = false, std::string_view namespace_separator = Object::CC_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 376 of file evaluate.h.

                                                                                                       {
        bool is_kw = name_keywords;
        std::string rval = (  //
                type_name_str<GradientsExtra<t, Data, Indices>>(false, namespace_separator) + "("
                + (is_kw ? "param_map=" : "") + _param_map.repr(is_kw, namespace_separator) + ", "
                + (is_kw ? "param_factor=" : "") + _param_factor.repr(is_kw, namespace_separator) + ", "
                + (is_kw ? "output=" : "") + _output->repr(is_kw, namespace_separator) + ", "
                + (is_kw ? "n_gauss=" : "") + std::to_string(_param_map.get_n_rows()) + ")"  //
        );
        return rval;
    }

str()

template<typename t , class Data , class Indices >

std::string lsst::gauss2d::detail::GradientsExtra< t, Data, Indices >::str ( ) const

inlineoverridevirtual

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

Implements lsst::gauss2d::Object.

Definition at line 388 of file evaluate.h.

                                   {
        std::string rval = (                                                  //
                type_name_str<GradientsExtra<t, Data, Indices>>(true) + "("   //
                + "param_map=" + _param_map.str() + ", "                      //
                + "param_factor=" + _param_factor.str() + ", "                //
                + "output=" + _output->str() + ", "                            //
                + "n_gauss=" + std::to_string(_param_map.get_n_rows()) + ")"  //
        );
        return rval;
    }

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/evaluate.h