lsst.gauss2d.fit g199a45376c+5e234f8357
 
Loading...
Searching...
No Matches
Public Member Functions | List of all members
lsst::gauss2d::fit::CentroidParameters Class Reference

#include <centroidparameters.h>

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

Public Member Functions

ParamRefs & get_parameters (ParamRefs &params, ParamFilter *filter=nullptr) const override
 
ParamCRefs & get_parameters_const (ParamCRefs &params, ParamFilter *filter=nullptr) const override
 Same as get_parameters(), but for const refs.
 
double get_x () const override
 
double get_y () const override
 
std::array< double, 2 > get_xy () const override
 
CentroidXParameterD & get_x_param () const
 Get a ref to the x param.
 
CentroidYParameterD & get_y_param () const
 Get a ref to the y param.
 
std::shared_ptr< CentroidXParameterD > get_x_param_ptr ()
 
std::shared_ptr< CentroidYParameterD > get_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
 
std::string str () const override
 
 CentroidParameters (std::shared_ptr< CentroidXParameterD > x=nullptr, std::shared_ptr< CentroidYParameterD > y=nullptr)
 
 CentroidParameters (double x, double y)
 Construct a CentroidParameters with default-constructed Parameters set to x/y values.
 
- Public Member Functions inherited from lsst::gauss2d::fit::Parametric
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.
 

Detailed Description

A Centroid with Parameters for x and y

Constructor & Destructor Documentation

◆ CentroidParameters()

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

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.

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

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