sourcextractor.config.model_fitting.FreeParameter Class Reference

Inheritance diagram for sourcextractor.config.model_fitting.FreeParameter:

Collaboration diagram for sourcextractor.config.model_fitting.FreeParameter:

Public Member Functions
	__init__ (self, init_value, range=Unbounded())
	get_init_value (self, o)
	get_range (self)
	__str__ (self)
Public Member Functions inherited from sourcextractor.config.model_fitting.ParameterBase

Public Attributes
str	__range = ', range:' + str(self.__range)
Public Attributes inherited from sourcextractor.config.model_fitting.ParameterBase
	id

Private Attributes
	__init_value = init_value
	__init_call = init_value if hasattr(init_value, '__call__') else lambda o: init_value
	__range = 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 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.

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

sourcextractor.config.model_fitting.FreeParameter.__init_call = init_value if hasattr(init_value, '__call__') else lambda o: init_value

private

Definition at line 274 of file model_fitting.py.

Referenced by sourcextractor.config.model_fitting.FreeParameter.get_init_value().

__init_value

sourcextractor.config.model_fitting.FreeParameter.__init_value = init_value

private

Definition at line 273 of file model_fitting.py.

Referenced by sourcextractor.config.model_fitting.FreeParameter.__str__().

__range [1/2]

sourcextractor.config.model_fitting.FreeParameter.__range = range

private

Definition at line 275 of file model_fitting.py.

Referenced by sourcextractor.config.model_fitting.FreeParameter.get_range().

__range [2/2]

str sourcextractor.config.model_fitting.FreeParameter.__range = ', range:' + str(self.__range)

Definition at line 310 of file model_fitting.py.

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