sourcextractor.config.model_fitting.SersicModel Class Reference

Inheritance diagram for sourcextractor.config.model_fitting.SersicModel:

Collaboration diagram for sourcextractor.config.model_fitting.SersicModel:

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

Public Attributes
	n = n if isinstance(n, ParameterBase) else ConstantParameter(n)
Public Attributes inherited from sourcextractor.config.model_fitting.SersicModelBase
	effective_radius
	aspect_ratio
	angle = angle if isinstance(angle, ParameterBase) else ConstantParameter(angle)
Public Attributes inherited from sourcextractor.config.model_fitting.CoordinateModelBase
	x_coord = x_coord if isinstance(x_coord, ParameterBase) else ConstantParameter(x_coord)
	y_coord = y_coord if isinstance(y_coord, ParameterBase) else ConstantParameter(y_coord)
	flux = flux if isinstance(flux, ParameterBase) else ConstantParameter(flux)

Detailed Description

Model a source with a Sersic profile.

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
n : ParameterBase or float
    Sersic index

Definition at line 574 of file model_fitting.py.

Constructor & Destructor Documentation

__init__()

sourcextractor.config.model_fitting.SersicModel.__init__	(		self,
			x_coord,
			y_coord,
			flux,
			effective_radius,
			aspect_ratio,
			angle,
			n )

Constructor.

Definition at line 596 of file model_fitting.py.

Member Function Documentation

get_params()

sourcextractor.config.model_fitting.SersicModel.get_params

(

self

)

Reimplemented from sourcextractor.config.model_fitting.SersicModelBase.

Definition at line 626 of file model_fitting.py.

References ModelFitting::CompactSersicModel< ImageType >::SersicModelEvaluator.n, and n.

to_string()

sourcextractor.config.model_fitting.SersicModel.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 604 of file model_fitting.py.

Member Data Documentation

n

sourcextractor.config.model_fitting.SersicModel.n = n if isinstance(n, ParameterBase) else ConstantParameter(n)

Definition at line 602 of file model_fitting.py.

Referenced by get_params().

---

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

• SEImplementation/python/sourcextractor/config/model_fitting.py