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

Public Member Functions

def __init__ (self, limits, type)
 
def get_min (self, v, o)
 
def get_max (self, v, o)
 
def get_type (self)
 
def __str__ (self)
 

Private Attributes

 __limits
 
 __callable
 
 __type
 

Detailed Description

Limit, and normalize, the range of values for a model fitting parameter.


Parameters
----------
limits : a tuple (min, max), or a callable that receives a source, and returns a tuple (min, max)
type : RangeType

Notes
-----
RangeType.LINEAR
    Normalized to engine space using a sigmoid function

    .. math::

        engine = \ln \frac{world - min}{max-world} \\
        world = min + \frac{max - min}{1 + e^{engine}}

RangeType.EXPONENTIAL
    Normalized to engine space using an exponential sigmoid function

    .. math::

        engine = \ln \left( \frac{\ln(world/min)}{\ln(max /world)} \right) \\
        world = min * e^\frac{ \ln(max / min) }{ (1 + e^{-engine}) }

Definition at line 41 of file model_fitting.py.

Constructor & Destructor Documentation

◆ __init__()

def sourcextractor.config.model_fitting.Range.__init__ (   self,
  limits,
  type 
)
Constructor.

Definition at line 71 of file model_fitting.py.

Member Function Documentation

◆ __str__()

def sourcextractor.config.model_fitting.Range.__str__ (   self)
Returns
-------
str
    Human readable representation for the object

Definition at line 113 of file model_fitting.py.

References sourcextractor.config.model_fitting.Range.__limits, and sourcextractor.config.model_fitting.Range.__type.

◆ get_max()

def sourcextractor.config.model_fitting.Range.get_max (   self,
  v,
  o 
)
Parameters
----------
v : initial value
o : object being fitted

Returns
-------
The maximum acceptable value for the range

Definition at line 92 of file model_fitting.py.

References sourcextractor.config.model_fitting.Range.__callable, sourcextractor.config.model_fitting.Unbounded.__callable, and sourcextractor.config.model_fitting.ConstantParameter.__callable.

◆ get_min()

def sourcextractor.config.model_fitting.Range.get_min (   self,
  v,
  o 
)
Parameters
----------
v : initial value
o : object being fitted

Returns
-------
The minimum acceptable value for the range

Definition at line 79 of file model_fitting.py.

References sourcextractor.config.model_fitting.Range.__callable, sourcextractor.config.model_fitting.Unbounded.__callable, and sourcextractor.config.model_fitting.ConstantParameter.__callable.

◆ get_type()

def sourcextractor.config.model_fitting.Range.get_type (   self)
Returns
-------
RangeType

Definition at line 105 of file model_fitting.py.

References sourcextractor.config.model_fitting.Range.__type.

Member Data Documentation

◆ __callable

sourcextractor.config.model_fitting.Range.__callable
private

◆ __limits

sourcextractor.config.model_fitting.Range.__limits
private

Definition at line 75 of file model_fitting.py.

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

◆ __type

sourcextractor.config.model_fitting.Range.__type
private

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