Inheritance diagram for sourcextractor.config.model_fitting.FreeParameter:

Collaboration diagram for sourcextractor.config.model_fitting.FreeParameter:

Public Member Functions
def	__init__ (self, init_value, range=Unbounded())

def	get_init_value (self)

def	get_range (self)

def	__str__ (self)

Public Member Functions inherited from sourcextractor.config.model_fitting.ParameterBase
def	__str__ (self)

Private Attributes
	__init_value

	__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 241 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 262 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

Definition at line 288 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 )

Returns
-------
callable
    Receives a source, and returns an initial value for the parameter.

Definition at line 271 of file model_fitting.py.

References sourcextractor.config.model_fitting.FreeParameter.__init_value.

◆ get_range()

def sourcextractor.config.model_fitting.FreeParameter.get_range ( self )

Returns
-------
Unbounded or Range

Definition at line 280 of file model_fitting.py.

References sourcextractor.config.model_fitting.FreeParameter.__range.

Member Data Documentation

◆ __init_value

sourcextractor.config.model_fitting.FreeParameter.__init_value

private

Definition at line 267 of file model_fitting.py.

Referenced by sourcextractor.config.model_fitting.FreeParameter.__str__(), and sourcextractor.config.model_fitting.FreeParameter.get_init_value().

◆ __range

sourcextractor.config.model_fitting.FreeParameter.__range

private

Definition at line 268 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

Public Member Functions

Private Attributes