SourceXtractorPlusPlus  0.16
Please provide a description of the project.
Public Member Functions | Private Attributes | List of all members
sourcextractor.config.model_fitting.FreeParameter Class Reference
Inheritance diagram for sourcextractor.config.model_fitting.FreeParameter:
[legend]
Collaboration diagram for sourcextractor.config.model_fitting.FreeParameter:
[legend]

Public Member Functions

def __init__ (self, init_value, range=Unbounded())
 
def get_init_value (self, o)
 
def get_range (self)
 
def __str__ (self)
 

Private Attributes

 __init_value
 
 __init_call
 
 __range
 

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 275 of file model_fitting.py.

Constructor & Destructor Documentation

◆ __init__()

def sourcextractor.config.model_fitting.FreeParameter.__init__ (   self,
  init_value,
  range = Unbounded() 
)
Constructor.

Definition at line 296 of file model_fitting.py.

Member Function Documentation

◆ __str__()

def 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 327 of file model_fitting.py.

References sourcextractor.config.model_fitting.FreeParameter.__init_value, and sourcextractor.config.model_fitting.FreeParameter.__range.

◆ get_init_value()

def 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 306 of file model_fitting.py.

References sourcextractor.config.model_fitting.FreeParameter.__init_call.

◆ get_range()

def sourcextractor.config.model_fitting.FreeParameter.get_range (   self)
Returns
-------
Unbounded or Range

Definition at line 319 of file model_fitting.py.

References sourcextractor.config.model_fitting.FreeParameter.__range.

Member Data Documentation

◆ __init_call

sourcextractor.config.model_fitting.FreeParameter.__init_call
private

◆ __init_value

sourcextractor.config.model_fitting.FreeParameter.__init_value
private

◆ __range

sourcextractor.config.model_fitting.FreeParameter.__range
private

The documentation for this class was generated from the following file: