Public Member Functions
	__init__ (self)
	add_model (self, group, model)
	add_prior (self, param, value, sigma)
	print_parameters (self, file=sys.stderr)
	set_max_iterations (self, iterations)
	set_modified_chi_squared_scale (self, scale)
	set_engine (self, engine)
	use_iterative_fitting (self, use_iterative_fitting)
	set_meta_iterations (self, meta_iterations)
	set_deblend_factor (self, deblend_factor)
	set_meta_iteration_stop (self, meta_iteration_stop)
	set_window_type (self, window_type)
	set_ellipse_scale (self, ellipse_scale)

Public Attributes
dict	constant_parameter_dict = {}
dict	free_parameter_dict = {}
dict	dependent_parameter_dict = {}
dict	frame_models_dict = {}
dict	prior_dict = {}
dict	constant_model_dict = {}
dict	point_source_model_dict = {}
dict	sersic_model_dict = {}
dict	exponential_model_dict = {}
dict	de_vaucouleurs_model_dict = {}
dict	onnx_model_dict = {}
dict	params_dict

Protected Member Functions
	_set_model_to_frames (self, group, model)
	_is_param_known (self, param)
	_register_parameter (self, attr)
	_populate_parameters (self, model)
	_register_model (self, model)

Detailed Description

Definition at line 1048 of file model_fitting.py.

Constructor & Destructor Documentation

◆ init()

sourcextractor.config.model_fitting.ModelFitting.__init__ ( self )

Definition at line 1049 of file model_fitting.py.

Member Function Documentation

◆ _is_param_known()

sourcextractor.config.model_fitting.ModelFitting._is_param_known	(		self,
			param )

protected

Definition at line 1076 of file model_fitting.py.

References constant_parameter_dict, dependent_parameter_dict, and free_parameter_dict.

Referenced by add_prior().

◆ _populate_parameters()

sourcextractor.config.model_fitting.ModelFitting._populate_parameters	(		self,
			model )

protected

Definition at line 1091 of file model_fitting.py.

References _register_parameter().

Referenced by add_model().

Here is the call graph for this function:

◆ _register_model()

sourcextractor.config.model_fitting.ModelFitting._register_model	(		self,
			model )

protected

Definition at line 1095 of file model_fitting.py.

References constant_model_dict, de_vaucouleurs_model_dict, exponential_model_dict, onnx_model_dict, point_source_model_dict, and sersic_model_dict.

Referenced by add_model().

◆ _register_parameter()

sourcextractor.config.model_fitting.ModelFitting._register_parameter	(		self,
			attr )

protected

Definition at line 1081 of file model_fitting.py.

References _register_parameter(), constant_parameter_dict, dependent_parameter_dict, and free_parameter_dict.

Referenced by _populate_parameters(), _register_parameter(), and add_prior().

Here is the call graph for this function:

◆ _set_model_to_frames()

sourcextractor.config.model_fitting.ModelFitting._set_model_to_frames	(	self,
		group,
		model )

protected

Definition at line 1067 of file model_fitting.py.

References _set_model_to_frames(), and frame_models_dict.

Referenced by _set_model_to_frames(), and add_model().

Here is the call graph for this function:

◆ add_model()

sourcextractor.config.model_fitting.ModelFitting.add_model	(	self,
		group,
		model )

Add a model to be fitted to the given group.

Parameters
----------
group : MeasurementGroup
model : ModelBase

Definition at line 1111 of file model_fitting.py.

References _populate_parameters(), _register_model(), and _set_model_to_frames().

Here is the call graph for this function:

◆ add_prior()

sourcextractor.config.model_fitting.ModelFitting.add_prior	(	self,
		param,
		value,
		sigma )

Add a prior to the given parameter.

Parameters
----------
param : ParameterBase
value : float or callable that receives a source and returns a float
    Mean of the Gaussian
sigma : float or callable that receives a source and returns a float
    Standard deviation of the Gaussian

Definition at line 1130 of file model_fitting.py.

References _is_param_known(), _register_parameter(), and prior_dict.

Here is the call graph for this function:

◆ print_parameters()

sourcextractor.config.model_fitting.ModelFitting.print_parameters	(		self,
			file = sys.stderr )

Print a human-readable representation of the configured model fitting parameters.

Parameters
----------
file : file object
    Where to print the representation. Defaults to sys.stderr

Definition at line 1147 of file model_fitting.py.

References constant_parameter_dict, dependent_parameter_dict, and free_parameter_dict.

◆ set_deblend_factor()

sourcextractor.config.model_fitting.ModelFitting.set_deblend_factor	(		self,
			deblend_factor )

Parameters
----------

Definition at line 1217 of file model_fitting.py.

References params_dict.

◆ set_ellipse_scale()

sourcextractor.config.model_fitting.ModelFitting.set_ellipse_scale	(		self,
			ellipse_scale )

Parameters
----------

ellipse_scale : double
    specify scaling of elliptic footprints

Definition at line 1247 of file model_fitting.py.

References params_dict.

◆ set_engine()

sourcextractor.config.model_fitting.ModelFitting.set_engine	(		self,
			engine )

Parameters
----------
engine : str
    Minimization engine for the model fitting : levmar or gsl

Definition at line 1190 of file model_fitting.py.

References params_dict.

◆ set_max_iterations()

sourcextractor.config.model_fitting.ModelFitting.set_max_iterations	(		self,
			iterations )

Parameters
----------
iterations : int
    Max number of iterations for the model fitting.

Definition at line 1169 of file model_fitting.py.

References params_dict.

◆ set_meta_iteration_stop()

sourcextractor.config.model_fitting.ModelFitting.set_meta_iteration_stop	(		self,
			meta_iteration_stop )

Parameters
----------

Definition at line 1225 of file model_fitting.py.

References params_dict.

◆ set_meta_iterations()

sourcextractor.config.model_fitting.ModelFitting.set_meta_iterations	(		self,
			meta_iterations )

Parameters
----------
meta_iterations : int
    number of meta iterations on the whole group (when using iterative model fitting)

Definition at line 1208 of file model_fitting.py.

References params_dict.

◆ set_modified_chi_squared_scale()

sourcextractor.config.model_fitting.ModelFitting.set_modified_chi_squared_scale	(		self,
			scale )

Parameters
----------
scale : float
    Sets u0, as used by the modified chi squared residual comparator, a function that reduces the effect of large
    deviations.
    Refer to the SourceXtractor++ documentation for a better explanation of how residuals are computed and how
    this value affects the model fitting.

Definition at line 1178 of file model_fitting.py.

References params_dict.

◆ set_window_type()

sourcextractor.config.model_fitting.ModelFitting.set_window_type	(		self,
			window_type )

Parameters
----------

window_type : WindowType
    specify the type of model fitting window

Definition at line 1233 of file model_fitting.py.

References params_dict.

◆ use_iterative_fitting()

sourcextractor.config.model_fitting.ModelFitting.use_iterative_fitting	(		self,
			use_iterative_fitting )

Parameters
----------
use_iterative_fitting : boolean
    use iterative model fitting or legacy

Definition at line 1199 of file model_fitting.py.

References params_dict.

Member Data Documentation

◆ constant_model_dict

dict sourcextractor.config.model_fitting.ModelFitting.constant_model_dict = {}

Definition at line 1055 of file model_fitting.py.

Referenced by _register_model().

◆ constant_parameter_dict

dict sourcextractor.config.model_fitting.ModelFitting.constant_parameter_dict = {}

Definition at line 1050 of file model_fitting.py.

Referenced by _is_param_known(), _register_parameter(), and print_parameters().

◆ de_vaucouleurs_model_dict

dict sourcextractor.config.model_fitting.ModelFitting.de_vaucouleurs_model_dict = {}

Definition at line 1059 of file model_fitting.py.

Referenced by _register_model().

◆ dependent_parameter_dict

dict sourcextractor.config.model_fitting.ModelFitting.dependent_parameter_dict = {}

Definition at line 1052 of file model_fitting.py.

Referenced by _is_param_known(), _register_parameter(), and print_parameters().

◆ exponential_model_dict

dict sourcextractor.config.model_fitting.ModelFitting.exponential_model_dict = {}

Definition at line 1058 of file model_fitting.py.

Referenced by _register_model().

◆ frame_models_dict

dict sourcextractor.config.model_fitting.ModelFitting.frame_models_dict = {}

Definition at line 1053 of file model_fitting.py.

Referenced by _set_model_to_frames().

◆ free_parameter_dict

dict sourcextractor.config.model_fitting.ModelFitting.free_parameter_dict = {}

Definition at line 1051 of file model_fitting.py.

Referenced by _is_param_known(), _register_parameter(), and print_parameters().

◆ onnx_model_dict

dict sourcextractor.config.model_fitting.ModelFitting.onnx_model_dict = {}

Definition at line 1060 of file model_fitting.py.

Referenced by _register_model().

◆ params_dict

dict sourcextractor.config.model_fitting.ModelFitting.params_dict

Initial value:

=  {"max_iterations": 200, "modified_chi_squared_scale": 10, "engine": "",
                            "use_iterative_fitting": True, "meta_iterations": 5,
                            "deblend_factor": 0.95, "meta_iteration_stop": 0.0001,
                            "window_type": WindowType.RECTANGLE, "ellipse_scale": 3.0
                            }

Definition at line 1061 of file model_fitting.py.

Referenced by set_deblend_factor(), set_ellipse_scale(), set_engine(), set_max_iterations(), set_meta_iteration_stop(), set_meta_iterations(), set_modified_chi_squared_scale(), set_window_type(), and use_iterative_fitting().

◆ point_source_model_dict

dict sourcextractor.config.model_fitting.ModelFitting.point_source_model_dict = {}

Definition at line 1056 of file model_fitting.py.

Referenced by _register_model().

◆ prior_dict

dict sourcextractor.config.model_fitting.ModelFitting.prior_dict = {}

Definition at line 1054 of file model_fitting.py.

Referenced by add_prior().

◆ sersic_model_dict

dict sourcextractor.config.model_fitting.ModelFitting.sersic_model_dict = {}

Definition at line 1057 of file model_fitting.py.

Referenced by _register_model().

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

SEImplementation/python/sourcextractor/config/model_fitting.py

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _is_param_known()

◆ _populate_parameters()

◆ _register_model()

◆ _register_parameter()

◆ _set_model_to_frames()

◆ add_model()

◆ add_prior()

◆ print_parameters()

◆ set_deblend_factor()

◆ set_ellipse_scale()

◆ set_engine()

◆ set_max_iterations()

◆ set_meta_iteration_stop()

◆ set_meta_iterations()

◆ set_modified_chi_squared_scale()

◆ set_window_type()

◆ use_iterative_fitting()

Member Data Documentation

◆ constant_model_dict

◆ constant_parameter_dict

◆ de_vaucouleurs_model_dict

◆ dependent_parameter_dict

◆ exponential_model_dict

◆ frame_models_dict

◆ free_parameter_dict

◆ onnx_model_dict

◆ params_dict

◆ point_source_model_dict

◆ prior_dict

◆ sersic_model_dict

◆ init()