lsst::gauss2d::Object Class Reference

#include <object.h>

Inheritance diagram for lsst::gauss2d::Object:

Public Member Functions
virtual std::string	repr (bool name_keywords=false, std::string_view namespace_separator=CC_NAMESPACE_SEPARATOR) const =0
virtual std::string	str () const =0
	Return a brief, human-readable string representation of this.

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 = "."

Friends
std::ostream &	operator<< (std::ostream &out, const Object &obj)

Detailed Description

A generic object from the gauss2d library.

Objects have string representations that are guaranteed to be valid in C++ and should also be valid in Python bindings, if implemented correctly. The interface may be expanded in the future.

Member Function Documentation

repr()

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

pure virtual

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.

Implemented in lsst::gauss2d::Centroid, lsst::gauss2d::CentroidData, lsst::gauss2d::CentroidValues, lsst::gauss2d::ConvolvedGaussian, lsst::gauss2d::ConvolvedGaussians, lsst::gauss2d::CoordinateSystem, lsst::gauss2d::Covariance, lsst::gauss2d::detail::GradientsExtra< t, Data, Indices >, lsst::gauss2d::Ellipse, lsst::gauss2d::EllipseData, lsst::gauss2d::EllipseMajor, lsst::gauss2d::EllipseValues, lsst::gauss2d::Gaussian, lsst::gauss2d::GaussianEvaluator< T, Data, Indices >, lsst::gauss2d::GaussianIntegral, lsst::gauss2d::GaussianIntegralValue, lsst::gauss2d::Gaussians, lsst::gauss2d::Image< T, C >, lsst::gauss2d::Image< idx_type, Indices >, lsst::gauss2d::Image< idx_type, Indices >, lsst::gauss2d::Image< T, Data >, lsst::gauss2d::Image< T, Data >, lsst::gauss2d::Image< t, Data >, lsst::gauss2d::Image< T, Image< T > >, lsst::gauss2d::Image< T, VectorImage< T > >, lsst::gauss2d::ImageArray< T, C >, lsst::gauss2d::ImageArray< double, Image >, lsst::gauss2d::ImageArray< double, Image >, lsst::gauss2d::ImageArray< T, Data >, and lsst::gauss2d::ImageArray< T, Data >.

str()

virtual std::string lsst::gauss2d::Object::str ( ) const

pure virtual

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

Implemented in lsst::gauss2d::Centroid, lsst::gauss2d::CentroidData, lsst::gauss2d::CentroidValues, lsst::gauss2d::ConvolvedGaussian, lsst::gauss2d::ConvolvedGaussians, lsst::gauss2d::CoordinateSystem, lsst::gauss2d::Covariance, lsst::gauss2d::detail::GradientsExtra< t, Data, Indices >, lsst::gauss2d::Ellipse, lsst::gauss2d::EllipseData, lsst::gauss2d::EllipseMajor, lsst::gauss2d::EllipseValues, lsst::gauss2d::Gaussian, lsst::gauss2d::GaussianEvaluator< T, Data, Indices >, lsst::gauss2d::GaussianIntegral, lsst::gauss2d::GaussianIntegralValue, lsst::gauss2d::Gaussians, lsst::gauss2d::Image< T, C >, lsst::gauss2d::Image< idx_type, Indices >, lsst::gauss2d::Image< idx_type, Indices >, lsst::gauss2d::Image< T, Data >, lsst::gauss2d::Image< T, Data >, lsst::gauss2d::Image< t, Data >, lsst::gauss2d::Image< T, Image< T > >, lsst::gauss2d::Image< T, VectorImage< T > >, lsst::gauss2d::ImageArray< T, C >, lsst::gauss2d::ImageArray< double, Image >, lsst::gauss2d::ImageArray< double, Image >, lsst::gauss2d::ImageArray< T, Data >, and lsst::gauss2d::ImageArray< T, Data >.

---

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

• include/lsst/gauss2d/object.h