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
	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 Centroid &other) const
bool	operator!= (const Centroid &other) const

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

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

Definition at line 114 of file centroid.h.

Constructor & Destructor Documentation

Centroid() [1/2]

lsst::gauss2d::Centroid::Centroid ( std::shared_ptr< CentroidData > data )

explicit

Definition at line 109 of file centroid.cc.

        : _data(data == nullptr ? std::make_shared<CentroidValues>() : std::move(data)) {}

Centroid() [2/2]

lsst::gauss2d::Centroid::Centroid ( double x = 0, double y = 0 )

explicit

Definition at line 112 of file centroid.cc.

                                     : _data(std::make_shared<CentroidValues>()) {
    set_x(x);
    set_y(y);
}

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

Definition at line 69 of file centroid.cc.

                                           {
    this->set_x(this->get_x() + cen.get_x());
    this->set_y(this->get_y() + cen.get_y());
}

get_data()

const CentroidData & lsst::gauss2d::Centroid::get_data

(

)

const

Get this centroid's data.

Definition at line 74 of file centroid.cc.

{ return *_data; }

get_x()

double lsst::gauss2d::Centroid::get_x

(

)

const

Get the x value.

Definition at line 76 of file centroid.cc.

{ return _data->get_x(); }

get_xy()

std::array< double, 2 > lsst::gauss2d::Centroid::get_xy

(

)

const

Get the x and y values.

Definition at line 78 of file centroid.cc.

{ return _data->get_xy(); }

get_y()

double lsst::gauss2d::Centroid::get_y

(

)

const

Get the y value.

Definition at line 80 of file centroid.cc.

{ return _data->get_y(); }

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.

Definition at line 82 of file centroid.cc.

                                                                            {
    return this->make_convolution_uniq(cen);
}

make_convolution_uniq()

std::unique_ptr< Centroid > lsst::gauss2d::Centroid::make_convolution_uniq

(

const Centroid &

cen

)

const

Same as make_convolution(), but returning a unique_ptr.

Definition at line 85 of file centroid.cc.

                                                                                 {
    // TODO: Replace with cloning derived data
    std::unique_ptr<Centroid> cen_ret = std::make_unique<Centroid>(this->get_x(), this->get_y());
    cen_ret->convolve(cen);
    return cen_ret;
}

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::Centroid::operator!=

(

const Centroid &

other

)

const

Definition at line 107 of file centroid.cc.

{ return !(*this == other); }

operator==()

bool lsst::gauss2d::Centroid::operator==

(

const Centroid &

other

)

const

Definition at line 103 of file centroid.cc.

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

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.

Definition at line 96 of file centroid.cc.

                                                                                     {
    return type_name_str<Centroid>(false, namespace_separator) + "(" + (name_keywords ? "data=" : "")
           + _data->repr(name_keywords, namespace_separator) + ")";
}

set_x()

void lsst::gauss2d::Centroid::set_x

(

double

x

)

Definition at line 92 of file centroid.cc.

{ _data->set_x(x); }

set_xy()

void lsst::gauss2d::Centroid::set_xy

(

const std::array< double, 2 > &

xy

)

Definition at line 93 of file centroid.cc.

{ _data->set_xy(xy); }

set_y()

void lsst::gauss2d::Centroid::set_y

(

double

y

)

Definition at line 94 of file centroid.cc.

{ _data->set_y(y); }

str()

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

overridevirtual

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

Implements lsst::gauss2d::Object.

Definition at line 101 of file centroid.cc.

{ return type_name_str<Centroid>(true) + "(data=" + _data->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 files:

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-10.1.0/Linux/gauss2d/g9125e01d80+fcb1d3bbc8/include/lsst/gauss2d/centroid.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-10.1.0/Linux/gauss2d/g9125e01d80+fcb1d3bbc8/src/centroid.cc