LSST Applications g04e9c324dd+8c5ae1fdc5,g134cb467dc+1b3060144d,g18429d2f64+f642bf4753,g199a45376c+0ba108daf9,g1fd858c14a+2dcf163641,g262e1987ae+7b8c96d2ca,g29ae962dfc+3bd6ecb08a,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53e1a9e7c5,g4595892280+fef73a337f,g47891489e3+2efcf17695,g4d44eb3520+642b70b07e,g53246c7159+8c5ae1fdc5,g67b6fd64d1+2efcf17695,g67fd3c3899+b70e05ef52,g74acd417e5+317eb4c7d4,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+2efcf17695,g8d7436a09f+3be3c13596,g8ea07a8fe4+9f5ccc88ac,g90f42f885a+a4e7b16d9b,g97be763408+ad77d7208f,g9dd6db0277+b70e05ef52,ga681d05dcb+a3f46e7fff,gabf8522325+735880ea63,gac2eed3f23+2efcf17695,gb89ab40317+2efcf17695,gbf99507273+8c5ae1fdc5,gd8ff7fe66e+b70e05ef52,gdab6d2f7ff+317eb4c7d4,gdc713202bf+b70e05ef52,gdfd2d52018+b10e285e0f,ge365c994fd+310e8507c4,ge410e46f29+2efcf17695,geaed405ab2+562b3308c0,gffca2db377+8c5ae1fdc5,w.2025.35
LSST Data Management Base Package
|
A parameter with values and metadata. More...
#include <parameter.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. | |
Parameter (T value=_get_default(), std::shared_ptr< const Limits< T > > limits=nullptr, const std::shared_ptr< const Transform< T > > transform=nullptr, std::shared_ptr< const Unit > unit=nullptr, bool fixed=false, std::string label="") | |
Initialize a Parameter. | |
~Parameter () | |
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 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. | |
A parameter with values and metadata.
This is a CRTP implementation of the ParameterBase interface, which allows for concise, minimal-effort derived classes (see tests and examples).
T | The type of the value. Only floating point values are tested. |
C | The derived class. |
Definition at line 150 of file parameter.h.
|
inline |
Initialize a Parameter.
value | The initial untransformed value. |
limits | The untransformed value limits. |
transform | The transformation to apply to values. |
unit | The unit of the untransformed value. |
fixed | Whether the parameter is fixed in models. |
label | A descriptive label for the parameter. |
Definition at line 343 of file parameter.h.
|
inline |
Definition at line 354 of file parameter.h.
|
inlinestaticconstexpr |
|
inlinestaticprotected |
Definition at line 204 of file parameter.h.
|
inlinestaticconstexprprotected |
Definition at line 205 of file parameter.h.
|
inlinestaticconstexprprotected |
Definition at line 207 of file parameter.h.
|
inlinestaticconstexprprotected |
Definition at line 206 of file parameter.h.
|
inlinestaticprotected |
Definition at line 208 of file parameter.h.
|
inlineoverridevirtual |
Get the default value.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 216 of file parameter.h.
|
inlineoverridevirtual |
Get a string description for this parameter class.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 214 of file parameter.h.
|
inlineoverridevirtual |
Return whether the parameter is fixed (not free).
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 218 of file parameter.h.
|
inlineoverridevirtual |
Return whether the parameter is free (not fixed).
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 220 of file parameter.h.
|
inlineoverridevirtual |
Return a string label for this parameter instance.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 222 of file parameter.h.
|
inlineoverridevirtual |
Return the limits for the untransformed value.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 230 of file parameter.h.
|
inlineoverridevirtual |
Return limits representing the maximum/minimum untransformed value.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 224 of file parameter.h.
|
inlineoverridevirtual |
Return whether the parameter is linear.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 232 of file parameter.h.
|
inlineoverridevirtual |
Return the maximum value for this parameter instance.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 236 of file parameter.h.
|
inlineoverridevirtual |
Return the minimum value for this parameter instance.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 234 of file parameter.h.
|
inlineoverridevirtual |
Get a string name for this parameter class.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 238 of file parameter.h.
|
inlineoverridevirtual |
Return the transforming function for this parameter instance.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 240 of file parameter.h.
|
inlineoverridevirtual |
Return the derivative of the transform for this parameter instance.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 244 of file parameter.h.
|
inlineoverridevirtual |
Return the transform pointer for this parameter instance.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 242 of file parameter.h.
|
inlinestatic |
Get the name of the derived type of this.
Definition at line 248 of file parameter.h.
|
inlineoverridevirtual |
Return the unit of this parameter instance.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 254 of file parameter.h.
|
inlineoverridevirtual |
Return the untransformed value of this parameter instance.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 256 of file parameter.h.
|
inlineoverridevirtual |
Return the transformed value of this parameter instance.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 258 of file parameter.h.
|
inline |
|
inlineoverridevirtual |
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.
|
inlineoverridevirtual |
Set the parameter to be fixed (or not).
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 263 of file parameter.h.
|
inlineoverridevirtual |
Set the parameter to be free (or not).
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 264 of file parameter.h.
|
inlineoverridevirtual |
Set the string label for this parameter instance.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 265 of file parameter.h.
|
inlineoverridevirtual |
Set the limits for this parameter instance.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 266 of file parameter.h.
|
inlineoverridevirtual |
Set the transforming function for this parameter instance.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 283 of file parameter.h.
|
inlineoverridevirtual |
Set the unit for this parameter instance.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 308 of file parameter.h.
|
inlineoverridevirtual |
Set the untransformed value for this parameter instance.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 297 of file parameter.h.
|
inlineoverridevirtual |
Set the transformed value for this parameter instance.
Implements lsst::modelfit::parameters::ParameterBase< T >.
Definition at line 303 of file parameter.h.
|
inlineoverridevirtual |
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.
|
protected |
The untransformed value.
Definition at line 200 of file parameter.h.
|
protected |
The cached, transformed value.
Definition at line 202 of file parameter.h.
|
staticconstexprinherited |