Inheritance diagram for sourcextractor.config.model_fitting.SersicModel:

Collaboration diagram for sourcextractor.config.model_fitting.SersicModel:

Public Member Functions
def	__init__ (self, x_coord, y_coord, flux, effective_radius, aspect_ratio, angle, n)

def	to_string (self, show_params=False)

Public Member Functions inherited from sourcextractor.config.model_fitting.SersicModelBase
def	__init__ (self, x_coord, y_coord, flux, effective_radius, aspect_ratio, angle)

Public Member Functions inherited from sourcextractor.config.model_fitting.CoordinateModelBase
def	__init__ (self, x_coord, y_coord, flux)

Public Attributes
	n

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 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 667 of file model_fitting.py.

Constructor & Destructor Documentation

◆ init()

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

Constructor.

Definition at line 689 of file model_fitting.py.

Member Function Documentation

◆ to_string()

def 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 698 of file model_fitting.py.

References sourcextractor.config.model_fitting.SersicModelBase.angle, sourcextractor.config.model_fitting.SersicModelBase.aspect_ratio, sourcextractor.config.model_fitting.SersicModelBase.effective_radius, Euclid::SourceCatalog::FluxErrorPair.flux, sourcextractor.config.model_fitting.CoordinateModelBase.flux, ModelFitting::CompactSersicModel< ImageType >::SersicModelEvaluator.n, sourcextractor.config.model_fitting.SersicModel.n, sourcextractor.config.model_fitting.CoordinateModelBase.x_coord, and sourcextractor.config.model_fitting.CoordinateModelBase.y_coord.