Public Member Functions | |
| __init__ (self, init_value, range=Unbounded()) | |
| get_init_value (self, o) | |
| get_range (self) | |
| __str__ (self) | |
Private Attributes | |
| __init_value | |
| __init_call | |
| __range | |
Additional Inherited Members | |
 Public Attributes inherited from sourcextractor.config.model_fitting.ParameterBase | |
| id | |
Detailed Description
A parameter that will be fitted by the model fitting engine.
Parameters
----------
init_value : float or callable that receives a source, and returns a float
Initial value for the parameter.
range : instance of Range or Unbounded
Defines if this parameter is unbounded or bounded, and how.
See Also
--------
Unbounded
Range
Examples
--------
>>> sersic = FreeParameter(2.0, Range((1.0, 7.0), RangeType.LINEAR))
Definition at line 247 of file model_fitting.py.
Constructor & Destructor Documentation
◆ __init__()
| sourcextractor.config.model_fitting.FreeParameter.__init__ | ( | self, | |
| init_value, | |||
| range = Unbounded() ) |
Constructor.
Definition at line 268 of file model_fitting.py.
Member Function Documentation
◆ __str__()
| sourcextractor.config.model_fitting.FreeParameter.__str__ | ( | self | ) |
Returns
-------
str
Human readable representation for the object
Reimplemented from sourcextractor.config.model_fitting.ParameterBase.
Definition at line 298 of file model_fitting.py.
References sourcextractor.config.model_fitting.FreeParameter.__init_value, and sourcextractor.config.model_fitting.FreeParameter.__range.
◆ get_init_value()
| sourcextractor.config.model_fitting.FreeParameter.get_init_value | ( | self, | |
| o ) |
Parameters
----------
o : object being fitted
Returns
-------
float
Initial value for the free parameter
Definition at line 277 of file model_fitting.py.
References sourcextractor.config.model_fitting.FreeParameter.__init_call.
◆ get_range()
| sourcextractor.config.model_fitting.FreeParameter.get_range | ( | self | ) |
Returns ------- Unbounded or Range
Definition at line 290 of file model_fitting.py.
References sourcextractor.config.model_fitting.FreeParameter.__range.
Member Data Documentation
◆ __init_call
|
private |
Definition at line 274 of file model_fitting.py.
Referenced by sourcextractor.config.model_fitting.FreeParameter.get_init_value().
◆ __init_value
|
private |
Definition at line 273 of file model_fitting.py.
Referenced by sourcextractor.config.model_fitting.FreeParameter.__str__().
◆ __range
|
private |
Definition at line 275 of file model_fitting.py.
Referenced by sourcextractor.config.model_fitting.FreeParameter.__str__(), and sourcextractor.config.model_fitting.FreeParameter.get_range().
The documentation for this class was generated from the following file:
- SEImplementation/python/sourcextractor/config/model_fitting.py
