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::ParametricEllipse Class Referenceabstract

A Parametric QuasiEllipse. More...

#include <parametricellipse.h>

Inheritance diagram for lsst::gauss2d::fit::ParametricEllipse:
lsst::gauss2d::fit::Parametric lsst::gauss2d::fit::QuasiEllipse lsst::gauss2d::Object lsst::gauss2d::fit::GaussianParametricEllipse lsst::gauss2d::fit::SersicParametricEllipse

Public Member Functions

virtual RhoParameterDget_rho_param () const =0
 
virtual SizeXParameterDget_size_x_param () const =0
 
virtual SizeYParameterDget_size_y_param () const =0
 
virtual std::shared_ptr< RhoParameterDget_rho_param_ptr ()=0
 
virtual std::shared_ptr< SizeXParameterDget_size_x_param_ptr ()=0
 
virtual std::shared_ptr< SizeYParameterDget_size_y_param_ptr ()=0
 
virtual void set_rho (double rho)=0
 
virtual void set_size_x (double size_x)=0
 
virtual void set_size_y (double size_y)=0
 
virtual void set_xyr (const std::array< double, 3 > &xyr)
 
virtual ParamRefsget_parameters (ParamRefs &params, ParamFilter *filter=nullptr) const =0
 Add Parameter refs matching the filter to a vector, in order.
 
virtual ParamCRefsget_parameters_const (ParamCRefs &params, ParamFilter *filter=nullptr) const =0
 Same as get_parameters(), but for const refs.
 
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.
 
virtual std::string repr (bool name_keywords=false, std::string_view namespace_separator=CC_NAMESPACE_SEPARATOR) const =0
 Return a full, callable string representation of this.
 
virtual std::string str () const =0
 Return a brief, human-readable string representation of this.
 
virtual double get_rho () const =0
 Get the rho value.
 
virtual double get_size_x () const =0
 Get the size_x value.
 
virtual double get_size_y () const =0
 Get the size_y value.
 
virtual std::array< double, 3 > get_xyr () const
 Get the array of size_x, size_y, rho.
 

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 Parametric QuasiEllipse.

Definition at line 36 of file parametricellipse.h.

Member Function Documentation

◆ get_parameters()

◆ get_parameters_const()

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

virtual double lsst::gauss2d::fit::QuasiEllipse::get_rho ( ) const
pure virtualinherited

◆ get_rho_param()

virtual RhoParameterD & lsst::gauss2d::fit::ParametricEllipse::get_rho_param ( ) const
pure virtual

◆ get_rho_param_ptr()

virtual std::shared_ptr< RhoParameterD > lsst::gauss2d::fit::ParametricEllipse::get_rho_param_ptr ( )
pure virtual

◆ get_size_x()

virtual double lsst::gauss2d::fit::QuasiEllipse::get_size_x ( ) const
pure virtualinherited

◆ get_size_x_param()

virtual SizeXParameterD & lsst::gauss2d::fit::ParametricEllipse::get_size_x_param ( ) const
pure virtual

◆ get_size_x_param_ptr()

virtual std::shared_ptr< SizeXParameterD > lsst::gauss2d::fit::ParametricEllipse::get_size_x_param_ptr ( )
pure virtual

◆ get_size_y()

virtual double lsst::gauss2d::fit::QuasiEllipse::get_size_y ( ) const
pure virtualinherited

◆ get_size_y_param()

virtual SizeYParameterD & lsst::gauss2d::fit::ParametricEllipse::get_size_y_param ( ) const
pure virtual

◆ get_size_y_param_ptr()

virtual std::shared_ptr< SizeYParameterD > lsst::gauss2d::fit::ParametricEllipse::get_size_y_param_ptr ( )
pure virtual

◆ get_xyr()

virtual std::array< double, 3 > lsst::gauss2d::fit::QuasiEllipse::get_xyr ( ) const
inlinevirtualinherited

Get the array of size_x, size_y, rho.

Reimplemented in lsst::gauss2d::fit::GaussianParametricEllipse, lsst::gauss2d::fit::SersicEllipseData, and lsst::gauss2d::fit::SersicParametricEllipse.

Definition at line 28 of file parametricellipse.h.

28{ return {get_size_x(), get_size_y(), get_rho()}; };
virtual double get_rho() const =0
Get the rho value.
virtual double get_size_x() const =0
Get the size_x value.
virtual double get_size_y() const =0
Get the size_y value.

◆ 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

◆ repr()

virtual std::string lsst::gauss2d::Object::repr ( bool name_keywords = false,
std::string_view namespace_separator = CC_NAMESPACE_SEPARATOR ) const
pure virtualinherited

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.

Implemented in lsst::gauss2d::Centroid, lsst::gauss2d::CentroidData, lsst::gauss2d::CentroidValues, lsst::gauss2d::ConvolvedGaussian, lsst::gauss2d::ConvolvedGaussians, lsst::gauss2d::CoordinateSystem, lsst::gauss2d::Covariance, lsst::gauss2d::detail::GradientsExtra< t, Data, Indices >, lsst::gauss2d::Ellipse, lsst::gauss2d::EllipseData, lsst::gauss2d::EllipseMajor, lsst::gauss2d::EllipseValues, lsst::gauss2d::fit::CentroidParameters, lsst::gauss2d::fit::Channel, lsst::gauss2d::fit::Data< T, I, M >, lsst::gauss2d::fit::Data< T, Image, Mask >, lsst::gauss2d::fit::Data< T, Image, Mask >, lsst::gauss2d::fit::EllipticalComponent, lsst::gauss2d::fit::FractionalIntegralModel, lsst::gauss2d::fit::GaussianComponent, lsst::gauss2d::fit::GaussianModelIntegral, lsst::gauss2d::fit::GaussianParametricEllipse, lsst::gauss2d::fit::GaussianPrior, lsst::gauss2d::fit::IntegralSize, lsst::gauss2d::fit::LinearIntegralModel, lsst::gauss2d::fit::LinearSersicMixInterpolator, lsst::gauss2d::fit::Model< T, Image, Indices, Mask >, lsst::gauss2d::fit::Observation< T, I, M >, lsst::gauss2d::fit::ParametricGaussian1D, lsst::gauss2d::fit::PriorEvaluation, lsst::gauss2d::fit::PsfModel, lsst::gauss2d::fit::SersicEllipseData, lsst::gauss2d::fit::SersicMixComponent, lsst::gauss2d::fit::SersicMixValues, lsst::gauss2d::fit::SersicModelIntegral, lsst::gauss2d::fit::SersicParametricEllipse, lsst::gauss2d::fit::ShapePrior, lsst::gauss2d::fit::ShapePriorOptions, lsst::gauss2d::fit::Source, lsst::gauss2d::Gaussian, lsst::gauss2d::GaussianEvaluator< T, Data, Indices >, lsst::gauss2d::GaussianEvaluator< T, Image, Indices >, lsst::gauss2d::GaussianEvaluator< T, Image, Indices >, lsst::gauss2d::GaussianIntegral, lsst::gauss2d::GaussianIntegralValue, lsst::gauss2d::Gaussians, lsst::gauss2d::Image< T, C >, lsst::gauss2d::Image< bool, M >, lsst::gauss2d::Image< bool, M >, lsst::gauss2d::Image< idx_type, Indices >, lsst::gauss2d::Image< idx_type, Indices >, lsst::gauss2d::Image< T, Data >, lsst::gauss2d::Image< T, Data >, lsst::gauss2d::Image< t, Data >, lsst::gauss2d::Image< T, I >, lsst::gauss2d::Image< T, I >, lsst::gauss2d::Image< T, Image< T > >, lsst::gauss2d::Image< T, VectorImage< T > >, lsst::gauss2d::ImageArray< T, C >, lsst::gauss2d::ImageArray< double, Image >, lsst::gauss2d::ImageArray< double, Image >, lsst::gauss2d::ImageArray< T, Data >, lsst::gauss2d::ImageArray< T, Data >, and lsst::gauss2d::ImageArray< t, Data >.

◆ set_rho()

virtual void lsst::gauss2d::fit::ParametricEllipse::set_rho ( double rho)
pure virtual

◆ set_size_x()

virtual void lsst::gauss2d::fit::ParametricEllipse::set_size_x ( double size_x)
pure virtual

◆ set_size_y()

virtual void lsst::gauss2d::fit::ParametricEllipse::set_size_y ( double size_y)
pure virtual

◆ set_xyr()

virtual void lsst::gauss2d::fit::ParametricEllipse::set_xyr ( const std::array< double, 3 > & xyr)
inlinevirtual

Reimplemented in lsst::gauss2d::fit::GaussianParametricEllipse.

Definition at line 51 of file parametricellipse.h.

51 {
52 set_size_x(xyr[0]);
53 set_size_y(xyr[1]);
54 set_rho(xyr[2]);
55 };
virtual void set_size_y(double size_y)=0
virtual void set_rho(double rho)=0
virtual void set_size_x(double size_x)=0

◆ str()

virtual std::string lsst::gauss2d::Object::str ( ) const
pure virtualinherited

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

Implemented in lsst::gauss2d::Centroid, lsst::gauss2d::CentroidData, lsst::gauss2d::CentroidValues, lsst::gauss2d::ConvolvedGaussian, lsst::gauss2d::ConvolvedGaussians, lsst::gauss2d::CoordinateSystem, lsst::gauss2d::Covariance, lsst::gauss2d::detail::GradientsExtra< t, Data, Indices >, lsst::gauss2d::Ellipse, lsst::gauss2d::EllipseData, lsst::gauss2d::EllipseMajor, lsst::gauss2d::EllipseValues, lsst::gauss2d::fit::CentroidParameters, lsst::gauss2d::fit::Channel, lsst::gauss2d::fit::Data< T, I, M >, lsst::gauss2d::fit::Data< T, Image, Mask >, lsst::gauss2d::fit::Data< T, Image, Mask >, lsst::gauss2d::fit::EllipticalComponent, lsst::gauss2d::fit::FractionalIntegralModel, lsst::gauss2d::fit::GaussianComponent, lsst::gauss2d::fit::GaussianModelIntegral, lsst::gauss2d::fit::GaussianParametricEllipse, lsst::gauss2d::fit::GaussianPrior, lsst::gauss2d::fit::IntegralSize, lsst::gauss2d::fit::LinearIntegralModel, lsst::gauss2d::fit::LinearSersicMixInterpolator, lsst::gauss2d::fit::Model< T, Image, Indices, Mask >, lsst::gauss2d::fit::Observation< T, I, M >, lsst::gauss2d::fit::ParametricGaussian1D, lsst::gauss2d::fit::PriorEvaluation, lsst::gauss2d::fit::PsfModel, lsst::gauss2d::fit::SersicEllipseData, lsst::gauss2d::fit::SersicMixComponent, lsst::gauss2d::fit::SersicMixValues, lsst::gauss2d::fit::SersicModelIntegral, lsst::gauss2d::fit::SersicParametricEllipse, lsst::gauss2d::fit::ShapePrior, lsst::gauss2d::fit::ShapePriorOptions, lsst::gauss2d::fit::Source, lsst::gauss2d::Gaussian, lsst::gauss2d::GaussianEvaluator< T, Data, Indices >, lsst::gauss2d::GaussianEvaluator< T, Image, Indices >, lsst::gauss2d::GaussianEvaluator< T, Image, Indices >, lsst::gauss2d::GaussianIntegral, lsst::gauss2d::GaussianIntegralValue, lsst::gauss2d::Gaussians, lsst::gauss2d::Image< T, C >, lsst::gauss2d::Image< bool, M >, lsst::gauss2d::Image< bool, M >, lsst::gauss2d::Image< idx_type, Indices >, lsst::gauss2d::Image< idx_type, Indices >, lsst::gauss2d::Image< T, Data >, lsst::gauss2d::Image< T, Data >, lsst::gauss2d::Image< t, Data >, lsst::gauss2d::Image< T, I >, lsst::gauss2d::Image< T, I >, lsst::gauss2d::Image< T, Image< T > >, lsst::gauss2d::Image< T, VectorImage< T > >, lsst::gauss2d::ImageArray< T, C >, lsst::gauss2d::ImageArray< double, Image >, lsst::gauss2d::ImageArray< double, Image >, lsst::gauss2d::ImageArray< T, Data >, lsst::gauss2d::ImageArray< T, Data >, and lsst::gauss2d::ImageArray< t, Data >.

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: