lsst.gauss2d.fit g199a45376c+5e234f8357
 
Loading...
Searching...
No Matches
gaussiancomponent.h
1#ifndef LSST_GAUSS2D_FIT_GAUSSIANCOMPONENT_H
2#define LSST_GAUSS2D_FIT_GAUSSIANCOMPONENT_H
3
4#include "channel.h"
5#include "ellipticalcomponent.h"
6#include "gaussianparametricellipse.h"
7#include "integralmodel.h"
8#include "linearintegralmodel.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
17class GaussianParametricEllipseHolder {
18public:
19 std::shared_ptr<GaussianParametricEllipse> _ellipsedata;
20
21 explicit GaussianParametricEllipseHolder(std::shared_ptr<GaussianParametricEllipse> ellipse = nullptr)
22 : _ellipsedata(std::move(ellipse)) {
23 if (_ellipsedata == nullptr) _ellipsedata = std::make_shared<GaussianParametricEllipse>();
24 }
25};
26
30class GaussianComponent : private GaussianParametricEllipseHolder, public EllipticalComponent {
31public:
39 explicit GaussianComponent(std::shared_ptr<GaussianParametricEllipse> ellipse = nullptr,
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
49 std::unique_ptr<const lsst::gauss2d::Gaussians> get_gaussians(const Channel& channel) const override;
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
65 static std::vector<std::shared_ptr<Component>> make_uniq_default_gaussians(
66 const std::vector<double>& sizes = {2.}, bool fixed = true) {
67 std::vector<std::shared_ptr<Component>> comps = {};
68 for (const double size : sizes) {
69 LinearIntegralModel::Data data
70 = {{Channel::NONE(),
71 std::make_shared<IntegralParameterD>(1., nullptr, nullptr, nullptr, fixed)}};
72 comps.emplace_back(std::make_shared<GaussianComponent>(
73 std::make_shared<GaussianParametricEllipse>(
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)),
77 std::make_shared<CentroidParameters>(
78 std::make_shared<CentroidXParameterD>(0, nullptr, nullptr, nullptr, fixed),
79 std::make_shared<CentroidYParameterD>(0, nullptr, nullptr, nullptr, fixed)),
80 std::make_shared<LinearIntegralModel>(&data)));
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
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)
Definition ellipticalcomponent.cc:13
size_t get_n_gaussians(const Channel &channel) const override
Return the number of Gaussian sub-components controlled by this model.
Definition gaussiancomponent.cc:130
ParamCRefs & get_parameters_const(ParamCRefs &params, ParamFilter *filter=nullptr) const override
Same as get_parameters(), but for const refs.
Definition gaussiancomponent.cc:137
void add_extra_param_factors(const Channel &channel, ExtraParamFactors &factors) const override
Definition gaussiancomponent.cc:82
void set_extra_param_factors(const Channel &channel, ExtraParamFactors &factors, size_t index) const override
Definition gaussiancomponent.cc:142
GaussianComponent(std::shared_ptr< GaussianParametricEllipse > ellipse=nullptr, std::shared_ptr< CentroidParameters > centroid=nullptr, std::shared_ptr< IntegralModel > integralmodel=nullptr)
Definition gaussiancomponent.cc:20
ParamRefs & get_parameters(ParamRefs &params, ParamFilter *filter=nullptr) const override
Definition gaussiancomponent.cc:132
void add_grad_param_factors(const Channel &channel, GradParamFactors &factor) const override
Definition gaussiancomponent.cc:118
void add_grad_param_map(const Channel &channel, GradParamMap &map, ParameterMap &offsets) const override
Definition gaussiancomponent.cc:86
static std::vector< std::shared_ptr< Component > > make_uniq_default_gaussians(const std::vector< double > &sizes={2.}, bool fixed=true)
Definition gaussiancomponent.h:65
void set_grad_param_factors(const Channel &channel, GradParamFactors &factors, size_t index) const override
Definition gaussiancomponent.cc:162
void add_extra_param_map(const Channel &channel, ExtraParamMap &map_extra, const GradParamMap &map_grad, ParameterMap &offsets) const override
Definition gaussiancomponent.cc:55
std::unique_ptr< const lsst::gauss2d::Gaussians > get_gaussians(const Channel &channel) const override
Definition gaussiancomponent.cc:122
Definition param_filter.h:17