Loading [MathJax]/extensions/tex2jax.js
LSST Applications g0fba68d861+05816baf74,g1ec0fe41b4+f536777771,g1fd858c14a+a9301854fb,g35bb328faa+fcb1d3bbc8,g4af146b050+a5c07d5b1d,g4d2262a081+6e5fcc2a4e,g53246c7159+fcb1d3bbc8,g56a49b3a55+9c12191793,g5a012ec0e7+3632fc3ff3,g60b5630c4e+ded28b650d,g67b6fd64d1+ed4b5058f4,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g8352419a5c+fcb1d3bbc8,g87b7deb4dc+7b42cf88bf,g8852436030+e5453db6e6,g89139ef638+ed4b5058f4,g8e3bb8577d+d38d73bdbd,g9125e01d80+fcb1d3bbc8,g94187f82dc+ded28b650d,g989de1cb63+ed4b5058f4,g9d31334357+ded28b650d,g9f33ca652e+50a8019d8c,gabe3b4be73+1e0a283bba,gabf8522325+fa80ff7197,gb1101e3267+d9fb1f8026,gb58c049af0+f03b321e39,gb665e3612d+2a0c9e9e84,gb89ab40317+ed4b5058f4,gcf25f946ba+e5453db6e6,gd6cbbdb0b4+bb83cc51f8,gdd1046aedd+ded28b650d,gde0f65d7ad+941d412827,ge278dab8ac+d65b3c2b70,ge410e46f29+ed4b5058f4,gf23fb2af72+b7cae620c0,gf5e32f922b+fcb1d3bbc8,gf67bdafdda+ed4b5058f4,w.2025.16
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
gaussiancomponent.h
Go to the documentation of this file.
1#ifndef LSST_GAUSS2D_FIT_GAUSSIANCOMPONENT_H
2#define LSST_GAUSS2D_FIT_GAUSSIANCOMPONENT_H
3
4#include "channel.h"
7#include "integralmodel.h"
9#include "param_defs.h"
10#include "param_filter.h"
11#include <memory>
12
13namespace lsst::gauss2d::fit {
14// TODO: Revisit the necessity of this class
15// Its purpose is to have the GaussianParametricEllipse stored here and initialized first in
16// GaussianComponent's constructor
26
31public:
40 std::shared_ptr<CentroidParameters> centroid = nullptr,
41 std::shared_ptr<IntegralModel> integralmodel = nullptr);
42
43 void add_extra_param_map(const Channel& channel, ExtraParamMap& map_extra, const GradParamMap& map_grad,
44 ParameterMap& offsets) const override;
45 void add_extra_param_factors(const Channel& channel, ExtraParamFactors& factors) const override;
46 void add_grad_param_map(const Channel& channel, GradParamMap& map, ParameterMap& offsets) const override;
47 void add_grad_param_factors(const Channel& channel, GradParamFactors& factor) const override;
48
50 size_t get_n_gaussians(const Channel& channel) const override;
51
52 ParamRefs& get_parameters(ParamRefs& params, ParamFilter* filter = nullptr) const override;
53 ParamCRefs& get_parameters_const(ParamCRefs& params, ParamFilter* filter = nullptr) const override;
54
66 const std::vector<double>& sizes = {2.}, bool fixed = true) {
68 for (const double size : sizes) {
70 = {{Channel::NONE(),
71 std::make_shared<IntegralParameterD>(1., nullptr, nullptr, nullptr, fixed)}};
74 std::make_shared<SigmaXParameterD>(size, nullptr, nullptr, nullptr, fixed),
75 std::make_shared<SigmaYParameterD>(size, nullptr, nullptr, nullptr, fixed),
76 std::make_shared<RhoParameterD>(0, nullptr, nullptr, nullptr, fixed)),
78 std::make_shared<CentroidXParameterD>(0, nullptr, nullptr, nullptr, fixed),
79 std::make_shared<CentroidYParameterD>(0, nullptr, nullptr, nullptr, fixed)),
81 }
82 return comps;
83 }
84
85 void set_extra_param_factors(const Channel& channel, ExtraParamFactors& factors,
86 size_t index) const override;
87 void set_grad_param_factors(const Channel& channel, GradParamFactors& factors,
88 size_t index) const override;
89
90 std::string repr(bool name_keywords = false,
91 std::string_view namespace_separator = Object::CC_NAMESPACE_SEPARATOR) const override;
92 std::string str() const override;
93
94private:
95 ParamCRefs _get_parameters_grad(const Channel& channel) const;
96};
97} // namespace lsst::gauss2d::fit
98
99#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
static const Channel & NONE()
Definition channel.cc:111
EllipticalComponent(std::shared_ptr< ParametricEllipse > ellipse, std::shared_ptr< CentroidParameters > centroid=nullptr, std::shared_ptr< IntegralModel > integralmodel=nullptr)
Construct an EllipticalComponent from Parameter containers.
size_t get_n_gaussians(const Channel &channel) const override
Return the number of Gaussian sub-components controlled by this model.
ParamCRefs & get_parameters_const(ParamCRefs &params, ParamFilter *filter=nullptr) const override
Same as get_parameters(), but for const refs.
void add_extra_param_factors(const Channel &channel, ExtraParamFactors &factors) const override
Add extra Parameter gradient factors to an existing vector.
void set_extra_param_factors(const Channel &channel, ExtraParamFactors &factors, size_t index) const override
Set extra Parameter gradient factors in an existing map.
GaussianComponent(std::shared_ptr< GaussianParametricEllipse > ellipse=nullptr, std::shared_ptr< CentroidParameters > centroid=nullptr, std::shared_ptr< IntegralModel > integralmodel=nullptr)
Construct a GaussianComponent from ellipse, centroid and integral parameters.
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.
void add_grad_param_factors(const Channel &channel, GradParamFactors &factor) const override
Add Parameter gradient factors to an existing map.
void add_grad_param_map(const Channel &channel, GradParamMap &map, ParameterMap &offsets) const override
Add Parameter gradient indices to an existing map.
static std::vector< std::shared_ptr< Component > > make_uniq_default_gaussians(const std::vector< double > &sizes={2.}, bool fixed=true)
Construct a vector of default-initialized GaussianComponent instances.
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 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.
std::shared_ptr< GaussianParametricEllipse > _ellipsedata
GaussianParametricEllipseHolder(std::shared_ptr< GaussianParametricEllipse > ellipse=nullptr)
std::vector< ChannelIntegralParameterD > Data
T emplace_back(T... args)
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
STL namespace.
Options for filtering Parameter instances.