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::ParametricGaussian1D Class Reference

#include <parametricgaussian1d.h>

Inheritance diagram for lsst::gauss2d::fit::ParametricGaussian1D:
lsst::gauss2d::Object

Public Member Functions

 ParametricGaussian1D (std::shared_ptr< MeanParameterD > mean=nullptr, std::shared_ptr< StdDevParameterD > stddev=nullptr)
 
 ~ParametricGaussian1D ()
 
double get_mean () const
 
double get_stddev () const
 
MeanParameterDget_mean_parameter () const
 
StdDevParameterDget_stddev_parameter () const
 
void set_mean (double value)
 
void set_stddev (double value)
 
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.
 

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

Definition at line 14 of file parametricgaussian1d.h.

Constructor & Destructor Documentation

◆ ParametricGaussian1D()

lsst::gauss2d::fit::ParametricGaussian1D::ParametricGaussian1D ( std::shared_ptr< MeanParameterD > mean = nullptr,
std::shared_ptr< StdDevParameterD > stddev = nullptr )
explicit

Definition at line 8 of file parametricgaussian1d.cc.

10 : _mean(std::move(mean)), _stddev(std::move(stddev)) {
11 if (_mean == nullptr) _mean = std::make_shared<MeanParameterD>();
12 if (_stddev == nullptr) _stddev = std::make_shared<StdDevParameterD>();
13}
T make_shared(T... args)
T move(T... args)

◆ ~ParametricGaussian1D()

lsst::gauss2d::fit::ParametricGaussian1D::~ParametricGaussian1D ( )

Definition at line 15 of file parametricgaussian1d.cc.

15{}

Member Function Documentation

◆ get_mean()

double lsst::gauss2d::fit::ParametricGaussian1D::get_mean ( ) const

Definition at line 17 of file parametricgaussian1d.cc.

17{ return this->_mean->get_value(); }

◆ get_mean_parameter()

MeanParameterD & lsst::gauss2d::fit::ParametricGaussian1D::get_mean_parameter ( ) const

Definition at line 21 of file parametricgaussian1d.cc.

21{ return *this->_mean; }

◆ get_stddev()

double lsst::gauss2d::fit::ParametricGaussian1D::get_stddev ( ) const

Definition at line 19 of file parametricgaussian1d.cc.

19{ return this->_stddev->get_value(); }

◆ get_stddev_parameter()

StdDevParameterD & lsst::gauss2d::fit::ParametricGaussian1D::get_stddev_parameter ( ) const

Definition at line 23 of file parametricgaussian1d.cc.

23{ return *this->_stddev; }

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

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

Definition at line 29 of file parametricgaussian1d.cc.

29 {
30 return type_name_str<ParametricGaussian1D>(false, namespace_separator) + "("
31 + (name_keywords ? "mean=" : "") + _mean->repr(name_keywords, namespace_separator)
32 + (name_keywords ? ", stddev=" : "") + _stddev->repr(name_keywords, namespace_separator) + ")";
33}
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_mean()

void lsst::gauss2d::fit::ParametricGaussian1D::set_mean ( double value)

Definition at line 25 of file parametricgaussian1d.cc.

25{ this->_mean->set_value(value); }

◆ set_stddev()

void lsst::gauss2d::fit::ParametricGaussian1D::set_stddev ( double value)

Definition at line 27 of file parametricgaussian1d.cc.

27{ this->_stddev->set_value(value); }

◆ str()

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

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

Implements lsst::gauss2d::Object.

Definition at line 35 of file parametricgaussian1d.cc.

35 {
36 return type_name_str<ParametricGaussian1D>(true) + "(mean=" + _mean->str() + ", stddev=" + _stddev->str()
37 + ")";
38}

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: