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

Public Member Functions

def __init__ (self, value)
 
def get_value (self, o)
 
def __str__ (self)
 

Private Attributes

 __value
 
 __callable
 

Detailed Description

A parameter with a single value that remains constant. It will not be fitted.

Parameters
----------
value : float, or callable that receives a source and returns a float
    Value for this parameter

Definition at line 228 of file model_fitting.py.

Constructor & Destructor Documentation

◆ __init__()

def sourcextractor.config.model_fitting.ConstantParameter.__init__ (   self,
  value 
)
Constructor.

Definition at line 238 of file model_fitting.py.

Member Function Documentation

◆ __str__()

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

Reimplemented from sourcextractor.config.model_fitting.ParameterBase.

Definition at line 260 of file model_fitting.py.

References sourcextractor.config.model_fitting.ConstantParameter.__value.

◆ get_value()

def sourcextractor.config.model_fitting.ConstantParameter.get_value (   self,
  o 
)
Parameters
----------
o : object being fitted

Returns
-------
float
    Value of the constant parameter

Definition at line 247 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.

Member Data Documentation

◆ __callable

sourcextractor.config.model_fitting.ConstantParameter.__callable
private

◆ __value

sourcextractor.config.model_fitting.ConstantParameter.__value
private

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