lsst::gauss2d::fit::Source Class Reference

An association of physically-related Component instances. More...

#include <source.h>

Inheritance diagram for lsst::gauss2d::fit::Source:

Public Member Functions
	Source (Components &components)
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 &factors) const override
	Add Parameter gradient factors to an existing map.
Components	get_components () const override
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.
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::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 = "."

Detailed Description

An association of physically-related Component instances.

A Source is primarily intended to be a single object represented by Component instances with common centroids. However, users may link whatever Components they like into a Source.

Source objects should not share Components if they are part of the same Model, but this is not enforced.

Definition at line 22 of file source.h.

Constructor & Destructor Documentation

Source()

lsst::gauss2d::fit::Source::Source ( Components & components )

explicit

Definition at line 9 of file source.cc.

                                     {
    _components.reserve(components.size());
    size_t i = 0;
    for (auto& component : components) {
        if (component == nullptr)
            throw std::invalid_argument("Source components[" + std::to_string(i) + "] can't be null");
        _components.push_back(std::move(component));
        i++;
    }
}

Member Function Documentation

add_extra_param_factors()

void lsst::gauss2d::fit::Source::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 25 of file source.cc.

                                                                                             {
    for (auto& component : _components) component->add_extra_param_factors(channel, factors);
}

add_extra_param_map()

void lsst::gauss2d::fit::Source::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 20 of file source.cc.

                                                                                            {
    for (auto& component : _components) component->add_extra_param_map(channel, map_extra, map_grad, offsets);
}

add_grad_param_factors()

void lsst::gauss2d::fit::Source::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 33 of file source.cc.

                                                                                           {
    for (auto& component : _components) component->add_grad_param_factors(channel, factors);
}

add_grad_param_map()

void lsst::gauss2d::fit::Source::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 29 of file source.cc.

                                                                                                      {
    for (auto& component : _components) component->add_grad_param_map(channel, map, offsets);
}

get_components()

Components lsst::gauss2d::fit::Source::get_components ( ) const

overridevirtual

Implements lsst::gauss2d::fit::ComponentMixture.

Definition at line 37 of file source.cc.

{ return _components; }

get_gaussians()

std::unique_ptr< const lsst::gauss2d::Gaussians > lsst::gauss2d::fit::Source::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 39 of file source.cc.

                                                                                            {
    std::vector<std::optional<const lsst::gauss2d::Gaussians::Data>> in;
    // TODO: This isn't sufficient; need to implement get_n_components
    in.reserve(_components.size());
    for (auto& component : _components) {
        in.push_back(component->get_gaussians(channel)->get_data());
    }
    return std::make_unique<lsst::gauss2d::Gaussians>(in);
}

get_n_gaussians()

size_t lsst::gauss2d::fit::Source::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 49 of file source.cc.

                                                           {
    size_t n_g = 0;
    for (auto& component : _components) n_g += component->get_n_gaussians(channel);
    return n_g;
}

get_parameters()

ParamRefs & lsst::gauss2d::fit::Source::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)

Implements lsst::gauss2d::fit::Parametric.

Definition at line 55 of file source.cc.

                                                                              {
    for (auto& component : _components) component->get_parameters(params, filter);
    return params;
}

get_parameters_const()

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

overridevirtual

Same as get_parameters(), but for const refs.

Implements lsst::gauss2d::fit::Parametric.

Definition at line 60 of file source.cc.

                                                                                      {
    for (auto& component : _components) component->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;
    }

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

Implements lsst::gauss2d::Object.

Definition at line 79 of file source.cc.

                                                                                   {
    std::string s = type_name_str<Source>(false, namespace_separator) + "("
                    + (name_keywords ? "components=[" : "[");
    for (const auto& c : _components) s += c->repr(name_keywords, namespace_separator) + ",";
    return s + "])";
}

set_extra_param_factors()

void lsst::gauss2d::fit::Source::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 65 of file source.cc.

                                                                                                           {
    for (auto& component : _components) {
        component->set_extra_param_factors(channel, factors, index);
        index += component->get_n_gaussians(channel);
    }
}

set_grad_param_factors()

void lsst::gauss2d::fit::Source::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 72 of file source.cc.

                                                                                                         {
    for (auto& component : _components) {
        component->set_grad_param_factors(channel, factors, index);
        index += component->get_n_gaussians(channel);
    }
}

str()

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

overridevirtual

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

Implements lsst::gauss2d::Object.

Definition at line 86 of file source.cc.

                            {
    std::string s = type_name_str<Source>(true) + "(components=[";
    for (const auto& c : _components) s += c->str() + ",";
    return s + "])";
}

Member Data Documentation

CC_NAMESPACE_SEPARATOR

constexpr 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

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

staticconstexprinherited

Definition at line 46 of file object.h.

PY_NAMESPACE_SEPARATOR

constexpr 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-9.0.0/Linux64/gauss2d_fit/gb58c049af0+d64f4d3760/include/lsst/gauss2d/fit/source.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/gauss2d_fit/gb58c049af0+d64f4d3760/src/source.cc