lsst::gauss2d::fit::Data< T, I, M > Class Template Reference

A list of Observation instances that can be modelled. More...

#include <data.h>

Inheritance diagram for lsst::gauss2d::fit::Data< T, I, M >:

Public Types
using	Observation = lsst::gauss2d::fit::Observation<T, I, M>
using	ObservationCRef = std::reference_wrapper<const Observation>

Public Member Functions
	Data (std::vector< std::shared_ptr< const Observation > > observations)
	Construct a Data instance.
auto	at (size_t i) const
auto	begin () const
auto	end () const
auto	cbegin () const
auto	cend () const
std::vector< std::reference_wrapper< const Channel > >	get_channels () const override
	Get the set of channels this instance is applicable for.
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.
size_t	size () const
	Get the number of member Observation.
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

template<typename T, typename I, typename M>
class lsst::gauss2d::fit::Data< T, I, M >

A list of Observation instances that can be modelled.

A Data is a list of Observation instances that can have associated Model instances. Multiple Observation instances may have the same Channel, but one should not include the same Observation multiple time.

Template Parameters

T	The type of the Observation Image (usually float or double)
I	The type of the Observation indices (usually size_t)
M	The type of the Observation Mask (usually bool)

Definition at line 32 of file data.h.

Member Typedef Documentation

Observation

template<typename T, typename I, typename M>

using lsst::gauss2d::fit::Data< T, I, M >::Observation = lsst::gauss2d::fit::Observation<T, I, M>

Definition at line 34 of file data.h.

ObservationCRef

template<typename T, typename I, typename M>

using lsst::gauss2d::fit::Data< T, I, M >::ObservationCRef = std::reference_wrapper<const Observation>

Definition at line 35 of file data.h.

Constructor & Destructor Documentation

Data()

template<typename T, typename I, typename M>

lsst::gauss2d::fit::Data< T, I, M >::Data ( std::vector< std::shared_ptr< const Observation > > observations )

inlineexplicit

Construct a Data instance.

Parameters

observations

The Observation pointers to include. Must not be null.

Definition at line 42 of file data.h.

                                                                            {
        _observations.reserve(observations.size());
        _observation_ptrs.reserve(observations.size());
 
        for (const auto& observation : observations) {
            if (observation == nullptr) throw std::invalid_argument("Can't store null Observation");
            const auto& channel = observation->get_channel();
            if (_channels.find(channel) == _channels.end()) {
                _channels_ordered.push_back(channel);
                _channels.insert(channel);
            }
            _observations.push_back(ObservationCRef(*observation));
            _observation_ptrs.push_back(observation);
        }
    }

Member Function Documentation

at()

template<typename T, typename I, typename M>

auto lsst::gauss2d::fit::Data< T, I, M >::at ( size_t i ) const

inline

Definition at line 58 of file data.h.

{ return _observations.at(i); }

begin()

template<typename T, typename I, typename M>

auto lsst::gauss2d::fit::Data< T, I, M >::begin ( ) const

inline

Definition at line 59 of file data.h.

{ return _observations.begin(); }

cbegin()

template<typename T, typename I, typename M>

auto lsst::gauss2d::fit::Data< T, I, M >::cbegin ( ) const

inline

Definition at line 62 of file data.h.

{ return _observations.begin(); }

cend()

template<typename T, typename I, typename M>

auto lsst::gauss2d::fit::Data< T, I, M >::cend ( ) const

inline

Definition at line 63 of file data.h.

{ return _observations.end(); }

end()

template<typename T, typename I, typename M>

auto lsst::gauss2d::fit::Data< T, I, M >::end ( ) const

inline

Definition at line 60 of file data.h.

{ return _observations.end(); }

get_channels()

template<typename T, typename I, typename M>

std::vector< std::reference_wrapper< const Channel > > lsst::gauss2d::fit::Data< T, I, M >::get_channels ( ) const

inlineoverridevirtual

Get the set of channels this instance is applicable for.

Note

Implementers must return a set (all unique items). This cannot be enforced (yet).

Implements lsst::gauss2d::fit::Chromatic.

Definition at line 65 of file data.h.

                                                                                 {
        return _channels_ordered;
    }

get_parameters()

template<typename T, typename I, typename M>

ParamRefs & lsst::gauss2d::fit::Data< T, I, M >::get_parameters ( ParamRefs & params, ParamFilter * filter = nullptr ) const

inlineoverridevirtual

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 69 of file data.h.

                                                                                               {
        for (const Observation& exp : *this) exp.get_parameters(params, filter);
        return params;
    }

get_parameters_const()

template<typename T, typename I, typename M>

ParamCRefs & lsst::gauss2d::fit::Data< T, I, M >::get_parameters_const ( ParamCRefs & params, ParamFilter * filter = nullptr ) const

inlineoverridevirtual

Same as get_parameters(), but for const refs.

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

Definition at line 73 of file data.h.

                                                                                                       {
        for (auto exp_it = this->cbegin(); exp_it != this->cend(); ++exp_it) {
            (*exp_it).get().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()

template<typename T, typename I, typename M>

std::string lsst::gauss2d::fit::Data< T, I, M >::repr ( bool name_keywords = false, std::string_view namespace_separator = Object::CC_NAMESPACE_SEPARATOR ) const

inlineoverridevirtual

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 83 of file data.h.

                                                                                                       {
        std::string str = std::string("Data(") + (name_keywords ? "observations=[" : "[");
        for (auto exp_it = this->cbegin(); exp_it != this->cend(); ++exp_it) {
            str += (*exp_it).get().repr(name_keywords, namespace_separator) + ",";
        }
        str += "]);";
        return str;
    }

size()

template<typename T, typename I, typename M>

size_t lsst::gauss2d::fit::Data< T, I, M >::size ( ) const

inline

Get the number of member Observation.

Definition at line 81 of file data.h.

{ return _observations.size(); }

str()

template<typename T, typename I, typename M>

std::string lsst::gauss2d::fit::Data< T, I, M >::str ( ) const

inlineoverridevirtual

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

Implements lsst::gauss2d::Object.

Definition at line 92 of file data.h.

                                   {
        std::string str = "Data(observations=[";
        for (auto exp_it = this->cbegin(); exp_it != this->cend(); ++exp_it) {
            str += (*exp_it).get().str() + ",";
        }
        str += "])";
        return str;
    }

Member Data Documentation

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

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