lsst::gauss2d::fit::SersicParametricEllipse Class Reference

A ParametericEllipse with effective radius Parameters. More...

#include <sersicparametricellipse.h>

Inheritance diagram for lsst::gauss2d::fit::SersicParametricEllipse:

Public Member Functions
	SersicParametricEllipse (std::shared_ptr< ReffXParameterD > size_x, std::shared_ptr< ReffYParameterD > size_y, std::shared_ptr< RhoParameterD > rho=nullptr)
	Construct a SersicParametricEllipse with existing Parameter instances.
	SersicParametricEllipse (double size_x=0, double size_y=0, double rho=0)
ParamRefs &	get_parameters (ParamRefs &params, ParamFilter *filter=nullptr) const override
	Add Parameter refs matching the filter to a vector, in order.
ParamCRefs &	get_parameters_const (ParamCRefs &params, ParamFilter *filter=nullptr) const override
	Same as get_parameters(), but for const refs.
double	get_rho () const override
	Get the rho value.
double	get_size_x () const override
	Get the size_x value.
double	get_size_y () const override
	Get the size_y value.
std::array< double, 3 >	get_xyr () const override
	Get the array of size_x, size_y, rho.
RhoParameterD &	get_rho_param () const override
SizeXParameterD &	get_size_x_param () const override
SizeYParameterD &	get_size_y_param () const override
std::shared_ptr< ReffXParameterD >	get_reff_x_param_ptr ()
std::shared_ptr< ReffYParameterD >	get_reff_y_param_ptr ()
std::shared_ptr< RhoParameterD >	get_rho_param_ptr () override
std::shared_ptr< SizeXParameterD >	get_size_x_param_ptr () override
std::shared_ptr< SizeYParameterD >	get_size_y_param_ptr () override
void	set_rho (double rho) override
void	set_size_x (double size_x) override
void	set_size_y (double size_y) 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.
virtual void	set_xyr (const std::array< double, 3 > &xyr)
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 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 ParametericEllipse with effective radius Parameters.

Definition at line 15 of file sersicparametricellipse.h.

Constructor & Destructor Documentation

SersicParametricEllipse() [1/2]

lsst::gauss2d::fit::SersicParametricEllipse::SersicParametricEllipse ( std::shared_ptr< ReffXParameterD > size_x, std::shared_ptr< ReffYParameterD > size_y, std::shared_ptr< RhoParameterD > rho = nullptr )

explicit

Construct a SersicParametricEllipse with existing Parameter instances.

Parameters

size_x	The x-axis effective radius parameter.
size_y	The y-axis effective radius parameter.
rho	The correlation (rho) parameter.

Definition at line 14 of file sersicparametricellipse.cc.

        : _size_x(size_x == nullptr ? std::make_shared<ReffXParameterD>(0) : std::move(size_x)),
          _size_y(size_y == nullptr ? std::make_shared<ReffYParameterD>(0) : std::move(size_y)),
          _rho(rho == nullptr ? std::make_shared<RhoParameterD>(0) : std::move(rho)) {};

SersicParametricEllipse() [2/2]

lsst::gauss2d::fit::SersicParametricEllipse::SersicParametricEllipse ( double size_x = 0, double size_y = 0, double rho = 0 )

explicit

Definition at line 21 of file sersicparametricellipse.cc.

        : _size_x(std::make_shared<ReffXParameterD>(size_x)),
          _size_y(std::make_shared<ReffYParameterD>(size_y)),
          _rho(std::make_shared<RhoParameterD>(rho)) {};

Member Function Documentation

get_parameters()

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

overridevirtual

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

Parameters

params	The vector to add to.
filter	The 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 sersicparametricellipse.cc.

                                                                                               {
    return _get_parameters<ParamRefs>(params, filter, *_size_x, *_size_y, *_rho);
}

get_parameters_const()

ParamCRefs & lsst::gauss2d::fit::SersicParametricEllipse::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 29 of file sersicparametricellipse.cc.

                                                                                                       {
    return _get_parameters<ParamCRefs>(params, filter, *_size_x, *_size_y, *_rho);
}

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.

                                                                             {
        ParamCRefs params{};
        get_parameters_const(params, filter);
        return params;
    }

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.

                                                                      {
        ParamRefs params{};
        get_parameters(params, filter);
        return params;
    }

get_reff_x_param_ptr()

std::shared_ptr< ReffXParameterD > lsst::gauss2d::fit::SersicParametricEllipse::get_reff_x_param_ptr

(

)

Definition at line 44 of file sersicparametricellipse.cc.

{ return _size_x; };

get_reff_y_param_ptr()

std::shared_ptr< ReffYParameterD > lsst::gauss2d::fit::SersicParametricEllipse::get_reff_y_param_ptr

(

)

Definition at line 45 of file sersicparametricellipse.cc.

{ return _size_y; };

get_rho()

double lsst::gauss2d::fit::SersicParametricEllipse::get_rho ( ) const

overridevirtual

Get the rho value.

Implements lsst::gauss2d::fit::QuasiEllipse.

Definition at line 33 of file sersicparametricellipse.cc.

{ return _rho->get_value(); }

get_rho_param()

RhoParameterD & lsst::gauss2d::fit::SersicParametricEllipse::get_rho_param ( ) const

overridevirtual

Implements lsst::gauss2d::fit::ParametricEllipse.

Definition at line 40 of file sersicparametricellipse.cc.

{ return *_rho; }

get_rho_param_ptr()

std::shared_ptr< RhoParameterD > lsst::gauss2d::fit::SersicParametricEllipse::get_rho_param_ptr ( )

overridevirtual

Implements lsst::gauss2d::fit::ParametricEllipse.

Definition at line 46 of file sersicparametricellipse.cc.

{ return _rho; }

get_size_x()

double lsst::gauss2d::fit::SersicParametricEllipse::get_size_x ( ) const

overridevirtual

Get the size_x value.

Implements lsst::gauss2d::fit::QuasiEllipse.

Definition at line 34 of file sersicparametricellipse.cc.

{ return _size_x->get_value(); }

get_size_x_param()

SizeXParameterD & lsst::gauss2d::fit::SersicParametricEllipse::get_size_x_param ( ) const

overridevirtual

Implements lsst::gauss2d::fit::ParametricEllipse.

Definition at line 41 of file sersicparametricellipse.cc.

{ return *_size_x; };

get_size_x_param_ptr()

std::shared_ptr< SizeXParameterD > lsst::gauss2d::fit::SersicParametricEllipse::get_size_x_param_ptr ( )

overridevirtual

Implements lsst::gauss2d::fit::ParametricEllipse.

Definition at line 47 of file sersicparametricellipse.cc.

{ return _size_x; };

get_size_y()

double lsst::gauss2d::fit::SersicParametricEllipse::get_size_y ( ) const

overridevirtual

Get the size_y value.

Implements lsst::gauss2d::fit::QuasiEllipse.

Definition at line 35 of file sersicparametricellipse.cc.

{ return _size_y->get_value(); }

get_size_y_param()

SizeYParameterD & lsst::gauss2d::fit::SersicParametricEllipse::get_size_y_param ( ) const

overridevirtual

Implements lsst::gauss2d::fit::ParametricEllipse.

Definition at line 42 of file sersicparametricellipse.cc.

{ return *_size_y; };

get_size_y_param_ptr()

std::shared_ptr< SizeYParameterD > lsst::gauss2d::fit::SersicParametricEllipse::get_size_y_param_ptr ( )

overridevirtual

Implements lsst::gauss2d::fit::ParametricEllipse.

Definition at line 48 of file sersicparametricellipse.cc.

{ return _size_y; };

get_xyr()

std::array< double, 3 > lsst::gauss2d::fit::SersicParametricEllipse::get_xyr ( ) const

overridevirtual

Get the array of size_x, size_y, rho.

Reimplemented from lsst::gauss2d::fit::QuasiEllipse.

Definition at line 36 of file sersicparametricellipse.cc.

                                                           {
    return {this->get_size_x(), this->get_size_y(), this->get_rho()};
}

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;
    }

repr()

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

Definition at line 54 of file sersicparametricellipse.cc.

                                                                                                    {
    return std::string("SersicParametricEllipse(") + (name_keywords ? "size_x=" : "")
           + _size_x->repr(name_keywords, namespace_separator) + ", " + (name_keywords ? "size_y=" : "")
           + _size_y->repr(name_keywords, namespace_separator) + ", " + (name_keywords ? "rho=" : "")
           + _rho->repr(name_keywords, namespace_separator) + ")";
}

set_rho()

void lsst::gauss2d::fit::SersicParametricEllipse::set_rho ( double rho )

inlineoverridevirtual

Implements lsst::gauss2d::fit::ParametricEllipse.

Definition at line 50 of file sersicparametricellipse.cc.

{ _rho->set_value(rho); }

set_size_x()

void lsst::gauss2d::fit::SersicParametricEllipse::set_size_x ( double size_x )

inlineoverridevirtual

Implements lsst::gauss2d::fit::ParametricEllipse.

Definition at line 51 of file sersicparametricellipse.cc.

{ _size_x->set_value(size_x); }

set_size_y()

void lsst::gauss2d::fit::SersicParametricEllipse::set_size_y ( double size_y )

inlineoverridevirtual

Implements lsst::gauss2d::fit::ParametricEllipse.

Definition at line 52 of file sersicparametricellipse.cc.

{ _size_y->set_value(size_y); }

set_xyr()

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

inlinevirtualinherited

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

Definition at line 51 of file parametricellipse.h.

                                                         {
        set_size_x(xyr[0]);
        set_size_y(xyr[1]);
        set_rho(xyr[2]);
    };

str()

std::string lsst::gauss2d::fit::SersicParametricEllipse::str ( ) const

overridevirtual

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

Implements lsst::gauss2d::Object.

Definition at line 61 of file sersicparametricellipse.cc.

                                             {
    return "SersicParametricEllipse(size_x=" + _size_x->str() + ", size_y=" + _size_y->str()
           + ", rho=" + _rho->str() + ")";
}

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-11.0.0/Linux/gauss2d_fit/g199a45376c+0ba108daf9/include/lsst/gauss2d/fit/sersicparametricellipse.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-11.0.0/Linux/gauss2d_fit/g199a45376c+0ba108daf9/src/sersicparametricellipse.cc