lsst::gauss2d::fit::LinearSersicMixInterpolator Class Reference

A SersicMixInterpolator that uses linear interpolation between knots. More...

#include <linearsersicmixinterpolator.h>

Inheritance diagram for lsst::gauss2d::fit::LinearSersicMixInterpolator:

Public Member Functions
	LinearSersicMixInterpolator (unsigned short order=SERSICMIX_ORDER_DEFAULT)
	~LinearSersicMixInterpolator ()
std::vector< IntegralSize >	get_integralsizes (double sersicindex) const override
	Get the vector of IntegralSize values for a given Sersic index.
std::vector< IntegralSize >	get_integralsizes_derivs (double sersicindex) const override
const std::vector< SersicMixValues > &	get_knots () const
	The knot positions and values.
InterpType	get_interptype () const override
unsigned short	get_order () const override
double	get_sersicindex_min () const
double	get_sersicindex_max () 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

A SersicMixInterpolator that uses linear interpolation between knots.

Definition at line 11 of file linearsersicmixinterpolator.h.

Constructor & Destructor Documentation

LinearSersicMixInterpolator()

lsst::gauss2d::fit::LinearSersicMixInterpolator::LinearSersicMixInterpolator ( unsigned short order = SERSICMIX_ORDER_DEFAULT )

explicit

Definition at line 13 of file linearsersicmixinterpolator.cc.

        : _order(order),
          _knots(get_sersic_mix_knots(order)),
          _sersicindex_min(_knots[0].sersicindex),
          _sersicindex_max(_knots.back().sersicindex) {}

~LinearSersicMixInterpolator()

lsst::gauss2d::fit::LinearSersicMixInterpolator::~LinearSersicMixInterpolator

(

)

Definition at line 19 of file linearsersicmixinterpolator.cc.

{}

Member Function Documentation

get_integralsizes()

std::vector< IntegralSize > lsst::gauss2d::fit::LinearSersicMixInterpolator::get_integralsizes ( double sersicindex ) const

overridevirtual

Get the vector of IntegralSize values for a given Sersic index.

Parameters

sersicindex

The Sersic index value.

Returns

The vector of IntegralSize values for sersicindex.

Implements lsst::gauss2d::fit::SersicMixInterpolator.

Definition at line 21 of file linearsersicmixinterpolator.cc.

                                                                                               {
    if (!((sersicindex >= _sersicindex_min) && (sersicindex <= _sersicindex_max))) {
        throw std::invalid_argument("sersicindex=" + to_string_float(sersicindex)
                                    + " !(>=" + to_string_float(_sersicindex_min)
                                    + "&& <=" + to_string_float(_sersicindex_max));
    }
 
    if (sersicindex == _sersicindex_min)
        return _knots[0].values;
    else if (sersicindex == _sersicindex_max)
        return _knots.back().values;
 
    auto found = std::lower_bound(_knots.begin(), _knots.end(), sersicindex);
    auto high = *found;
    auto low = *(--found);
 
    if (sersicindex == high.sersicindex) return high.values;
    double frac_low = (high.sersicindex - sersicindex) / (high.sersicindex - low.sersicindex);
    if (!((frac_low >= 0) && (frac_low <= 1))) {
        throw std::logic_error("Got invalid frac_low=" + std::to_string(frac_low)
                               + " with n, lo, hi=" + to_string_float(sersicindex) + ","
                               + to_string_float(low.sersicindex) + "," + to_string_float(high.sersicindex));
    }
    double frac_high = 1 - frac_low;
 
    std::vector<IntegralSize> result;
    result.reserve(_order);
    for (size_t i = 0; i < _order; ++i) {
        result.push_back(IntegralSize(frac_low * low.values[i].integral + frac_high * high.values[i].integral,
                                      frac_low * low.values[i].sigma + frac_high * high.values[i].sigma));
    }
 
    return result;
}

get_integralsizes_derivs()

std::vector< IntegralSize > lsst::gauss2d::fit::LinearSersicMixInterpolator::get_integralsizes_derivs ( double sersicindex ) const

overridevirtual

Implements lsst::gauss2d::fit::SersicMixInterpolator.

Definition at line 56 of file linearsersicmixinterpolator.cc.

                                                                                                      {
    if (!((sersicindex >= _sersicindex_min) && (sersicindex <= _sersicindex_max))) {
        throw std::invalid_argument("sersicindex=" + to_string_float(sersicindex)
                                    + " !(>=" + to_string_float(_sersicindex_min)
                                    + "&& <=" + to_string_float(_sersicindex_max));
    }
 
    auto found = sersicindex == _sersicindex_min
                         ? ++_knots.begin()
                         : ((sersicindex == _sersicindex_max)
                                    ? --_knots.end()
                                    : std::upper_bound(_knots.begin(), _knots.end(), sersicindex));
    auto& high = *found;
    auto& low = *(--found);
 
    double dn_inv = 1. / (high.sersicindex - low.sersicindex);
 
    std::vector<IntegralSize> result;
    result.reserve(_order);
    for (size_t i = 0; i < _order; ++i) {
        result.push_back(IntegralSize((high.values[i].integral - low.values[i].integral) * dn_inv,
                                      (high.values[i].sigma - low.values[i].sigma) * dn_inv));
    }
 
    return result;
}

get_interptype()

InterpType lsst::gauss2d::fit::LinearSersicMixInterpolator::get_interptype ( ) const

overridevirtual

Implements lsst::gauss2d::fit::SersicMixInterpolator.

Definition at line 83 of file linearsersicmixinterpolator.cc.

{ return InterpType::linear; }

get_knots()

const std::vector< SersicMixValues > & lsst::gauss2d::fit::LinearSersicMixInterpolator::get_knots

(

)

const

The knot positions and values.

Definition at line 85 of file linearsersicmixinterpolator.cc.

{ return _knots; }

get_order()

unsigned short lsst::gauss2d::fit::LinearSersicMixInterpolator::get_order ( ) const

overridevirtual

Implements lsst::gauss2d::fit::SersicMixInterpolator.

Definition at line 87 of file linearsersicmixinterpolator.cc.

{ return _order; }

get_sersicindex_max()

double lsst::gauss2d::fit::LinearSersicMixInterpolator::get_sersicindex_max

(

)

const

Definition at line 91 of file linearsersicmixinterpolator.cc.

{ return _sersicindex_max; }

get_sersicindex_min()

double lsst::gauss2d::fit::LinearSersicMixInterpolator::get_sersicindex_min

(

)

const

Definition at line 89 of file linearsersicmixinterpolator.cc.

{ return _sersicindex_min; }

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

std::string lsst::gauss2d::fit::LinearSersicMixInterpolator::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 93 of file linearsersicmixinterpolator.cc.

                                                                                        {
    return type_name_str<LinearSersicMixInterpolator>(false, namespace_separator) + "("
           + (name_keywords ? "order=" : "") + std::to_string(_order) + ")";
}

str()

std::string lsst::gauss2d::fit::LinearSersicMixInterpolator::str ( ) const

overridevirtual

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

Implements lsst::gauss2d::Object.

Definition at line 99 of file linearsersicmixinterpolator.cc.

                                                 {
    return type_name_str<LinearSersicMixInterpolator>(true) + "(order=" + std::to_string(_order) + ")";
}

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_fit/gb58c049af0+ace264a4f2/include/lsst/gauss2d/fit/linearsersicmixinterpolator.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/gauss2d_fit/gb58c049af0+ace264a4f2/src/linearsersicmixinterpolator.cc