Loading [MathJax]/extensions/tex2jax.js
LSST Applications g04a91732dc+cc8870d3f5,g07dc498a13+5aa0b8792f,g0fba68d861+80045be308,g1409bbee79+5aa0b8792f,g1a7e361dbc+5aa0b8792f,g1fd858c14a+f64bc332a9,g208c678f98+1ae86710ed,g35bb328faa+fcb1d3bbc8,g4d2262a081+47ad8a29a8,g4d39ba7253+9633a327c1,g4e0f332c67+5d362be553,g53246c7159+fcb1d3bbc8,g60b5630c4e+9633a327c1,g668ecb457e+25d63fd678,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g7b71ed6315+fcb1d3bbc8,g8852436030+8b64ca622a,g89139ef638+5aa0b8792f,g89e1512fd8+04325574d3,g8d6b6b353c+9633a327c1,g9125e01d80+fcb1d3bbc8,g989de1cb63+5aa0b8792f,g9f33ca652e+b196626af7,ga9baa6287d+9633a327c1,gaaedd4e678+5aa0b8792f,gabe3b4be73+1e0a283bba,gb1101e3267+71e32094df,gb58c049af0+f03b321e39,gb90eeb9370+2807b1ad02,gcf25f946ba+8b64ca622a,gd315a588df+a39986a76f,gd6cbbdb0b4+c8606af20c,gd9a9a58781+fcb1d3bbc8,gde0f65d7ad+4e42d81ab7,ge278dab8ac+932305ba37,ge82c20c137+76d20ab76d,gfe73954cf8+a1301e4c20,w.2025.11
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
sersicmixcomponent.h
Go to the documentation of this file.
1#ifndef LSST_GAUSS2D_FIT_SERSICMIXCOMPONENT_H
2#define LSST_GAUSS2D_FIT_SERSICMIXCOMPONENT_H
3
5
6#include "channel.h"
8#include "integralmodel.h"
9#include "param_defs.h"
10#include "param_filter.h"
11#include "sersicmix.h"
13
14namespace lsst::gauss2d::fit {
19public:
22 double value = _get_default(), std::shared_ptr<const parameters::Limits<double>> limits = nullptr,
23 std::shared_ptr<const parameters::Transform<double>> transform = nullptr,
24 std::shared_ptr<const parameters::Unit> unit = nullptr, bool fixed = false,
25 std::string label = "", std::shared_ptr<const SersicMixInterpolator> interpolator = nullptr);
26
28 double get_integralratio(unsigned short index) const;
30 double get_integralratio_deriv(unsigned short index) const;
32 = SERSICMIX_ORDER_DEFAULT);
33 const parameters::Limits<double>& get_limits_maximal() const override;
34 double get_min() const override { return 0.5; }
35 double get_max() const override { return 8.0; }
37 double get_sizeratio(unsigned short index) const;
39 double get_sizeratio_deriv(unsigned short index) const;
40
42 unsigned short get_order() const;
43
44 void set_value(double value) override;
45 void set_value_transformed(double value_transformed) override;
46
47private:
48 std::vector<IntegralSize> _integralsizes;
49 std::vector<IntegralSize> _integralsizes_derivs;
51
53 void _set_ratios(double sersicindex);
54};
55
56// TODO: Revisit the necessity of this class
69
70// TODO: Add ref to derivation of weights, when published
86public:
88 std::shared_ptr<CentroidParameters> centroid = nullptr,
89 std::shared_ptr<IntegralModel> integralmodel = nullptr,
92
93 void add_extra_param_map(const Channel& channel, ExtraParamMap& map_extra, const GradParamMap& map_grad,
94 ParameterMap& offsets) const override;
95 void add_extra_param_factors(const Channel& channel, ExtraParamFactors& factors) const override;
96 void add_grad_param_map(const Channel& channel, GradParamMap& map, ParameterMap& offsets) const override;
97 void add_grad_param_factors(const Channel& channel, GradParamFactors& factor) const override;
98
100 size_t get_n_gaussians(const Channel& channel) const override;
101
102 ParamRefs& get_parameters(ParamRefs& params, ParamFilter* filter = nullptr) const override;
103 ParamCRefs& get_parameters_const(ParamCRefs& params, ParamFilter* filter = nullptr) const override;
104
105 double get_sersicindex() const;
106
109
110 static const size_t N_PARAMS = N_PARAMS_GAUSS2D + 1;
111
112 void set_extra_param_factors(const Channel& channel, ExtraParamFactors& factors,
113 size_t index) const override;
114 void set_grad_param_factors(const Channel& channel, GradParamFactors& factors,
115 size_t index) const override;
116 void set_sersicindex(double value);
117
118 std::string repr(bool name_keywords = false,
119 std::string_view namespace_separator = Object::CC_NAMESPACE_SEPARATOR) const override;
120 std::string str() const override;
121
122private:
126 _gaussians;
127};
128} // namespace lsst::gauss2d::fit
129
130#endif
static constexpr std::string_view CC_NAMESPACE_SEPARATOR
The C++ namespace separator.
Definition object.h:45
An observational channel, usually representing some range of wavelengths of light.
Definition channel.h:29
EllipticalComponent(std::shared_ptr< ParametricEllipse > ellipse, std::shared_ptr< CentroidParameters > centroid=nullptr, std::shared_ptr< IntegralModel > integralmodel=nullptr)
Construct an EllipticalComponent from Parameter containers.
void set_extra_param_factors(const Channel &channel, ExtraParamFactors &factors, size_t index) const override
Set extra Parameter gradient factors in an existing map.
std::string str() const override
Return a brief, human-readable string representation of this.
std::unique_ptr< const lsst::gauss2d::Gaussians > get_gaussians(const Channel &channel) const override
Return the vector of Gaussian sub-components controlled by this model.
void set_grad_param_factors(const Channel &channel, GradParamFactors &factors, size_t index) const override
Set Parameter gradient factors in an existing map.
void add_extra_param_map(const Channel &channel, ExtraParamMap &map_extra, const GradParamMap &map_grad, ParameterMap &offsets) const override
Add extra Parameter indices to a map.
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.
ParamRefs & get_parameters(ParamRefs &params, ParamFilter *filter=nullptr) const override
Add Parameter refs matching the filter to a vector, in order.
SersicMixComponentIndexParameterD & get_sersicindex_param() const
std::shared_ptr< SersicMixComponentIndexParameterD > get_sersicindex_param_ptr()
SersicMixComponent(std::shared_ptr< SersicParametricEllipse > ellipse=nullptr, std::shared_ptr< CentroidParameters > centroid=nullptr, std::shared_ptr< IntegralModel > integralmodel=nullptr, std::shared_ptr< SersicMixComponentIndexParameterD > sersicindex=nullptr)
void add_extra_param_factors(const Channel &channel, ExtraParamFactors &factors) const override
Add extra Parameter gradient factors to an existing vector.
ParamCRefs & get_parameters_const(ParamCRefs &params, ParamFilter *filter=nullptr) const override
Same as get_parameters(), but for const refs.
void add_grad_param_map(const Channel &channel, GradParamMap &map, ParameterMap &offsets) const override
Add Parameter gradient indices to an existing map.
void add_grad_param_factors(const Channel &channel, GradParamFactors &factor) const override
Add Parameter gradient factors to an existing map.
size_t get_n_gaussians(const Channel &channel) const override
Return the number of Gaussian sub-components controlled by this model.
A SersicIndexParameter for a Gaussian mixture Component.
double get_sizeratio(unsigned short index) const
Return the size ratio for a given Gaussian sub-component index.
double get_min() const override
Return the minimum value for this parameter instance.
double get_integralratio_deriv(unsigned short index) const
Return the integral ratio derivative for a given Gaussian sub-component index.
SersicMixComponentIndexParameterD(double value=_get_default(), std::shared_ptr< const parameters::Limits< double > > limits=nullptr, std::shared_ptr< const parameters::Transform< double > > transform=nullptr, std::shared_ptr< const parameters::Unit > unit=nullptr, bool fixed=false, std::string label="", std::shared_ptr< const SersicMixInterpolator > interpolator=nullptr)
See docs for Parameter.
const parameters::Limits< double > & get_limits_maximal() const override
Return limits representing the maximum/minimum untransformed value.
double get_integralratio(unsigned short index) const
Return the integral ratio for a given Gaussian sub-component index.
double get_max() const override
Return the maximum value for this parameter instance.
void set_value_transformed(double value_transformed) override
Set the transformed value for this parameter instance.
static std::shared_ptr< const SersicMixInterpolator > get_interpolator_default(unsigned short order=SERSICMIX_ORDER_DEFAULT)
void set_value(double value) override
Set the untransformed value for this parameter instance.
double get_sizeratio_deriv(unsigned short index) const
Return the size ratio derivative for a given Gaussian sub-component index.
SersicParametricEllipseHolder(std::shared_ptr< SersicParametricEllipse > ellipse=nullptr)
This constructor does not need to be called by users.
std::shared_ptr< SersicParametricEllipse > _ellipsedata
Range-based limits for parameter values.
Definition limits.h:45
A reversible transformation of a real scalar value.
Definition transform.h:45
T make_shared(T... args)
std::vector< std::array< double, lsst::gauss2d::N_PARAMS_GAUSS2D > > GradParamFactors
std::vector< ParamBaseRef > ParamRefs
Definition param_defs.h:13
std::vector< std::array< size_t, lsst::gauss2d::N_PARAMS_GAUSS2D > > GradParamMap
std::vector< ExtraParamFactorValues > ExtraParamFactors
std::vector< std::array< size_t, lsst::gauss2d::N_EXTRA_MAP > > ExtraParamMap
std::vector< ParamBaseCRef > ParamCRefs
Definition param_defs.h:11
std::map< ParamBaseCRef, size_t > ParameterMap
const size_t N_PARAMS_GAUSS2D
Definition evaluate.h:61
STL namespace.
Options for filtering Parameter instances.