lsst::gauss2d::Centroid Class Reference

A 2D coordinate representing the center of a plane figure. More...

#include <centroid.h>

Inheritance diagram for lsst::gauss2d::Centroid:

Public Member Functions
	Centroid (std::shared_ptr< CentroidData > data)
	Centroid (double x=0, double y=0)
void	convolve (const Centroid &cen)
	Convolve this with another centroid.
const CentroidData &	get_data () const
	Get this centroid's data.
double	get_x () const
	Get the x value.
std::array< double, 2 >	get_xy () const
	Get the x and y values.
double	get_y () const
	Get the y value.
std::shared_ptr< Centroid >	make_convolution (const Centroid &cen) const
	Return the convolution of this with another centroid.
std::unique_ptr< Centroid >	make_convolution_uniq (const Centroid &cen) const
	Same as make_convolution(), but returning a unique_ptr.
void	set_x (double x)
void	set_xy (const std::array< double, 2 > &xy)
void	set_y (double y)
std::string	repr (bool name_keywords=false, std::string_view namespace_separator=Object::CC_NAMESPACE_SEPARATOR) const override
std::string	str () const override
	Return a brief, human-readable string representation of this.
bool	operator== (const Centroid &other) const
bool	operator!= (const Centroid &other) const

Additional Inherited Members
Static Public Member Functions inherited from lsst::gauss2d::Object
static std::string_view	null_str (const std::string_view &namespace_separator)
Static Public Attributes inherited from lsst::gauss2d::Object
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

A 2D coordinate representing the center of a plane figure.

This is a centroid in a 2D coordinate system, generally used for ellipses in this package. Storage is implemented in CentroidData.

Parameters

data	The centroid data

Member Function Documentation

convolve()

void lsst::gauss2d::Centroid::convolve

(

const Centroid &

cen

)

Convolve this with another centroid.

Convolution simply adds the value of the other centroid to this.

Parameters

cen	The centroid to convolve with

make_convolution()

std::shared_ptr< Centroid > lsst::gauss2d::Centroid::make_convolution

(

const Centroid &

cen

)

const

Return the convolution of this with another centroid.

Convolution simply adds the values of both centroids together

Parameters

cen	The centroid to convolve with

Returns

A new centroid with values set to the convolution.

repr()

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

overridevirtual

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.

str()

std::string lsst::gauss2d::Centroid::str ( ) const

overridevirtual

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

Implements lsst::gauss2d::Object.

---

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

• include/lsst/gauss2d/centroid.h
• src/centroid.cc