lsst::gauss2d::fit::ParametricGaussian1D Class Reference

#include <parametricgaussian1d.h>

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

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
MeanParameterD &	get_mean_parameter () const
StdDevParameterD &	get_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.

        : _mean(std::move(mean)), _stddev(std::move(stddev)) {
    if (_mean == nullptr) _mean = std::make_shared<MeanParameterD>();
    if (_stddev == nullptr) _stddev = std::make_shared<StdDevParameterD>();
}

~ParametricGaussian1D()

lsst::gauss2d::fit::ParametricGaussian1D::~ParametricGaussian1D

(

)

Definition at line 15 of file parametricgaussian1d.cc.

{}

Member Function Documentation

get_mean()

double lsst::gauss2d::fit::ParametricGaussian1D::get_mean

(

)

const

Definition at line 17 of file parametricgaussian1d.cc.

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

{ return *this->_mean; }

get_stddev()

double lsst::gauss2d::fit::ParametricGaussian1D::get_stddev

(

)

const

Definition at line 19 of file parametricgaussian1d.cc.

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

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

                                                                              {
        return namespace_separator == CC_NAMESPACE_SEPARATOR ? "nullptr" : NULL_STR_GENERAL;
    }

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_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 29 of file parametricgaussian1d.cc.

                                                                                                 {
    return type_name_str<ParametricGaussian1D>(false, namespace_separator) + "("
           + (name_keywords ? "mean=" : "") + _mean->repr(name_keywords, namespace_separator)
           + (name_keywords ? ", stddev=" : "") + _stddev->repr(name_keywords, namespace_separator) + ")";
}

set_mean()

void lsst::gauss2d::fit::ParametricGaussian1D::set_mean

(

double

value

)

Definition at line 25 of file parametricgaussian1d.cc.

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

set_stddev()

void lsst::gauss2d::fit::ParametricGaussian1D::set_stddev

(

double

value

)

Definition at line 27 of file parametricgaussian1d.cc.

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

                                          {
    return type_name_str<ParametricGaussian1D>(true) + "(mean=" + _mean->str() + ", stddev=" + _stddev->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-10.1.0/Linux/gauss2d_fit/g199a45376c+0ba108daf9/include/lsst/gauss2d/fit/parametricgaussian1d.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-10.1.0/Linux/gauss2d_fit/g199a45376c+0ba108daf9/src/parametricgaussian1d.cc