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

An observed single-channel image with an associated variance and mask. More...

#include <observation.h>

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

Public Types
using	Image = lsst::gauss2d::Image<T, I>
using	Mask = lsst::gauss2d::Image<bool, M>

Public Member Functions
	Observation (std::shared_ptr< Image > image, std::shared_ptr< Image > sigma_inv, std::shared_ptr< Mask > mask_inv, const Channel &channel=Channel::NONE())
const Channel &	get_channel () const
	Get this->_channel.
std::shared_ptr< const Image >	get_image_ptr_const () const
	Get this->_image.
std::shared_ptr< const Image >	get_sigma_inverse_ptr_const () const
	Get this->_sigma_inv.
size_t	get_n_cols () const
	Get the number of columns in this->_image.
size_t	get_n_rows () const
	Get the number of rows in this->_image.
Image &	get_image () const
	Get a ref to this->_image.
Mask &	get_mask_inverse () const
	Get a ref to this->_mask.
Image &	get_sigma_inverse () const
	Get a ref to this->sigma_inv.
ParamRefs &	get_parameters (ParamRefs &params, ParamFilter *filter=nullptr) const override
ParamCRefs &	get_parameters_const (ParamCRefs &params, ParamFilter *filter=nullptr) const override
	Same as get_parameters(), but for const refs.
std::string	repr (bool name_keywords=false, std::string_view namespace_separator=Object::CC_NAMESPACE_SEPARATOR) const override
std::string	str () const override
bool	operator== (const Observation &other) const
Public Member Functions inherited from lsst::gauss2d::fit::Parametric
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.

Detailed Description

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

An observed single-channel image with an associated variance and mask.

An Observation is an Image in a single Channel with a corresponding variance and mask. The variance is provided as inverse sigma to facilitate Model evaluation. Observation Image instances may represent a single physical exposure or more generic data, such as processed data like coadded/stacked images.

Note

The Mask convention is that of an "inverse" mask. Pixels with positive Mask valuese used, while values <= 0 are ignored.

Template Parameters

T	The type of the Image (usually float or double).
Image	The class of image used in Data.
Indices	The class of index map used in Data.
Mask	The class of mask f.

Constructor & Destructor Documentation

Observation()

template<typename T, typename I, typename M>

lsst::gauss2d::fit::Observation< T, I, M >::Observation ( std::shared_ptr< Image > image, std::shared_ptr< Image > sigma_inv, std::shared_ptr< Mask > mask_inv, const Channel & channel = Channel::NONE() )

inlineexplicit

Construct an Observation instance.

Parameters

image	The Image to assign to _image.
sigma_inv	The Image to assign to _sigma_inv. Must have identical dimensions as image.
mask_inv	The mask Image to assign to _mask.
channel	The channel of every Observation.

Member Function Documentation

get_parameters()

template<typename T, typename I, typename M>

ParamRefs & lsst::gauss2d::fit::Observation< 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.

get_parameters_const()

template<typename T, typename I, typename M>

ParamCRefs & lsst::gauss2d::fit::Observation< 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.

---

The documentation for this class was generated from the following file:

• include/lsst/gauss2d/fit/observation.h