LSST Applications g013ef56533+b8d55c8942,g083dd6704c+a047e97985,g199a45376c+0ba108daf9,g1fd858c14a+7a3b874d60,g210f2d0738+7416ca6900,g262e1987ae+1d557ba9a3,g29ae962dfc+519d34895e,g2cef7863aa+aef1011c0b,g30d7c61c20+36d16ea71a,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+cb326ad149,g47891489e3+f459a6810c,g53246c7159+8c5ae1fdc5,g54cd7ddccb+890c8e1e5d,g5a60e81ecd+6240c63dbc,g64539dfbff+7416ca6900,g67b6fd64d1+f459a6810c,g6ebf1fc0d4+8c5ae1fdc5,g74acd417e5+0bae3c876a,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+f459a6810c,g8d7436a09f+dee7680868,g8ea07a8fe4+81eaaadc04,g90f42f885a+34c0557caf,g97be763408+14b8164b5b,g98a1a72a9c+8389601a76,g98df359435+fff771c62d,gb8cb2b794d+6728931916,gbf99507273+8c5ae1fdc5,gc2a301910b+7416ca6900,gca7fc764a6+f459a6810c,gd7ef33dd92+f459a6810c,gdab6d2f7ff+0bae3c876a,ge410e46f29+f459a6810c,ge41e95a9f2+7416ca6900,geaed405ab2+e3b4b2a692,gf9a733ac38+8c5ae1fdc5,w.2025.43
LSST Data Management Base Package
Loading...
Searching...
No Matches
lsst::gauss2d::fit::CentroidParameters Class Reference

A Centroid with Parameters for x and y. More...

#include <centroidparameters.h>

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

Public Member Functions

ParamRefsget_parameters (ParamRefs &params, ParamFilter *filter=nullptr) const override
 Add Parameter refs matching the filter to a vector, in order.
 
ParamCRefsget_parameters_const (ParamCRefs &params, ParamFilter *filter=nullptr) const override
 Same as get_parameters(), but for const refs.
 
double get_x () const override
 Get the x value.
 
double get_y () const override
 Get the y value.
 
std::array< double, 2 > get_xy () const override
 Get the x and y values.
 
CentroidXParameterDget_x_param () const
 Get a ref to the x param.
 
CentroidYParameterDget_y_param () const
 Get a ref to the y param.
 
std::shared_ptr< CentroidXParameterDget_x_param_ptr ()
 
std::shared_ptr< CentroidYParameterDget_y_param_ptr ()
 
void set_x (double x) override
 
void set_y (double y) override
 
void set_xy (const std::array< double, 2 > &xy) override
 
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.
 
 CentroidParameters (std::shared_ptr< CentroidXParameterD > x=nullptr, std::shared_ptr< CentroidYParameterD > y=nullptr)
 Construct a CentroidParameters.
 
 CentroidParameters (double x, double y)
 Construct a CentroidParameters with default-constructed Parameters set to x/y values.
 
bool operator== (const CentroidData &other) const
 
ParamRefs get_parameters_new (ParamFilter *filter=nullptr) const
 Same as get_parameters(), but returning a new vector.
 
ParamCRefs get_parameters_const_new (ParamFilter *filter=nullptr) const
 Same as get_parameters_const(), but returning a new vector.
 

Static Public Member Functions

static std::string_view null_str (const std::string_view &namespace_separator)
 
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 = "."
 
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 Centroid with Parameters for x and y.

Definition at line 15 of file centroidparameters.h.

Constructor & Destructor Documentation

◆ CentroidParameters() [1/2]

lsst::gauss2d::fit::CentroidParameters::CentroidParameters ( std::shared_ptr< CentroidXParameterD > x = nullptr,
std::shared_ptr< CentroidYParameterD > y = nullptr )
explicit

Construct a CentroidParameters.

Parameters
xThe x parameter. Default-constructed if null
yThe y parameter. Default-constructed if null

Definition at line 15 of file centroidparameters.cc.

17 : CentroidData(),
18 _x(x == nullptr ? std::make_shared<CentroidXParameterD>() : std::move(x)),
19 _y(y == nullptr ? std::make_shared<CentroidYParameterD>() : std::move(y)) {}
T make_shared(T... args)
T move(T... args)

◆ CentroidParameters() [2/2]

lsst::gauss2d::fit::CentroidParameters::CentroidParameters ( double x,
double y )

Construct a CentroidParameters with default-constructed Parameters set to x/y values.

Definition at line 21 of file centroidparameters.cc.

Member Function Documentation

◆ get_parameters()

ParamRefs & lsst::gauss2d::fit::CentroidParameters::get_parameters ( ParamRefs & params,
ParamFilter * filter = nullptr ) const
overridevirtual

Add Parameter refs matching the filter to a vector, in order.

Parameters
paramsThe vector to add to.
filterThe filter to apply to this Object's parameters.
Returns
A ref to params (for method chaining)

Implements lsst::gauss2d::fit::Parametric.

Definition at line 26 of file centroidparameters.cc.

26 {
27 return _get_parameters<ParamRefs>(params, filter, this->get_x_param(), this->get_y_param());
28}
CentroidYParameterD & get_y_param() const
Get a ref to the y param.
CentroidXParameterD & get_x_param() const
Get a ref to the x param.
t & _get_parameters(t &params, ParamFilter *filter, CentroidXParameterD &x, CentroidYParameterD &y)

◆ get_parameters_const()

ParamCRefs & lsst::gauss2d::fit::CentroidParameters::get_parameters_const ( ParamCRefs & params,
ParamFilter * filter = nullptr ) const
overridevirtual

Same as get_parameters(), but for const refs.

Implements lsst::gauss2d::fit::Parametric.

Definition at line 30 of file centroidparameters.cc.

30 {
31 return _get_parameters<ParamCRefs>(params, filter, this->get_x_param(), this->get_y_param());
32}

◆ get_parameters_const_new()

ParamCRefs lsst::gauss2d::fit::Parametric::get_parameters_const_new ( ParamFilter * filter = nullptr) const
inlineinherited

Same as get_parameters_const(), but returning a new vector.

Definition at line 33 of file parametric.h.

33 {
34 ParamCRefs params{};
35 get_parameters_const(params, filter);
36 return params;
37 }
virtual ParamCRefs & get_parameters_const(ParamCRefs &params, ParamFilter *filter=nullptr) const =0
Same as get_parameters(), but for const refs.
std::vector< ParamBaseCRef > ParamCRefs
Definition param_defs.h:11

◆ get_parameters_new()

ParamRefs lsst::gauss2d::fit::Parametric::get_parameters_new ( ParamFilter * filter = nullptr) const
inlineinherited

Same as get_parameters(), but returning a new vector.

Definition at line 27 of file parametric.h.

27 {
28 ParamRefs params{};
29 get_parameters(params, filter);
30 return params;
31 }
virtual ParamRefs & get_parameters(ParamRefs &params, ParamFilter *filter=nullptr) const =0
Add Parameter refs matching the filter to a vector, in order.
std::vector< ParamBaseRef > ParamRefs
Definition param_defs.h:13

◆ get_x()

double lsst::gauss2d::fit::CentroidParameters::get_x ( ) const
overridevirtual

Get the x value.

Implements lsst::gauss2d::CentroidData.

Definition at line 34 of file centroidparameters.cc.

34{ return _x->get_value(); }

◆ get_x_param()

CentroidXParameterD & lsst::gauss2d::fit::CentroidParameters::get_x_param ( ) const

Get a ref to the x param.

Definition at line 38 of file centroidparameters.cc.

38{ return *_x; }

◆ get_x_param_ptr()

std::shared_ptr< CentroidXParameterD > lsst::gauss2d::fit::CentroidParameters::get_x_param_ptr ( )

Definition at line 41 of file centroidparameters.cc.

41{ return _x; }

◆ get_xy()

std::array< double, 2 > lsst::gauss2d::fit::CentroidParameters::get_xy ( ) const
overridevirtual

Get the x and y values.

Implements lsst::gauss2d::CentroidData.

Definition at line 36 of file centroidparameters.cc.

36{ return {this->get_x(), this->get_y()}; }
double get_y() const override
Get the y value.
double get_x() const override
Get the x value.

◆ get_y()

double lsst::gauss2d::fit::CentroidParameters::get_y ( ) const
overridevirtual

Get the y value.

Implements lsst::gauss2d::CentroidData.

Definition at line 35 of file centroidparameters.cc.

35{ return _y->get_value(); }

◆ get_y_param()

CentroidYParameterD & lsst::gauss2d::fit::CentroidParameters::get_y_param ( ) const

Get a ref to the y param.

Definition at line 39 of file centroidparameters.cc.

39{ return *_y; }

◆ get_y_param_ptr()

std::shared_ptr< CentroidYParameterD > lsst::gauss2d::fit::CentroidParameters::get_y_param_ptr ( )

Definition at line 42 of file centroidparameters.cc.

42{ return _y; }

◆ null_str() [1/2]

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

◆ null_str() [2/2]

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 }

◆ operator==()

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

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

std::string lsst::gauss2d::fit::CentroidParameters::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_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::CentroidData.

Definition at line 51 of file centroidparameters.cc.

51 {
52 return type_name_str<CentroidParameters>(false, namespace_separator) + "(" + (name_keywords ? "x=" : "")
53 + _x->repr(name_keywords, namespace_separator) + ", " + (name_keywords ? "y=" : "")
54 + _y->repr(name_keywords, namespace_separator) + ")";
55}
std::string type_name_str(bool strip_namespace=false, std::string_view namespace_str=detail::NAMESPACE_SEPARATOR)
Get a string representation of an arbitrary C++ type, potentially modifying its namespace prefix.
Definition type_name.h:104

◆ set_x()

void lsst::gauss2d::fit::CentroidParameters::set_x ( double x)
overridevirtual

Implements lsst::gauss2d::CentroidData.

Definition at line 44 of file centroidparameters.cc.

44{ _x->set_value(x); }

◆ set_xy()

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

Implements lsst::gauss2d::CentroidData.

Definition at line 46 of file centroidparameters.cc.

46 {
47 this->set_x(xy[0]);
48 this->set_y(xy[1]);
49}

◆ set_y()

void lsst::gauss2d::fit::CentroidParameters::set_y ( double y)
overridevirtual

Implements lsst::gauss2d::CentroidData.

Definition at line 45 of file centroidparameters.cc.

45{ _y->set_value(y); }

◆ str()

std::string lsst::gauss2d::fit::CentroidParameters::str ( ) const
overridevirtual

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

Implements lsst::gauss2d::CentroidData.

Definition at line 57 of file centroidparameters.cc.

57 {
58 return type_name_str<CentroidParameters>(true) + "(x=" + _x->str() + ", y=" + _y->str() + ")";
59}

Member Data Documentation

◆ CC_NAMESPACE_SEPARATOR [1/2]

std::string_view lsst::gauss2d::Object::CC_NAMESPACE_SEPARATOR = "::"
staticconstexprinherited

The C++ namespace separator.

Definition at line 45 of file object.h.

◆ CC_NAMESPACE_SEPARATOR [2/2]

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 [1/2]

std::string_view lsst::gauss2d::Object::NULL_STR_GENERAL = "None"
staticconstexprinherited

Definition at line 46 of file object.h.

◆ NULL_STR_GENERAL [2/2]

std::string_view lsst::gauss2d::Object::NULL_STR_GENERAL = "None"
staticconstexprinherited

Definition at line 46 of file object.h.

◆ PY_NAMESPACE_SEPARATOR [1/2]

std::string_view lsst::gauss2d::Object::PY_NAMESPACE_SEPARATOR = "."
staticconstexprinherited

Definition at line 47 of file object.h.

◆ PY_NAMESPACE_SEPARATOR [2/2]

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: