lsst::gauss2d::CentroidValues Class Reference

A CentroidData storing centroid values as shared_ptrs. More...

#include <centroid.h>

Inheritance diagram for lsst::gauss2d::CentroidValues:

Public Member Functions
double	get_x () const override
	Get the x value.
std::array< double, 2 >	get_xy () const override
	Get the x and y values.
double	get_y () const override
	Get the y value.
void	set_x (double x) override
void	set_xy (const std::array< double, 2 > &xy) override
void	set_y (double y) override
std::string	repr (bool name_keywords, std::string_view 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 CentroidValues &other) const
bool	operator!= (const CentroidValues &other) const
	CentroidValues (std::shared_ptr< double > x, std::shared_ptr< double > y)
	Construct a new Centroid Values object.
	CentroidValues (double x=0, double y=0)
virtual	~CentroidValues ()
bool	operator== (const CentroidData &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 CentroidData storing centroid values as shared_ptrs.

This implementation stores values in shared_ptrs, allowing sharing of values with other instances.

Definition at line 74 of file centroid.h.

Constructor & Destructor Documentation

CentroidValues() [1/2]

lsst::gauss2d::CentroidValues::CentroidValues	(	std::shared_ptr< double >	x,
		std::shared_ptr< double >	y )

Construct a new Centroid Values object.

Parameters

x	The x-axis centroid value
y	The y-axis centroid value

Definition at line 62 of file centroid.cc.

        : _x(x == nullptr ? std::make_shared<double>(0) : std::move(x)),
          _y(y == nullptr ? std::make_shared<double>(0) : std::move(y)) {}

CentroidValues() [2/2]

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

Definition at line 66 of file centroid.cc.

        : _x(std::make_shared<double>(x)), _y(std::make_shared<double>(y)) {}

~CentroidValues()

virtual lsst::gauss2d::CentroidValues::~CentroidValues ( )

inlinevirtual

Definition at line 99 of file centroid.h.

{};

Member Function Documentation

get_x()

double lsst::gauss2d::CentroidValues::get_x ( ) const

overridevirtual

Get the x value.

Implements lsst::gauss2d::CentroidData.

Definition at line 35 of file centroid.cc.

{ return *_x; }

get_xy()

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

overridevirtual

Get the x and y values.

Implements lsst::gauss2d::CentroidData.

Definition at line 36 of file centroid.cc.

{ return {*_x, *_y}; }

get_y()

double lsst::gauss2d::CentroidValues::get_y ( ) const

overridevirtual

Get the y value.

Implements lsst::gauss2d::CentroidData.

Definition at line 37 of file centroid.cc.

{ return *_y; }

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

(

const CentroidValues &

other

)

const

Definition at line 60 of file centroid.cc.

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

operator==() [1/2]

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

inlineinherited

Definition at line 56 of file centroid.h.

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

operator==() [2/2]

bool lsst::gauss2d::CentroidValues::operator==

(

const CentroidValues &

other

)

const

Definition at line 56 of file centroid.cc.

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

repr()

std::string lsst::gauss2d::CentroidValues::repr ( bool name_keywords, std::string_view 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::CentroidData.

Definition at line 46 of file centroid.cc.

                                                                                           {
    return type_name_str<CentroidValues>(false, namespace_separator) + "(" + (name_keywords ? "x=" : "")
           + to_string_float(*_x) + ", " + (name_keywords ? "y=" : "") + to_string_float(*_y) + ")";
}

set_x()

void lsst::gauss2d::CentroidValues::set_x ( double x )

overridevirtual

Implements lsst::gauss2d::CentroidData.

Definition at line 39 of file centroid.cc.

{ *_x = x; }

set_xy()

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

overridevirtual

Implements lsst::gauss2d::CentroidData.

Definition at line 40 of file centroid.cc.

                                                         {
    *_x = xy[0];
    *_y = xy[1];
};

set_y()

void lsst::gauss2d::CentroidValues::set_y ( double y )

overridevirtual

Implements lsst::gauss2d::CentroidData.

Definition at line 44 of file centroid.cc.

{ *_y = y; }

str()

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

overridevirtual

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

Implements lsst::gauss2d::CentroidData.

Definition at line 51 of file centroid.cc.

                                    {
    return type_name_str<CentroidValues>(true) + "(x=" + to_string_float(*_x) + ", y=" + to_string_float(*_y)
           + ")";
}

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

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