LSST Applications g042eb84c57+730a74494b,g04e9c324dd+8c5ae1fdc5,g134cb467dc+1f1e3e7524,g199a45376c+0ba108daf9,g1fd858c14a+fa7d31856b,g210f2d0738+f66ac109ec,g262e1987ae+83a3acc0e5,g29ae962dfc+d856a2cb1f,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+a1e0c9f713,g47891489e3+0d594cb711,g4d44eb3520+c57ec8f3ed,g4d7b6aa1c5+f66ac109ec,g53246c7159+8c5ae1fdc5,g56a1a4eaf3+fd7ad03fde,g64539dfbff+f66ac109ec,g67b6fd64d1+0d594cb711,g67fd3c3899+f66ac109ec,g6985122a63+0d594cb711,g74acd417e5+3098891321,g786e29fd12+668abc6043,g81db2e9a8d+98e2ab9f28,g87389fa792+8856018cbb,g89139ef638+0d594cb711,g8d7436a09f+80fda9ce03,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+a8a29bda4b,g99822b682c+e3ec3c61f9,g9d5c6a246b+0d5dac0c3d,ga41d0fce20+9243b26dd2,gbf99507273+8c5ae1fdc5,gd7ef33dd92+0d594cb711,gdab6d2f7ff+3098891321,ge410e46f29+0d594cb711,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.38
LSST Data Management Base Package
|
Interface for parameters with values and metadata. More...
#include <parameter.h>
Public Member Functions | |
virtual T | get_default () const =0 |
Get the default value. | |
virtual std::string | get_desc () const =0 |
Get a string description for this parameter class. | |
virtual bool | get_fixed () const =0 |
Return whether the parameter is fixed (not free). | |
virtual bool | get_free () const =0 |
Return whether the parameter is free (not fixed). | |
virtual std::string | get_label () const =0 |
Return a string label for this parameter instance. | |
virtual const Limits< T > & | get_limits () const =0 |
Return the limits for the untransformed value. | |
virtual const Limits< T > & | get_limits_maximal () const =0 |
Return limits representing the maximum/minimum untransformed value. | |
virtual bool | get_linear () const =0 |
Return whether the parameter is linear. | |
virtual T | get_min () const =0 |
Return the minimum value for this parameter instance. | |
virtual T | get_max () const =0 |
Return the maximum value for this parameter instance. | |
virtual std::string | get_name () const =0 |
Get a string name for this parameter class. | |
virtual const Transform< T > & | get_transform () const =0 |
Return the transforming function for this parameter instance. | |
virtual T | get_transform_derivative () const =0 |
Return the derivative of the transform for this parameter instance. | |
virtual std::shared_ptr< const Transform< T > > | get_transform_ptr () const =0 |
Return the transform pointer for this parameter instance. | |
virtual T | get_value () const =0 |
Return the untransformed value of this parameter instance. | |
virtual T | get_value_transformed () const =0 |
Return the transformed value of this parameter instance. | |
virtual const Unit & | get_unit () const =0 |
Return the unit of this parameter instance. | |
virtual void | set_fixed (bool fixed)=0 |
Set the parameter to be fixed (or not). | |
virtual void | set_free (bool free)=0 |
Set the parameter to be free (or not). | |
virtual void | set_label (std::string label)=0 |
Set the string label for this parameter instance. | |
virtual void | set_limits (std::shared_ptr< const Limits< T > > limits)=0 |
Set the limits for this parameter instance. | |
virtual void | set_transform (std::shared_ptr< const Transform< T > > transform)=0 |
Set the transforming function for this parameter instance. | |
virtual void | set_value (T value)=0 |
Set the untransformed value for this parameter instance. | |
virtual void | set_value_transformed (T value_transformed)=0 |
Set the transformed value for this parameter instance. | |
virtual void | set_unit (std::shared_ptr< const Unit > unit=nullptr)=0 |
Set the unit for this parameter instance. | |
virtual | ~ParameterBase ()=default |
virtual std::string | repr (bool name_keywords=false, const std::string_view &namespace_separator=CC_NAMESPACE_SEPARATOR) const =0 |
Return a full, callable string representation of this. | |
virtual std::string | str () const =0 |
Return a brief, human-readable string representation of this. | |
Static Public Member Functions | |
static const UnitTransform< T > & | transform_none () |
Static Public Attributes | |
static constexpr std::string_view | CC_NAMESPACE_SEPARATOR = "::" |
The C++ namespace separator. | |
Friends | |
bool | operator== (const ParameterBase< T > &first, const ParameterBase< T > &second) |
bool | operator!= (const ParameterBase< T > &first, const ParameterBase< T > &second) |
bool | operator< (const ParameterBase< T > &first, const ParameterBase< T > &second) |
Interface for parameters with values and metadata.
A parameter represents a single numeric value, with metadata like a name, description, unit, as well as optional limits and a transforming function. This class is intended for use in numerical optimization.
T | The type of the value. Only floating point values are tested. |
Definition at line 58 of file parameter.h.
|
virtualdefault |
|
pure virtual |
Get the default value.
Implemented in lsst::modelfit::parameters::Parameter< T, C >, lsst::modelfit::parameters::Parameter< double, T >, and lsst::modelfit::parameters::Parameter< double, T >.
|
pure virtual |
Get a string description for this parameter class.
Implemented in lsst::modelfit::parameters::Parameter< T, C >, lsst::modelfit::parameters::Parameter< double, T >, and lsst::modelfit::parameters::Parameter< double, T >.
|
pure virtual |
Return whether the parameter is fixed (not free).
Implemented in lsst::modelfit::parameters::Parameter< T, C >, lsst::modelfit::parameters::Parameter< double, T >, and lsst::modelfit::parameters::Parameter< double, T >.
|
pure virtual |
Return whether the parameter is free (not fixed).
Implemented in lsst::modelfit::parameters::Parameter< T, C >, lsst::modelfit::parameters::Parameter< double, T >, and lsst::modelfit::parameters::Parameter< double, T >.
|
pure virtual |
Return a string label for this parameter instance.
Implemented in lsst::modelfit::parameters::Parameter< T, C >, lsst::modelfit::parameters::Parameter< double, T >, and lsst::modelfit::parameters::Parameter< double, T >.
|
pure virtual |
Return the limits for the untransformed value.
Implemented in lsst::modelfit::parameters::Parameter< T, C >, lsst::modelfit::parameters::Parameter< double, T >, and lsst::modelfit::parameters::Parameter< double, T >.
|
pure virtual |
Return limits representing the maximum/minimum untransformed value.
Implemented in lsst::gauss2d::fit::SersicMixComponentIndexParameterD, lsst::modelfit::parameters::Parameter< T, C >, lsst::modelfit::parameters::Parameter< double, T >, and lsst::modelfit::parameters::Parameter< double, T >.
|
pure virtual |
Return whether the parameter is linear.
Implemented in lsst::modelfit::parameters::Parameter< T, C >, lsst::modelfit::parameters::Parameter< double, T >, and lsst::modelfit::parameters::Parameter< double, T >.
|
pure virtual |
Return the maximum value for this parameter instance.
Implemented in lsst::gauss2d::fit::SersicMixComponentIndexParameterD, lsst::modelfit::parameters::Parameter< T, C >, lsst::modelfit::parameters::Parameter< double, T >, and lsst::modelfit::parameters::Parameter< double, T >.
|
pure virtual |
Return the minimum value for this parameter instance.
Implemented in lsst::gauss2d::fit::SersicMixComponentIndexParameterD, lsst::modelfit::parameters::Parameter< T, C >, lsst::modelfit::parameters::Parameter< double, T >, and lsst::modelfit::parameters::Parameter< double, T >.
|
pure virtual |
Get a string name for this parameter class.
Implemented in lsst::modelfit::parameters::Parameter< T, C >, lsst::modelfit::parameters::Parameter< double, T >, and lsst::modelfit::parameters::Parameter< double, T >.
|
pure virtual |
Return the transforming function for this parameter instance.
Implemented in lsst::modelfit::parameters::Parameter< T, C >, lsst::modelfit::parameters::Parameter< double, T >, and lsst::modelfit::parameters::Parameter< double, T >.
|
pure virtual |
Return the derivative of the transform for this parameter instance.
Implemented in lsst::modelfit::parameters::Parameter< T, C >, lsst::modelfit::parameters::Parameter< double, T >, and lsst::modelfit::parameters::Parameter< double, T >.
|
pure virtual |
Return the transform pointer for this parameter instance.
Implemented in lsst::modelfit::parameters::Parameter< T, C >, lsst::modelfit::parameters::Parameter< double, T >, and lsst::modelfit::parameters::Parameter< double, T >.
|
pure virtual |
Return the unit of this parameter instance.
Implemented in lsst::modelfit::parameters::Parameter< T, C >, lsst::modelfit::parameters::Parameter< double, T >, and lsst::modelfit::parameters::Parameter< double, T >.
|
pure virtual |
Return the untransformed value of this parameter instance.
Implemented in lsst::modelfit::parameters::Parameter< T, C >, lsst::modelfit::parameters::Parameter< double, T >, and lsst::modelfit::parameters::Parameter< double, T >.
|
pure virtual |
Return the transformed value of this parameter instance.
Implemented in lsst::modelfit::parameters::Parameter< T, C >, lsst::modelfit::parameters::Parameter< double, T >, and lsst::modelfit::parameters::Parameter< double, T >.
|
pure virtualinherited |
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. |
Implemented in lsst::gauss2d::fit::InverseTransform, lsst::gauss2d::fit::JanskyToABMagTransform, lsst::gauss2d::fit::Log10Transform, lsst::gauss2d::fit::LogitLimitedTransform, lsst::gauss2d::fit::LogitTransform, lsst::gauss2d::fit::LogTransform, lsst::gauss2d::fit::NanojanskyToABMagTransform, lsst::modelfit::parameters::Limits< T >, lsst::modelfit::parameters::Limits< double >, lsst::modelfit::parameters::Parameter< T, C >, lsst::modelfit::parameters::Parameter< double, T >, lsst::modelfit::parameters::Parameter< double, T >, and lsst::modelfit::parameters::UnitTransform< T >.
|
pure virtual |
Set the parameter to be fixed (or not).
Implemented in lsst::modelfit::parameters::Parameter< T, C >, lsst::modelfit::parameters::Parameter< double, T >, and lsst::modelfit::parameters::Parameter< double, T >.
|
pure virtual |
Set the parameter to be free (or not).
Implemented in lsst::modelfit::parameters::Parameter< T, C >, lsst::modelfit::parameters::Parameter< double, T >, and lsst::modelfit::parameters::Parameter< double, T >.
|
pure virtual |
Set the string label for this parameter instance.
Implemented in lsst::modelfit::parameters::Parameter< T, C >, lsst::modelfit::parameters::Parameter< double, T >, and lsst::modelfit::parameters::Parameter< double, T >.
|
pure virtual |
Set the limits for this parameter instance.
Implemented in lsst::modelfit::parameters::Parameter< T, C >, lsst::modelfit::parameters::Parameter< double, T >, and lsst::modelfit::parameters::Parameter< double, T >.
|
pure virtual |
Set the transforming function for this parameter instance.
Implemented in lsst::modelfit::parameters::Parameter< T, C >, lsst::modelfit::parameters::Parameter< double, T >, and lsst::modelfit::parameters::Parameter< double, T >.
|
pure virtual |
Set the unit for this parameter instance.
Implemented in lsst::modelfit::parameters::Parameter< T, C >, lsst::modelfit::parameters::Parameter< double, T >, and lsst::modelfit::parameters::Parameter< double, T >.
|
pure virtual |
Set the untransformed value for this parameter instance.
Implemented in lsst::gauss2d::fit::SersicMixComponentIndexParameterD, lsst::modelfit::parameters::Parameter< T, C >, lsst::modelfit::parameters::Parameter< double, T >, and lsst::modelfit::parameters::Parameter< double, T >.
|
pure virtual |
Set the transformed value for this parameter instance.
Implemented in lsst::gauss2d::fit::SersicMixComponentIndexParameterD, lsst::modelfit::parameters::Parameter< T, C >, lsst::modelfit::parameters::Parameter< double, T >, and lsst::modelfit::parameters::Parameter< double, T >.
|
pure virtualinherited |
Return a brief, human-readable string representation of this.
Implemented in lsst::gauss2d::fit::InverseTransform, lsst::gauss2d::fit::JanskyToABMagTransform, lsst::gauss2d::fit::Log10Transform, lsst::gauss2d::fit::LogitLimitedTransform, lsst::gauss2d::fit::LogitTransform, lsst::gauss2d::fit::LogTransform, lsst::gauss2d::fit::NanojanskyToABMagTransform, lsst::modelfit::parameters::Limits< T >, lsst::modelfit::parameters::Limits< double >, lsst::modelfit::parameters::Parameter< T, C >, lsst::modelfit::parameters::Parameter< double, T >, lsst::modelfit::parameters::Parameter< double, T >, and lsst::modelfit::parameters::UnitTransform< T >.
|
inlinestatic |
Definition at line 111 of file parameter.h.
|
friend |
Definition at line 117 of file parameter.h.
|
friend |
Definition at line 121 of file parameter.h.
|
friend |
Definition at line 113 of file parameter.h.
|
staticconstexprinherited |