SourceXtractorPlusPlus 0.21
SourceXtractor++, the next generation SExtractor
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
sourcextractor.config.model_fitting.ExponentialModel Class Reference
Inheritance diagram for sourcextractor.config.model_fitting.ExponentialModel:
Inheritance graph
[legend]
Collaboration diagram for sourcextractor.config.model_fitting.ExponentialModel:
Collaboration graph
[legend]

Public Member Functions

 __init__ (self, x_coord, y_coord, flux, effective_radius, aspect_ratio, angle)
 
 to_string (self, show_params=False)
 
- Public Member Functions inherited from sourcextractor.config.model_fitting.SersicModelBase
 get_params (self)
 

Public Attributes

 x_coord
 
 y_coord
 
 flux
 
 effective_radius
 
 aspect_ratio
 
 angle
 
- Public Attributes inherited from sourcextractor.config.model_fitting.SersicModelBase
 effective_radius
 
 aspect_ratio
 
 angle
 
- Public Attributes inherited from sourcextractor.config.model_fitting.CoordinateModelBase
 x_coord
 
 y_coord
 
 flux
 

Detailed Description

Model a source with an exponential profile (Sersic model with an index of 1)

Parameters
----------
x_coord : ParameterBase or float
    X coordinate (in the detection image)
y_coord : ParameterBase or float
    Y coordinate (in the detection image)
flux : ParameterBase or float
    Total flux
effective_radius : ParameterBase or float
    Ellipse semi-major axis, in pixels on the detection image.
aspect_ratio : ParameterBase or float
    Ellipse ratio.
angle : ParameterBase or float
    Ellipse rotation, in radians

Definition at line 630 of file model_fitting.py.

Constructor & Destructor Documentation

◆ __init__()

sourcextractor.config.model_fitting.ExponentialModel.__init__ ( self,
x_coord,
y_coord,
flux,
effective_radius,
aspect_ratio,
angle )
Constructor.

Reimplemented from sourcextractor.config.model_fitting.SersicModelBase.

Definition at line 650 of file model_fitting.py.

Member Function Documentation

◆ to_string()

sourcextractor.config.model_fitting.ExponentialModel.to_string ( self,
show_params = False )
Return a human readable representation of the model.

Parameters
----------
show_params: bool
    If True, include information about the parameters.

Returns
-------
str

Definition at line 657 of file model_fitting.py.

Member Data Documentation

◆ angle

sourcextractor.config.model_fitting.ExponentialModel.angle

◆ aspect_ratio

sourcextractor.config.model_fitting.ExponentialModel.aspect_ratio

◆ effective_radius

sourcextractor.config.model_fitting.ExponentialModel.effective_radius

◆ flux

sourcextractor.config.model_fitting.ExponentialModel.flux

◆ x_coord

sourcextractor.config.model_fitting.ExponentialModel.x_coord

◆ y_coord

sourcextractor.config.model_fitting.ExponentialModel.y_coord

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