lsst::gauss2d::fit::LinearIntegralModel Class Reference

An IntegralModel with a single linear IntegralParameterD per Channel. More...

#include <linearintegralmodel.h>

Inheritance diagram for lsst::gauss2d::fit::LinearIntegralModel:

Public Types
typedef std::pair< std::reference_wrapper< const Channel >, std::shared_ptr< IntegralParameterD > >	ChannelIntegralParameterD
typedef std::vector< ChannelIntegralParameterD >	Data

Public Member Functions
	LinearIntegralModel (const Data *data_in)
	Construct a LinearIntegralModel from input Data.
	~LinearIntegralModel ()
std::shared_ptr< IntegralParameterD >	at (const Channel &channel)
	Get the IntegralParameterD for the given Channel.
std::shared_ptr< const IntegralParameterD >	at (const Channel &channel) const
	Get the (const) IntegralParameterD for the given Channel.
Data::iterator	begin () noexcept
Data::const_iterator	cbegin () const noexcept
Data::iterator	end () noexcept
Data::const_iterator	cend () const noexcept
std::vector< std::reference_wrapper< const Channel > >	get_channels () const override
	Get the set of channels this instance is applicable for.
double	get_integral (const Channel &channel) const override
	Get the value of the integral in a single Channel.
std::vector< std::pair< ParamBaseCRef, ExtraParamFactorValues > >	get_integral_derivative_factors (const Channel &channel) const override
	Return the partial derivative of the model w.r.t.
ParamRefs &	get_parameters (ParamRefs &params, ParamFilter *filter=nullptr) const override
	Add Parameter refs matching the filter to a vector, in order.
ParamCRefs &	get_parameters_const (ParamCRefs &params, ParamFilter *filter=nullptr) const override
	Same as get_parameters(), but for const refs.
size_t	size () const
	Return the size of Data (number of Channel/IntegralParameterD instances)
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.
const bool	operator< (const IntegralModel &m) const
const bool	operator== (const IntegralModel &m) const
const bool	operator!= (const IntegralModel &m) const
ParamRefs	get_parameters_new (ParamFilter *filter=nullptr) const
	Same as get_parameters(), but returning a new vector.
ParamCRefs	get_parameters_const_new (ParamFilter *filter=nullptr) const
	Same as get_parameters_const(), but returning a new vector.

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

An IntegralModel with a single linear IntegralParameterD per Channel.

Definition at line 16 of file linearintegralmodel.h.

Member Typedef Documentation

ChannelIntegralParameterD

typedef std::pair<std::reference_wrapper<const Channel>, std::shared_ptr<IntegralParameterD> > lsst::gauss2d::fit::LinearIntegralModel::ChannelIntegralParameterD

Definition at line 19 of file linearintegralmodel.h.

Data

typedef std::vector<ChannelIntegralParameterD> lsst::gauss2d::fit::LinearIntegralModel::Data

Definition at line 20 of file linearintegralmodel.h.

Constructor & Destructor Documentation

LinearIntegralModel()

lsst::gauss2d::fit::LinearIntegralModel::LinearIntegralModel ( const Data * data_in )

explicit

Construct a LinearIntegralModel from input Data.

Parameters

data_in

A map of IntegralParameterD shared_ptr to move for each Channel.

Note

No default initialization is provided, so data_in must not be null.

Definition at line 12 of file linearintegralmodel.cc.

                                                            {
    if (data_in != nullptr) {
        size_t idx = 0;
        for (const auto& datum : *data_in) {
            if (datum.second == nullptr) {
                throw std::runtime_error("LinearIntegralModel data[" + std::to_string(idx)
                                         + "] can't be null");
            }
            if (_map.find(datum.first) != _map.end()) {
                throw std::runtime_error("LinearIntegralModel data[" + std::to_string(idx)
                                         + "] channel=" + datum.first.get().str() + " duplicated");
            }
            _data.emplace_back(datum.first, datum.second);
            _map.insert(_data.back());
            idx++;
        }
    } else {
        _data.emplace_back(Channel::NONE(), std::make_shared<IntegralParameterD>(1));
        _map.insert(_data.back());
    }
}

~LinearIntegralModel()

lsst::gauss2d::fit::LinearIntegralModel::~LinearIntegralModel

(

)

Definition at line 33 of file linearintegralmodel.cc.

{};

Member Function Documentation

at() [1/2]

std::shared_ptr< IntegralParameterD > lsst::gauss2d::fit::LinearIntegralModel::at

(

const Channel &

channel

)

Get the IntegralParameterD for the given Channel.

Definition at line 50 of file linearintegralmodel.cc.

                                                                                {
    return _map.at(channel);
}

at() [2/2]

std::shared_ptr< const IntegralParameterD > lsst::gauss2d::fit::LinearIntegralModel::at

(

const Channel &

channel

)

const

Get the (const) IntegralParameterD for the given Channel.

Definition at line 54 of file linearintegralmodel.cc.

                                                                                            {
    return _map.at(channel);
}

begin()

LinearIntegralModel::Data::iterator lsst::gauss2d::fit::LinearIntegralModel::begin ( )

noexcept

Definition at line 58 of file linearintegralmodel.cc.

{ return _data.begin(); }

cbegin()

LinearIntegralModel::Data::const_iterator lsst::gauss2d::fit::LinearIntegralModel::cbegin ( ) const

noexcept

Definition at line 59 of file linearintegralmodel.cc.

                                                                                          {
    return _data.begin();
}

cend()

LinearIntegralModel::Data::const_iterator lsst::gauss2d::fit::LinearIntegralModel::cend ( ) const

noexcept

Definition at line 64 of file linearintegralmodel.cc.

                                                                                        {
    return _data.cend();
}

end()

LinearIntegralModel::Data::iterator lsst::gauss2d::fit::LinearIntegralModel::end ( )

noexcept

Definition at line 63 of file linearintegralmodel.cc.

{ return _data.end(); }

get_channels()

std::vector< std::reference_wrapper< const Channel > > lsst::gauss2d::fit::LinearIntegralModel::get_channels ( ) const

overridevirtual

Get the set of channels this instance is applicable for.

Note

Implementers must return a set (all unique items). This cannot be enforced (yet).

Implements lsst::gauss2d::fit::Chromatic.

Definition at line 35 of file linearintegralmodel.cc.

                                                                                       {
    std::vector<std::reference_wrapper<const Channel>> rval = {};
    for (auto& datum : _data) rval.emplace_back(datum.first);
    return rval;
}

get_integral()

double lsst::gauss2d::fit::LinearIntegralModel::get_integral ( const Channel & channel ) const

overridevirtual

Get the value of the integral in a single Channel.

Implements lsst::gauss2d::fit::IntegralModel.

Definition at line 41 of file linearintegralmodel.cc.

                                                                     {
    return _map.at(channel)->get_value();
}

get_integral_derivative_factors()

std::vector< std::pair< ParamBaseCRef, ExtraParamFactorValues > > lsst::gauss2d::fit::LinearIntegralModel::get_integral_derivative_factors ( const Channel & channel ) const

overridevirtual

Return the partial derivative of the model w.r.t.

each metaparameter.

This is generally needed only for nonlinear Parameter instances.

Parameters

channel

The Channel to return derivatives for.

Returns

A vector of Parameter/derivative pairs, with values ordered as specified in GaussianEvaluator (L, sigma_x, sigma_y).

Implements lsst::gauss2d::fit::IntegralModel.

Definition at line 46 of file linearintegralmodel.cc.

                                                                                 {
    return {};
}

get_parameters()

ParamRefs & lsst::gauss2d::fit::LinearIntegralModel::get_parameters ( ParamRefs & params, ParamFilter * filter = nullptr ) const

overridevirtual

Add Parameter refs matching the filter to a vector, in order.

Parameters

params	The vector to add to.
filter	The filter to apply to this Object's parameters.

Returns

A ref to params (for method chaining)

Implements lsst::gauss2d::fit::Parametric.

Definition at line 68 of file linearintegralmodel.cc.

                                                                                           {
    for (const auto& p : _data) insert_param_channel(p.first, *p.second, params, filter);
    return params;
}

get_parameters_const()

ParamCRefs & lsst::gauss2d::fit::LinearIntegralModel::get_parameters_const ( ParamCRefs & params, ParamFilter * filter = nullptr ) const

overridevirtual

Same as get_parameters(), but for const refs.

Implements lsst::gauss2d::fit::Parametric.

Definition at line 72 of file linearintegralmodel.cc.

                                                                                                   {
    for (const auto& p : _data) insert_param_channel(p.first, *p.second, params, filter);
    return params;
}

get_parameters_const_new()

ParamCRefs lsst::gauss2d::fit::Parametric::get_parameters_const_new ( ParamFilter * filter = nullptr ) const

inlineinherited

Same as get_parameters_const(), but returning a new vector.

Definition at line 33 of file parametric.h.

                                                                             {
        ParamCRefs params{};
        get_parameters_const(params, filter);
        return params;
    }

get_parameters_new()

ParamRefs lsst::gauss2d::fit::Parametric::get_parameters_new ( ParamFilter * filter = nullptr ) const

inlineinherited

Same as get_parameters(), but returning a new vector.

Definition at line 27 of file parametric.h.

                                                                      {
        ParamRefs params{};
        get_parameters(params, filter);
        return params;
    }

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::fit::LinearIntegralModel::operator!= ( const IntegralModel & m ) const

inline

Definition at line 60 of file linearintegralmodel.h.

{ return &(*this) != &m; };

operator<()

const bool lsst::gauss2d::fit::LinearIntegralModel::operator< ( const IntegralModel & m ) const

inline

Definition at line 58 of file linearintegralmodel.h.

{ return &(*this) < &m; };

operator==()

const bool lsst::gauss2d::fit::LinearIntegralModel::operator== ( const IntegralModel & m ) const

inline

Definition at line 59 of file linearintegralmodel.h.

{ return &(*this) == &m; };

repr()

std::string lsst::gauss2d::fit::LinearIntegralModel::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 79 of file linearintegralmodel.cc.

                                                                                                {
    std::string s = type_name_str<LinearIntegralModel>(false, namespace_separator) + "("
                    + (name_keywords ? "data=" : "") + "{";
    for (const auto& datum : _data) {
        s += datum.first.get().repr(name_keywords, namespace_separator) + ": "
             + datum.second->repr(name_keywords, namespace_separator) + ",";
    }
    return s + "})";
}

size()

size_t lsst::gauss2d::fit::LinearIntegralModel::size

(

)

const

Return the size of Data (number of Channel/IntegralParameterD instances)

Definition at line 77 of file linearintegralmodel.cc.

{ return _data.size(); }

str()

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

overridevirtual

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

Implements lsst::gauss2d::Object.

Definition at line 89 of file linearintegralmodel.cc.

                                         {
    std::string s = type_name_str<LinearIntegralModel>(true) + "(data={";
    for (const auto& datum : _data) {
        s += datum.first.get().str() + ": " + datum.second->str() + ",";
    }
    return s + "})";
}

Member Data Documentation

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 = "None"

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 files:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-10.0.0/Linux64/gauss2d_fit/gb58c049af0+f03b321e39/include/lsst/gauss2d/fit/linearintegralmodel.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-10.0.0/Linux64/gauss2d_fit/gb58c049af0+f03b321e39/src/linearintegralmodel.cc