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())
	Construct an Observation instance.
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
	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.
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.
bool	operator== (const Observation &other) const
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::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.

Definition at line 35 of file observation.h.

Member Typedef Documentation

Image

template<typename T, typename I, typename M>

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

Definition at line 37 of file observation.h.

Mask

template<typename T, typename I, typename M>

using lsst::gauss2d::fit::Observation< T, I, M >::Mask = lsst::gauss2d::Image<bool, M>

Definition at line 38 of file observation.h.

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.

Definition at line 48 of file observation.h.

            : _image(std::move(image)),
              _sigma_inv(std::move(sigma_inv)),
              _mask_inv(std::move(mask_inv)),
              _channel(channel) {
        if ((_image == nullptr) || (_sigma_inv == nullptr) || (_mask_inv == nullptr)) {
            throw std::invalid_argument("Must supply non-null image, variance and mask");
        }
        std::string msg;
        bool passed = images_compatible<T, I, T, I>(*_image, *_sigma_inv, true, &msg);
        passed &= images_compatible<T, I, bool, M>(*_image, *_mask_inv, true, &msg);
        if (passed != (msg.empty()))
            throw std::logic_error("Observation images_compatible=" + std::to_string(passed)
                                   + " != msg != '' (=" + msg + ")");
        if (!passed) throw std::invalid_argument("image/variance/mask incompatible: " + msg);
    }

Member Function Documentation

get_channel()

template<typename T, typename I, typename M>

const Channel & lsst::gauss2d::fit::Observation< T, I, M >::get_channel ( ) const

inline

Get this->_channel.

Definition at line 67 of file observation.h.

{ return _channel; }

get_image()

template<typename T, typename I, typename M>

Image & lsst::gauss2d::fit::Observation< T, I, M >::get_image ( ) const

inline

Get a ref to this->_image.

Definition at line 79 of file observation.h.

{ return *_image; }

get_image_ptr_const()

template<typename T, typename I, typename M>

std::shared_ptr< const Image > lsst::gauss2d::fit::Observation< T, I, M >::get_image_ptr_const ( ) const

inline

Get this->_image.

Definition at line 69 of file observation.h.

{ return _image; }

get_mask_inverse()

template<typename T, typename I, typename M>

Mask & lsst::gauss2d::fit::Observation< T, I, M >::get_mask_inverse ( ) const

inline

Get a ref to this->_mask.

Definition at line 81 of file observation.h.

{ return *_mask_inv; }

get_n_cols()

template<typename T, typename I, typename M>

size_t lsst::gauss2d::fit::Observation< T, I, M >::get_n_cols ( ) const

inline

Get the number of columns in this->_image.

Definition at line 74 of file observation.h.

{ return _image->get_n_cols(); }

get_n_rows()

template<typename T, typename I, typename M>

size_t lsst::gauss2d::fit::Observation< T, I, M >::get_n_rows ( ) const

inline

Get the number of rows in this->_image.

Definition at line 76 of file observation.h.

{ return _image->get_n_rows(); }

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.

Definition at line 85 of file observation.h.

                                                                                               {
        return params;
    }

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.

Definition at line 88 of file observation.h.

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

get_sigma_inverse()

template<typename T, typename I, typename M>

Image & lsst::gauss2d::fit::Observation< T, I, M >::get_sigma_inverse ( ) const

inline

Get a ref to this->sigma_inv.

Definition at line 83 of file observation.h.

{ return *_sigma_inv; }

get_sigma_inverse_ptr_const()

template<typename T, typename I, typename M>

std::shared_ptr< const Image > lsst::gauss2d::fit::Observation< T, I, M >::get_sigma_inverse_ptr_const ( ) const

inline

Get this->_sigma_inv.

Definition at line 71 of file observation.h.

{ return _sigma_inv; }

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

operator==()

template<typename T, typename I, typename M>

bool lsst::gauss2d::fit::Observation< T, I, M >::operator== ( const Observation< T, I, M > & other ) const

inline

Definition at line 108 of file observation.h.

                                                    {
        return ((this->get_image() == other.get_image())
                && (this->get_mask_inverse() == other.get_mask_inverse())
                && (this->get_sigma_inverse() == other.get_sigma_inverse()));
    }

repr()

template<typename T, typename I, typename M>

std::string lsst::gauss2d::fit::Observation< 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 92 of file observation.h.

                                                                                                       {
        return type_name_str<Observation>(false, namespace_separator) + ")" + (name_keywords ? "image=" : "")
               + repr_ptr(_image.get(), name_keywords, namespace_separator) + ", "
               + (name_keywords ? "sigma_inv=" : "")
               + repr_ptr(_sigma_inv.get(), name_keywords, namespace_separator) + ", "
               + (name_keywords ? "mask_inv=" : "")
               + repr_ptr(_mask_inv.get(), name_keywords, namespace_separator) + ", "
               + (name_keywords ? "channel=" : "") + _channel.repr(name_keywords, namespace_separator) + ")";
    }

str()

template<typename T, typename I, typename M>

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

inlineoverridevirtual

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

Implements lsst::gauss2d::Object.

Definition at line 102 of file observation.h.

                                   {
        return type_name_str<Observation>(true) + "(image=" + str_ptr(_image.get())
               + ", sigma_inv=" + str_ptr(_sigma_inv.get()) + ", mask_inv=" + str_ptr(_mask_inv.get())
               + ", channel=" + _channel.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.0.0/Linux/gauss2d_fit/g199a45376c+0ba108daf9/include/lsst/gauss2d/fit/observation.h