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