lsst::gauss2d::fit::SersicModelIntegral Class Reference

Inheritance diagram for lsst::gauss2d::fit::SersicModelIntegral:

Public Member Functions
	SersicModelIntegral (const Channel &channel, const std::shared_ptr< const IntegralModel > integralmodel, const std::shared_ptr< const SersicMixComponentIndexParameterD > sersicindex, unsigned short index)
	~SersicModelIntegral ()
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.
double	get_integralratio () const
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.
double	get_value () const override
void	set_value (double value) override
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.
virtual bool	operator== (const GaussianIntegral &other) const
virtual bool	operator!= (const GaussianIntegral &other) 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 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 = "."
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 = "."

Protected Attributes
const Channel &	_channel
const std::shared_ptr< const IntegralModel >	_integralmodel

Detailed Description

Definition at line 90 of file sersicmixcomponent.cc.

Constructor & Destructor Documentation

SersicModelIntegral()

lsst::gauss2d::fit::SersicModelIntegral::SersicModelIntegral ( const Channel & channel, const std::shared_ptr< const IntegralModel > integralmodel, const std::shared_ptr< const SersicMixComponentIndexParameterD > sersicindex, unsigned short index )

inline

Definition at line 92 of file sersicmixcomponent.cc.

            : GaussianModelIntegral(channel, integralmodel),
              _sersicindex(std::move(sersicindex)),
              _index(index) {
        if (_sersicindex == nullptr) throw std::invalid_argument("sersicindex must not be null");
        if (!(_index < _sersicindex->get_order())) {
            throw std::invalid_argument("index=" + std::to_string(_index) + "!< sersicindex->get_order()="
                                        + std::to_string(_sersicindex->get_order()));
        }
    }

~SersicModelIntegral()

lsst::gauss2d::fit::SersicModelIntegral::~SersicModelIntegral ( )

inline

Definition at line 105 of file sersicmixcomponent.cc.

{};

Member Function Documentation

get_channels()

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

inlineoverridevirtual

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 107 of file sersicmixcomponent.cc.

{ return {_channel}; }

get_integral()

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

inlineoverridevirtual

Get the value of the integral in a single Channel.

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

Definition at line 109 of file sersicmixcomponent.cc.

                                                               {
        if (channel != _channel) {
            throw std::invalid_argument("channel=" + channel.str() + " != this->_channel=" + _channel.str());
        }
        return get_value();
    }

get_integral_derivative_factors()

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

inlineoverridevirtual

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 115 of file sersicmixcomponent.cc.

                                                   {
        // TODO: Refactor this?
        return {};
    }

get_integralratio()

double lsst::gauss2d::fit::SersicModelIntegral::get_integralratio ( ) const

inline

Definition at line 121 of file sersicmixcomponent.cc.

{ return _sersicindex->get_integralratio(_index); }

get_parameters()

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

inlineoverridevirtual

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 123 of file sersicmixcomponent.cc.

                                                                                               {
        return _integralmodel->get_parameters(params, filter);
    }

get_parameters_const()

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

inlineoverridevirtual

Same as get_parameters(), but for const refs.

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

Definition at line 127 of file sersicmixcomponent.cc.

                                                                                                       {
        return _integralmodel->get_parameters_const(params, filter);
    }

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

get_value()

double lsst::gauss2d::fit::SersicModelIntegral::get_value ( ) const

inlineoverridevirtual

Reimplemented from lsst::gauss2d::fit::GaussianModelIntegral.

Definition at line 131 of file sersicmixcomponent.cc.

{ return get_integralratio() * _integralmodel->get_integral(_channel); }

null_str() [1/2]

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

null_str() [2/2]

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

virtual bool lsst::gauss2d::GaussianIntegral::operator!= ( const GaussianIntegral & other ) const

inlinevirtualinherited

Definition at line 62 of file gaussian.h.

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

operator==()

virtual bool lsst::gauss2d::GaussianIntegral::operator== ( const GaussianIntegral & other ) const

inlinevirtualinherited

Definition at line 59 of file gaussian.h.

                                                                 {
        return this->get_value() == other.get_value();
    }

repr()

std::string lsst::gauss2d::fit::SersicModelIntegral::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.

Reimplemented from lsst::gauss2d::fit::GaussianModelIntegral.

Definition at line 134 of file sersicmixcomponent.cc.

                                                                                          {
        return type_name_str<SersicModelIntegral>(false, namespace_separator) + ")"
               + (name_keywords ? "channel=" : "") + _channel.repr(name_keywords, namespace_separator) + ", "
               + (name_keywords ? "integralmodel=" : "")
               + _integralmodel->repr(name_keywords, namespace_separator) + ", "
               + (name_keywords ? "sersicindex=" : "")
               + _sersicindex->repr(name_keywords, namespace_separator) + ", "
               + (name_keywords ? "index=" : "") + std::to_string(_index) + ")";
    }

set_value()

void lsst::gauss2d::fit::SersicModelIntegral::set_value ( double value )

inlineoverridevirtual

Reimplemented from lsst::gauss2d::fit::GaussianModelIntegral.

Definition at line 132 of file sersicmixcomponent.cc.

{ throw std::runtime_error("Can't set on SersicModelIntegral"); }

str()

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

inlineoverridevirtual

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

Reimplemented from lsst::gauss2d::fit::GaussianModelIntegral.

Definition at line 144 of file sersicmixcomponent.cc.

                                   {
        return type_name_str<SersicModelIntegral>(true) + "(channel=" + _channel.str()
               + ", integralmodel=" + _integralmodel->str() + ", sersicindex=" + _sersicindex->str()
               + ", index=" + std::to_string(_index) + ")";
    }

Member Data Documentation

_channel

const Channel& lsst::gauss2d::fit::GaussianModelIntegral::_channel

protectedinherited

Definition at line 35 of file gaussianmodelintegral.h.

_integralmodel

const std::shared_ptr<const IntegralModel> lsst::gauss2d::fit::GaussianModelIntegral::_integralmodel

protectedinherited

Definition at line 36 of file gaussianmodelintegral.h.

CC_NAMESPACE_SEPARATOR [1/2]

std::string_view lsst::gauss2d::Object::CC_NAMESPACE_SEPARATOR = "::"

staticconstexprinherited

The C++ namespace separator.

Definition at line 45 of file object.h.

CC_NAMESPACE_SEPARATOR [2/2]

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 [1/2]

std::string_view lsst::gauss2d::Object::NULL_STR_GENERAL = "None"

staticconstexprinherited

Definition at line 46 of file object.h.

NULL_STR_GENERAL [2/2]

std::string_view lsst::gauss2d::Object::NULL_STR_GENERAL = "None"

staticconstexprinherited

Definition at line 46 of file object.h.

PY_NAMESPACE_SEPARATOR [1/2]

std::string_view lsst::gauss2d::Object::PY_NAMESPACE_SEPARATOR = "."

staticconstexprinherited

Definition at line 47 of file object.h.

PY_NAMESPACE_SEPARATOR [2/2]

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_fit/gf35d7ec915+97dd712d81/src/sersicmixcomponent.cc