LSST Applications g0d97872fb5+4fd969bb9d,g1653933729+34a971ddd9,g28da252d5a+072f89fe25,g2bbee38e9b+a99b0ab4cd,g2bc492864f+a99b0ab4cd,g2ca4be77d2+c0e3b27cd8,g2cdde0e794+704103fe75,g3156d2b45e+6e87dc994a,g347aa1857d+a99b0ab4cd,g35bb328faa+34a971ddd9,g3a166c0a6a+a99b0ab4cd,g3e281a1b8c+8ec26ec694,g4005a62e65+ba0306790b,g414038480c+9ed5ed841a,g569e0e2b34+cb4faa46ad,g5a97de2502+520531a62c,g717e5f8c0f+29153700a5,g7ede599f99+367733290c,g80478fca09+17051a22cc,g82479be7b0+f2f1ea0a87,g858d7b2824+29153700a5,g8b782ad322+29153700a5,g8cd86fa7b1+05420e7f7d,g9125e01d80+34a971ddd9,ga5288a1d22+e7f674aaf3,gae0086650b+34a971ddd9,gae74b0b5c6+45ef5cdc51,gb58c049af0+ace264a4f2,gc28159a63d+a99b0ab4cd,gcf0d15dbbd+8051a81198,gda6a2b7d83+8051a81198,gdaeeff99f8+7774323b41,gdf4d240d4a+34a971ddd9,ge2409df99d+cb167bac99,ge33fd446bb+29153700a5,ge79ae78c31+a99b0ab4cd,gf0baf85859+890af219f9,gf5289d68f6+9faa5c5784,w.2024.36
LSST Data Management Base Package
|
#include <parameters.h>
Public Member Functions | |
std::string | get_desc () const override |
Get a string description for this parameter class. | |
T | get_default () const override |
Get the default value. | |
bool | get_fixed () const override |
Return whether the parameter is fixed (not free). | |
bool | get_free () const override |
Return whether the parameter is free (not fixed). | |
std::string | get_label () const override |
Return a string label for this parameter instance. | |
const Limits< T > & | get_limits_maximal () const override |
Return limits representing the maximum/minimum untransformed value. | |
const Limits< T > & | get_limits () const override |
Return the limits for the untransformed value. | |
bool | get_linear () const override |
Return whether the parameter is linear. | |
T | get_min () const override |
Return the minimum value for this parameter instance. | |
T | get_max () const override |
Return the maximum value for this parameter instance. | |
std::string | get_name () const override |
Get a string name for this parameter class. | |
const Transform< T > & | get_transform () const override |
Return the transforming function for this parameter instance. | |
std::shared_ptr< const Transform< T > > | get_transform_ptr () const override |
Return the transform pointer for this parameter instance. | |
T | get_transform_derivative () const override |
Return the derivative of the transform for this parameter instance. | |
const Unit & | get_unit () const override |
Return the unit of this parameter instance. | |
T | get_value () const override |
Return the untransformed value of this parameter instance. | |
T | get_value_transformed () const override |
Return the transformed value of this parameter instance. | |
std::shared_ptr< C > | ptr () |
Return a shared pointer to this. | |
void | set_fixed (bool fixed) override |
Set the parameter to be fixed (or not). | |
void | set_free (bool free) override |
Set the parameter to be free (or not). | |
void | set_label (std::string label) override |
Set the string label for this parameter instance. | |
void | set_limits (std::shared_ptr< const Limits< T > > limits) override |
Set the limits for this parameter instance. | |
void | set_transform (const std::shared_ptr< const Transform< T > > transform) override |
Set the transforming function for this parameter instance. | |
void | set_value (T value) override |
Set the untransformed value for this parameter instance. | |
void | set_value_transformed (T value_transformed) override |
Set the transformed value for this parameter instance. | |
void | set_unit (std::shared_ptr< const Unit > unit=nullptr) override |
Set the unit for this parameter instance. | |
std::string | repr (bool name_keywords=false, const 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. | |
T | shared_from_this (T... args) |
Static Public Member Functions | |
static constexpr T | _get_default () |
Get the default value for the derived type of this. | |
static const std::string | get_type_name (bool strip_namespace_separator=false, const std::string_view &namespace_separator=detail::NAMESPACE_SEPARATOR) |
Get the name of the derived type of this. | |
static const UnitTransform< T > & | transform_none () |
Static Public Attributes | |
static const std::string | _desc = "Gaussian (1D normal) mean" |
static const std::string | _name = "mean" |
static constexpr std::string_view | CC_NAMESPACE_SEPARATOR = "::" |
The C++ namespace separator. | |
Static Protected Member Functions | |
static const std::string | _get_desc () |
static constexpr bool | _get_linear () |
static constexpr T | _get_min () |
static constexpr T | _get_max () |
static const std::string | _get_name () |
Protected Attributes | |
T | _value |
The untransformed value. | |
T | _value_transformed |
The cached, transformed value. | |
Definition at line 67 of file parameters.h.
|
inlinestaticconstexprinherited |
Get the default value for the derived type of this.
Definition at line 212 of file parameter.h.
|
inlinestaticprotectedinherited |
Definition at line 204 of file parameter.h.
|
inlinestaticconstexprprotectedinherited |
Definition at line 205 of file parameter.h.
|
inlinestaticconstexprprotectedinherited |
Definition at line 207 of file parameter.h.
|
inlinestaticconstexprprotectedinherited |
Definition at line 206 of file parameter.h.
|
inlinestaticprotectedinherited |
Definition at line 208 of file parameter.h.
|
inlineoverridevirtualinherited |
Get the default value.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 216 of file parameter.h.
|
inlineoverridevirtualinherited |
Get a string description for this parameter class.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 214 of file parameter.h.
|
inlineoverridevirtualinherited |
Return whether the parameter is fixed (not free).
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 218 of file parameter.h.
|
inlineoverridevirtualinherited |
Return whether the parameter is free (not fixed).
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 220 of file parameter.h.
|
inlineoverridevirtualinherited |
Return a string label for this parameter instance.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 222 of file parameter.h.
|
inlineoverridevirtualinherited |
Return the limits for the untransformed value.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 230 of file parameter.h.
|
inlineoverridevirtualinherited |
Return limits representing the maximum/minimum untransformed value.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 224 of file parameter.h.
|
inlineoverridevirtualinherited |
Return whether the parameter is linear.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 232 of file parameter.h.
|
inlineoverridevirtualinherited |
Return the maximum value for this parameter instance.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 236 of file parameter.h.
|
inlineoverridevirtualinherited |
Return the minimum value for this parameter instance.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 234 of file parameter.h.
|
inlineoverridevirtualinherited |
Get a string name for this parameter class.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 238 of file parameter.h.
|
inlineoverridevirtualinherited |
Return the transforming function for this parameter instance.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 240 of file parameter.h.
|
inlineoverridevirtualinherited |
Return the derivative of the transform for this parameter instance.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 244 of file parameter.h.
|
inlineoverridevirtualinherited |
Return the transform pointer for this parameter instance.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 242 of file parameter.h.
|
inlinestaticinherited |
Get the name of the derived type of this.
Definition at line 248 of file parameter.h.
|
inlineoverridevirtualinherited |
Return the unit of this parameter instance.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 254 of file parameter.h.
|
inlineoverridevirtualinherited |
Return the untransformed value of this parameter instance.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 256 of file parameter.h.
|
inlineoverridevirtualinherited |
Return the transformed value of this parameter instance.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 258 of file parameter.h.
|
inlineinherited |
|
inlineoverridevirtualinherited |
Return a full, callable string representation of this.
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. |
Implements lsst::modelfit::parameters::Object.
Definition at line 312 of file parameter.h.
|
inlineoverridevirtualinherited |
Set the parameter to be fixed (or not).
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 263 of file parameter.h.
|
inlineoverridevirtualinherited |
Set the parameter to be free (or not).
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 264 of file parameter.h.
|
inlineoverridevirtualinherited |
Set the string label for this parameter instance.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 265 of file parameter.h.
|
inlineoverridevirtualinherited |
Set the limits for this parameter instance.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 266 of file parameter.h.
|
inlineoverridevirtualinherited |
Set the transforming function for this parameter instance.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 283 of file parameter.h.
|
inlineoverridevirtualinherited |
Set the unit for this parameter instance.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 308 of file parameter.h.
|
inlineoverridevirtualinherited |
Set the untransformed value for this parameter instance.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 297 of file parameter.h.
|
inlineoverridevirtualinherited |
Set the transformed value for this parameter instance.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 303 of file parameter.h.
|
inlineoverridevirtualinherited |
Return a brief, human-readable string representation of this.
Implements lsst::modelfit::parameters::Object.
Definition at line 321 of file parameter.h.
|
inlinestaticinherited |
Definition at line 111 of file parameter.h.
|
inlinestatic |
Definition at line 68 of file parameters.h.
|
inlinestatic |
Definition at line 69 of file parameters.h.
|
protectedinherited |
The untransformed value.
Definition at line 200 of file parameter.h.
|
protectedinherited |
The cached, transformed value.
Definition at line 202 of file parameter.h.
|
staticconstexprinherited |