lsst::gauss2d::CentroidData Class Reference

Interface for an object storing Centroid data. More...

#include <centroid.h>

Inheritance diagram for lsst::gauss2d::CentroidData:

Public Member Functions
virtual double	get_x () const =0
	Get the x value.
virtual std::array< double, 2 >	get_xy () const =0
	Get the x and y values.
virtual double	get_y () const =0
	Get the y value.
virtual void	set_x (double x)=0
virtual void	set_xy (const std::array< double, 2 > &xy)=0
virtual void	set_y (double y)=0
bool	operator== (const CentroidData &other) const
virtual std::string	repr (bool name_keywords=false, std::string_view namespace_separator=Object::CC_NAMESPACE_SEPARATOR) const override=0
	Return a full, callable string representation of this.
virtual std::string	str () const override=0
	Return a brief, human-readable string representation of this.
virtual	~CentroidData ()=default

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

Interface for an object storing Centroid data.

This is an abstract class designed to store data for a Centroid to retrieve. No additional restrictions are placed on implementations.

Definition at line 43 of file centroid.h.

Constructor & Destructor Documentation

~CentroidData()

virtual lsst::gauss2d::CentroidData::~CentroidData ( )

virtualdefault

Member Function Documentation

get_x()

virtual double lsst::gauss2d::CentroidData::get_x ( ) const

pure virtual

Get the x value.

Implemented in lsst::gauss2d::CentroidValues, and lsst::gauss2d::fit::CentroidParameters.

get_xy()

virtual std::array< double, 2 > lsst::gauss2d::CentroidData::get_xy ( ) const

pure virtual

Get the x and y values.

Implemented in lsst::gauss2d::CentroidValues, and lsst::gauss2d::fit::CentroidParameters.

get_y()

virtual double lsst::gauss2d::CentroidData::get_y ( ) const

pure virtual

Get the y value.

Implemented in lsst::gauss2d::CentroidValues, and lsst::gauss2d::fit::CentroidParameters.

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==()

bool lsst::gauss2d::CentroidData::operator== ( const CentroidData & other ) const

inline

Definition at line 56 of file centroid.h.

                                                     {
        return (get_x() == other.get_x()) && (get_y() == other.get_y());
    };

repr()

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

overridepure 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.

Implements lsst::gauss2d::Object.

Implemented in lsst::gauss2d::CentroidValues, and lsst::gauss2d::fit::CentroidParameters.

set_x()

virtual void lsst::gauss2d::CentroidData::set_x ( double x )

pure virtual

Implemented in lsst::gauss2d::CentroidValues, and lsst::gauss2d::fit::CentroidParameters.

set_xy()

virtual void lsst::gauss2d::CentroidData::set_xy ( const std::array< double, 2 > & xy )

pure virtual

Implemented in lsst::gauss2d::CentroidValues, and lsst::gauss2d::fit::CentroidParameters.

set_y()

virtual void lsst::gauss2d::CentroidData::set_y ( double y )

pure virtual

Implemented in lsst::gauss2d::CentroidValues, and lsst::gauss2d::fit::CentroidParameters.

str()

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

overridepure virtual

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

Implements lsst::gauss2d::Object.

Implemented in lsst::gauss2d::CentroidValues, and lsst::gauss2d::fit::CentroidParameters.

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/gauss2d/g9125e01d80+a8ce1bb630/include/lsst/gauss2d/centroid.h