LSST Applications g013ef56533+7c9321ec0f,g042eb84c57+c6cfa41bc3,g199a45376c+0ba108daf9,g1fd858c14a+fcad0d0313,g210f2d0738+c0f94c6586,g262e1987ae+a7e710680e,g29ae962dfc+fb55f2edb0,g2ac17093b6+61d6563b1e,g2b1d02342f+df6f932764,g2cef7863aa+aef1011c0b,g2f7ad74990+c0f94c6586,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53cf87ae69,g47891489e3+4316d04fff,g511e8cfd20+baa56acf6c,g53246c7159+8c5ae1fdc5,g54cd7ddccb+fd7ad03fde,g64539dfbff+c0f94c6586,g67b6fd64d1+4316d04fff,g67fd3c3899+c0f94c6586,g6985122a63+4316d04fff,g74acd417e5+ca833bee28,g786e29fd12+668abc6043,g81db2e9a8d+b2ec8e584f,g87389fa792+8856018cbb,g89139ef638+4316d04fff,g8d7436a09f+0a24083b20,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+11eb8fd5b8,gbf99507273+8c5ae1fdc5,gcdda8b9158+e4c84c9d5c,gce8aa8abaa+8c5ae1fdc5,gd7ef33dd92+4316d04fff,gdab6d2f7ff+ca833bee28,ge410e46f29+4316d04fff,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.40
LSST Data Management Base Package
Loading...
Searching...
No Matches
lsst::gauss2d::CentroidData Class Referenceabstract

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

#include <centroid.h>

Inheritance diagram for lsst::gauss2d::CentroidData:
lsst::gauss2d::Object lsst::gauss2d::CentroidValues lsst::gauss2d::fit::CentroidParameters

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_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

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

49 {
50 return namespace_separator == CC_NAMESPACE_SEPARATOR ? "nullptr" : NULL_STR_GENERAL;
51 }
static constexpr std::string_view CC_NAMESPACE_SEPARATOR
The C++ namespace separator.
Definition object.h:45
static constexpr std::string_view NULL_STR_GENERAL
Definition object.h:46

◆ operator==()

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

Definition at line 56 of file centroid.h.

56 {
57 return (get_x() == other.get_x()) && (get_y() == other.get_y());
58 };
virtual double get_x() const =0
Get the x value.
virtual double get_y() const =0
Get the y value.

◆ 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_keywordsWhether to prefix arguments with "{name}=", where name is the arg name in the header (as with keyword arguments in Python).
namespace_separatorThe 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

◆ set_xy()

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

◆ set_y()

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

◆ 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

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