LSST Applications g013ef56533+7c9321ec0f,g042eb84c57+c6cfa41bc3,g199a45376c+0ba108daf9,g1fd858c14a+fcad0d0313,g210f2d0738+c0f94c6586,g262e1987ae+a7e710680e,g29ae962dfc+fb55f2edb0,g2ac17093b6+61d6563b1e,g2b1d02342f+df6f932764,g2cef7863aa+aef1011c0b,g2f7ad74990+c0f94c6586,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53cf87ae69,g47891489e3+4316d04fff,g511e8cfd20+baa56acf6c,g53246c7159+8c5ae1fdc5,g54cd7ddccb+fd7ad03fde,g64539dfbff+c0f94c6586,g67b6fd64d1+4316d04fff,g67fd3c3899+c0f94c6586,g6985122a63+4316d04fff,g74acd417e5+ca833bee28,g786e29fd12+668abc6043,g81db2e9a8d+b2ec8e584f,g87389fa792+8856018cbb,g89139ef638+4316d04fff,g8d7436a09f+0a24083b20,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+11eb8fd5b8,gbf99507273+8c5ae1fdc5,gcdda8b9158+e4c84c9d5c,gce8aa8abaa+8c5ae1fdc5,gd7ef33dd92+4316d04fff,gdab6d2f7ff+ca833bee28,ge410e46f29+4316d04fff,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.40
LSST Data Management Base Package
Loading...
Searching...
No Matches
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.