lsst::gauss2d::fit::GaussianComponent Class Reference

A Component consisting of a 2D Gaussian. More...

#include <gaussiancomponent.h>

Inheritance diagram for lsst::gauss2d::fit::GaussianComponent:

Public Member Functions
	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.
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.
void	add_extra_param_factors (const Channel &channel, ExtraParamFactors &factors) const override
	Add extra Parameter gradient factors to an existing vector.
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.
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.
size_t	get_n_gaussians (const Channel &channel) const override
	Return the number of Gaussian sub-components controlled by this model.
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.
void	set_extra_param_factors (const Channel &channel, ExtraParamFactors &factors, size_t index) const override
	Set extra Parameter gradient factors in an existing map.
void	set_grad_param_factors (const Channel &channel, GradParamFactors &factors, size_t index) const override
	Set Parameter gradient factors in an existing 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.
std::string	str () const override
	Return a brief, human-readable string representation of this.
const CentroidParameters &	get_centroid () const
	Get the centroid Parameter container.
const ParametricEllipse &	get_ellipse () const
	Get the ellipse Parameter container.
const IntegralModel &	get_integralmodel () const override
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::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.
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 = "."

Protected Attributes
std::shared_ptr< ParametricEllipse >	_ellipse
std::shared_ptr< CentroidParameters >	_centroid
std::shared_ptr< IntegralModel >	_integralmodel

Detailed Description

A Component consisting of a 2D Gaussian.

Definition at line 30 of file gaussiancomponent.h.

Constructor & Destructor Documentation

GaussianComponent()

lsst::gauss2d::fit::GaussianComponent::GaussianComponent ( std::shared_ptr< GaussianParametricEllipse > ellipse = nullptr, std::shared_ptr< CentroidParameters > centroid = nullptr, std::shared_ptr< IntegralModel > integralmodel = nullptr )

explicit

Construct a GaussianComponent from ellipse, centroid and integral parameters.

Parameters

ellipse	The GaussianParametricEllipse value; default-initialized if null.
centroid	The CentroidParameters value; default-initialized if null.
integralmodel	The IntegralModel value; default-initialized if null.

Definition at line 20 of file gaussiancomponent.cc.

        : GaussianParametricEllipseHolder(std::move(ellipse)),
          EllipticalComponent(_ellipsedata, centroid, integralmodel) {}

Member Function Documentation

add_extra_param_factors()

void lsst::gauss2d::fit::GaussianComponent::add_extra_param_factors ( const Channel & channel, ExtraParamFactors & factors ) const

overridevirtual

Add extra Parameter gradient factors to an existing vector.

Parameters

channel	The Channel to add factors for.
factors	The ExtraParamFactors to add to.

Implements lsst::gauss2d::fit::ParametricModel.

Definition at line 82 of file gaussiancomponent.cc.

                                                                                                        {
    factors.push_back({0, 0, 0});
}

add_extra_param_map()

void lsst::gauss2d::fit::GaussianComponent::add_extra_param_map ( const Channel & channel, ExtraParamMap & map_extra, const GradParamMap & map_grad, ParameterMap & offsets ) const

overridevirtual

Add extra Parameter indices to a map.

Parameters

channel	The Channel to add indices for.
map_extra	The ExtraParamMap to add to.
map_grad	The completed GradParamMap.
offsets	A map of index offsets for Parameters that have already been added.

Implements lsst::gauss2d::fit::ParametricModel.

Definition at line 55 of file gaussiancomponent.cc.

                                                                                                       {
    auto factors_int = _integralmodel->get_integral_derivative_factors(channel);
    const size_t n_factors = factors_int.size();
    if (!(n_factors <= N_PARAMS_EXTRA_INTEGRAL_MAX)) {
        throw std::runtime_error(_integralmodel->str() + ".get_integral_derivative_factors(" + channel.str()
                                 + ").size()=" + std::to_string(n_factors)
                                 + "!<=" + std::to_string(N_PARAMS_EXTRA_INTEGRAL_MAX));
    }
    size_t idx = 0;
    size_t offset = 0;
 
    for (const auto& factor : factors_int) {
        const auto& param = factor.first.get();
        if (!param.get_fixed()) {
            auto found = offsets.find(param);
            if (found == offsets.end()) {
                throw std::runtime_error("param=" + param.str() + " not found in offsets;"
                    " was add_grad_param_map called first?");
            }
            offset = (*found).second;
            idx = map_grad.size() - 1;
        }
    }
    map_extra.push_back({idx, offset});
}

add_grad_param_factors()

void lsst::gauss2d::fit::GaussianComponent::add_grad_param_factors ( const Channel & channel, GradParamFactors & factors ) const

overridevirtual

Add Parameter gradient factors to an existing map.

Parameters

channel	The Channel to add factors for.
factors	The GradParamFactors to add to.

Implements lsst::gauss2d::fit::ParametricModel.

Definition at line 118 of file gaussiancomponent.cc.

                                                                                                      {
    factors.push_back({1, 1, 1, 1, 1, 1});
}

add_grad_param_map()

void lsst::gauss2d::fit::GaussianComponent::add_grad_param_map ( const Channel & channel, GradParamMap & map, ParameterMap & offsets ) const

overridevirtual

Add Parameter gradient indices to an existing map.

Parameters

channel	The Channel to add indices for.
map	The map to add to.
offsets	A map of index offsets for Parameters that have already been added.

Implements lsst::gauss2d::fit::ParametricModel.

Definition at line 86 of file gaussiancomponent.cc.

                                                                        {
    auto params = nonconsecutive_unique(this->_get_parameters_grad(channel));
    map.push_back({0, 0, 0, 0, 0, 0});
    auto& values = map.back();
 
    size_t size_map = offsets.size();
    size_t index_param_map;
    for (size_t idx_param = 0; idx_param < N_PARAMS_GAUSS2D; ++idx_param) {
        const size_t& order_param = IDX_ORDER[idx_param];
        // The parameters must be in the same order as returned by get_parameters(_const)
        const auto& param = params.at(idx_param).get();
        if (!param.get_fixed()) {
            if (offsets.find(param) == offsets.end()) {
                index_param_map = ++size_map;
                offsets[param] = index_param_map;
            } else {
                index_param_map = offsets[param];
            }
            values[order_param] = index_param_map;
        }
    }
    const size_t n_params = params.size();
    // Add offset for any extra integral parameters
    for (size_t idx_param = N_PARAMS_GAUSS2D; idx_param < n_params; ++idx_param) {
        const auto& param = params.at(idx_param).get();
        if (!param.get_fixed() && (offsets.find(param) == offsets.end())) {
            offsets[param] = ++size_map;
        }
    }
}

get_centroid()

const CentroidParameters & lsst::gauss2d::fit::EllipticalComponent::get_centroid ( ) const

inherited

Get the centroid Parameter container.

Definition at line 23 of file ellipticalcomponent.cc.

{ return *_centroid; }

get_ellipse()

const ParametricEllipse & lsst::gauss2d::fit::EllipticalComponent::get_ellipse ( ) const

inherited

Get the ellipse Parameter container.

Definition at line 24 of file ellipticalcomponent.cc.

{ return *_ellipse; }

get_gaussians()

std::unique_ptr< const lsst::gauss2d::Gaussians > lsst::gauss2d::fit::GaussianComponent::get_gaussians ( const Channel & channel ) const

overridevirtual

Return the vector of Gaussian sub-components controlled by this model.

Parameters

channel

The Channel to return Gaussians for.

Returns

The Gaussians controlled by this model.

Implements lsst::gauss2d::fit::ParametricModel.

Definition at line 122 of file gaussiancomponent.cc.

                                      {
    lsst::gauss2d::Gaussians::Data gaussians = {std::make_shared<Gaussian>(
            std::make_shared<Centroid>(this->_centroid), std::make_shared<Ellipse>(this->_ellipsedata),
            std::make_shared<GaussianModelIntegral>(channel, this->_integralmodel))};
    return std::make_unique<const lsst::gauss2d::Gaussians>(gaussians);
}

get_integralmodel()

const IntegralModel & lsst::gauss2d::fit::EllipticalComponent::get_integralmodel ( ) const

overridevirtualinherited

Implements lsst::gauss2d::fit::Component.

Definition at line 25 of file ellipticalcomponent.cc.

{ return *_integralmodel; }

get_n_gaussians()

size_t lsst::gauss2d::fit::GaussianComponent::get_n_gaussians ( const Channel & channel ) const

overridevirtual

Return the number of Gaussian sub-components controlled by this model.

Implements lsst::gauss2d::fit::ParametricModel.

Definition at line 130 of file gaussiancomponent.cc.

{ return 1; };

get_parameters()

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

overridevirtual

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)

Reimplemented from lsst::gauss2d::fit::EllipticalComponent.

Definition at line 132 of file gaussiancomponent.cc.

                                                                                         {
    EllipticalComponent::get_parameters(params, filter);
    return params;
}

get_parameters_const()

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

overridevirtual

Same as get_parameters(), but for const refs.

Reimplemented from lsst::gauss2d::fit::EllipticalComponent.

Definition at line 137 of file gaussiancomponent.cc.

                                                                                                 {
    EllipticalComponent::get_parameters_const(params, filter);
    return params;
}

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

make_uniq_default_gaussians()

static std::vector< std::shared_ptr< Component > > lsst::gauss2d::fit::GaussianComponent::make_uniq_default_gaussians ( const std::vector< double > & sizes = {2.}, bool fixed = true )

inlinestatic

Construct a vector of default-initialized GaussianComponent instances.

Parameters

sizes	Vector of initial values for both sigma_x and sigma_y.
fixed	Whether all Parameter members should be fixed initially.

Returns

A vector of GaussianComponent instances.

Note

This can be used to initialize a trivial PsfModel as a noralized, zero-size single Gaussian.

Definition at line 65 of file gaussiancomponent.h.

                                             {2.}, bool fixed = true) {
        std::vector<std::shared_ptr<Component>> comps = {};
        for (const double size : sizes) {
            LinearIntegralModel::Data data
                    = {{Channel::NONE(),
                        std::make_shared<IntegralParameterD>(1., nullptr, nullptr, nullptr, fixed)}};
            comps.emplace_back(std::make_shared<GaussianComponent>(
                    std::make_shared<GaussianParametricEllipse>(
                            std::make_shared<SigmaXParameterD>(size, nullptr, nullptr, nullptr, fixed),
                            std::make_shared<SigmaYParameterD>(size, nullptr, nullptr, nullptr, fixed),
                            std::make_shared<RhoParameterD>(0, nullptr, nullptr, nullptr, fixed)),
                    std::make_shared<CentroidParameters>(
                            std::make_shared<CentroidXParameterD>(0, nullptr, nullptr, nullptr, fixed),
                            std::make_shared<CentroidYParameterD>(0, nullptr, nullptr, nullptr, fixed)),
                    std::make_shared<LinearIntegralModel>(&data)));
        }
        return comps;
    }

null_str()

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

repr()

std::string lsst::gauss2d::fit::GaussianComponent::repr ( bool name_keywords = false, std::string_view namespace_separator = Object::CC_NAMESPACE_SEPARATOR ) const

overridevirtual

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::EllipticalComponent.

Definition at line 184 of file gaussiancomponent.cc.

                                                                                              {
    return type_name_str<GaussianComponent>(false, namespace_separator) + "("
           + EllipticalComponent::repr(name_keywords, namespace_separator) + ")";
}

set_extra_param_factors()

void lsst::gauss2d::fit::GaussianComponent::set_extra_param_factors ( const Channel & channel, ExtraParamFactors & factors, size_t index ) const

overridevirtual

Set extra Parameter gradient factors in an existing map.

Parameters

channel	The Channel to set factors for.
factors	The ExtraParamFactors to set factors for.
index	The index to begin setting factors at.

Implements lsst::gauss2d::fit::ParametricModel.

Definition at line 142 of file gaussiancomponent.cc.

                                                                    {
    auto factors_int = _integralmodel->get_integral_derivative_factors(channel);
    const size_t n_factors = factors_int.size();
    if (!(n_factors <= 1)) {
        throw std::runtime_error(this->str() + ".set_extra_param_factors(" + channel.str()
                                 + ", index=" + std::to_string(index) + " has " + std::to_string(n_factors)
                                 + " parameter factors" + "; only a maximum of one is supported.");
    }
    auto& row = factors[index];
 
    if (n_factors > 0) {
        row[0] = factors_int[0].second[0] / factors_int[0].first.get().get_transform_derivative();
    } else {
        row[0] = 0;
    }
    row[1] = 0;
    row[2] = 0;
}

set_grad_param_factors()

void lsst::gauss2d::fit::GaussianComponent::set_grad_param_factors ( const Channel & channel, GradParamFactors & factors, size_t index ) const

overridevirtual

Set Parameter gradient factors in an existing map.

Parameters

channel	The Channel to set factors for.
factors	The GradParamFactors to set factors for.
index	The index to begin setting factors at.

Implements lsst::gauss2d::fit::ParametricModel.

Definition at line 162 of file gaussiancomponent.cc.

                                                                   {
    auto params = this->_get_parameters_grad(channel);
    auto& values = factors.at(index);
 
    for (size_t idx_param = 0; idx_param < N_PARAMS_GAUSS2D; ++idx_param) {
        const size_t& order_param = IDX_ORDER[idx_param];
        // The parameters must be in the same order as returned by get_parameters(_const)
        const auto& param = params[idx_param].get();
        if (param.get_fixed()) {
            values[order_param] = 0;
        } else {
            auto deriv = param.get_transform_derivative();
            if (deriv == 0) {
                throw std::runtime_error("Param[idx=" + std::to_string(idx_param) + "]=" + param.str()
                                         + " get_transform_derivative=0 (will result in divide by 0)");
            }
            values[order_param] = 1.0 / deriv;
        }
    }
}

str()

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

overridevirtual

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

Reimplemented from lsst::gauss2d::fit::EllipticalComponent.

Definition at line 189 of file gaussiancomponent.cc.

                                       {
    return type_name_str<GaussianComponent>(true) + "(" + EllipticalComponent::str() + ")";
}

Member Data Documentation

_centroid

std::shared_ptr<CentroidParameters> lsst::gauss2d::fit::EllipticalComponent::_centroid

protectedinherited

Definition at line 42 of file ellipticalcomponent.h.

_ellipse

std::shared_ptr<ParametricEllipse> lsst::gauss2d::fit::EllipticalComponent::_ellipse

protectedinherited

Definition at line 41 of file ellipticalcomponent.h.

_integralmodel

std::shared_ptr<IntegralModel> lsst::gauss2d::fit::EllipticalComponent::_integralmodel

protectedinherited

Definition at line 43 of file ellipticalcomponent.h.

CC_NAMESPACE_SEPARATOR

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

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

staticconstexprinherited

Definition at line 46 of file object.h.

PY_NAMESPACE_SEPARATOR

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 files:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/gauss2d_fit/g199a45376c+5137f08352/include/lsst/gauss2d/fit/gaussiancomponent.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-12.1.0/Linux/gauss2d_fit/g199a45376c+5137f08352/src/gaussiancomponent.cc