sourcextractor.config.model_fitting.ModelFitting Class Reference

Public Member Functions
def	__init__
def	add_model
def	add_prior
def	print_parameters
def	set_max_iterations
def	set_modified_chi_squared_scale
def	set_engine
def	use_iterative_fitting
def	set_meta_iterations
def	set_deblend_factor
def	set_meta_iteration_stop

Public Attributes
	constant_parameter_dict
	free_parameter_dict
	dependent_parameter_dict
	frame_models_dict
	prior_dict
	constant_model_dict
	point_source_model_dict
	sersic_model_dict
	exponential_model_dict
	de_vaucouleurs_model_dict
	onnx_model_dict
	params_dict

Private Member Functions
def	_set_model_to_frames
def	_is_param_known
def	_register_parameter
def	_populate_parameters
def	_register_model

Detailed Description

Definition at line 1038 of file model_fitting.py.

Constructor & Destructor Documentation

def sourcextractor.config.model_fitting.ModelFitting.__init__

(

self

)

Definition at line 1039 of file model_fitting.py.

Member Function Documentation

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

private

Definition at line 1064 of file model_fitting.py.

References sourcextractor.config.model_fitting.ModelFitting.constant_parameter_dict, sourcextractor.config.model_fitting.ModelFitting.dependent_parameter_dict, and sourcextractor.config.model_fitting.ModelFitting.free_parameter_dict.

Referenced by sourcextractor.config.model_fitting.ModelFitting.add_prior().

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

private

Definition at line 1079 of file model_fitting.py.

References sourcextractor.config.model_fitting.ModelFitting._register_parameter().

Referenced by sourcextractor.config.model_fitting.ModelFitting.add_model().

Here is the call graph for this function:

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

private

Definition at line 1083 of file model_fitting.py.

References sourcextractor.config.model_fitting.ModelFitting.constant_model_dict, sourcextractor.config.model_fitting.ModelFitting.de_vaucouleurs_model_dict, sourcextractor.config.model_fitting.ModelFitting.exponential_model_dict, sourcextractor.config.model_fitting.ModelFitting.onnx_model_dict, sourcextractor.config.model_fitting.ModelFitting.point_source_model_dict, and sourcextractor.config.model_fitting.ModelFitting.sersic_model_dict.

Referenced by sourcextractor.config.model_fitting.ModelFitting.add_model().

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

private

Definition at line 1069 of file model_fitting.py.

References sourcextractor.config.model_fitting.ModelFitting._register_parameter(), sourcextractor.config.model_fitting.ModelFitting.constant_parameter_dict, sourcextractor.config.model_fitting.ModelFitting.dependent_parameter_dict, and sourcextractor.config.model_fitting.ModelFitting.free_parameter_dict.

Referenced by sourcextractor.config.model_fitting.ModelFitting._populate_parameters(), sourcextractor.config.model_fitting.ModelFitting._register_parameter(), and sourcextractor.config.model_fitting.ModelFitting.add_prior().

Here is the call graph for this function:

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

private

Definition at line 1055 of file model_fitting.py.

References sourcextractor.config.model_fitting.ModelFitting._set_model_to_frames(), and sourcextractor.config.model_fitting.ModelFitting.frame_models_dict.

Referenced by sourcextractor.config.model_fitting.ModelFitting._set_model_to_frames(), and sourcextractor.config.model_fitting.ModelFitting.add_model().

Here is the call graph for this function:

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

References sourcextractor.config.model_fitting.ModelFitting._populate_parameters(), sourcextractor.config.model_fitting.ModelFitting._register_model(), and sourcextractor.config.model_fitting.ModelFitting._set_model_to_frames().

Here is the call graph for this function:

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

References sourcextractor.config.model_fitting.ModelFitting._is_param_known(), sourcextractor.config.model_fitting.ModelFitting._register_parameter(), and sourcextractor.config.model_fitting.ModelFitting.prior_dict.

Here is the call graph for this function:

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

References sourcextractor.config.model_fitting.ModelFitting.constant_parameter_dict, sourcextractor.config.model_fitting.ModelFitting.dependent_parameter_dict, and sourcextractor.config.model_fitting.ModelFitting.free_parameter_dict.

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

Parameters
----------

Definition at line 1205 of file model_fitting.py.

References sourcextractor.config.model_fitting.ModelFitting.params_dict.

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

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

Definition at line 1178 of file model_fitting.py.

References sourcextractor.config.model_fitting.ModelFitting.params_dict.

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

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

Definition at line 1157 of file model_fitting.py.

References sourcextractor.config.model_fitting.ModelFitting.params_dict.

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

Parameters
----------

Definition at line 1213 of file model_fitting.py.

References sourcextractor.config.model_fitting.ModelFitting.params_dict.

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

References sourcextractor.config.model_fitting.ModelFitting.params_dict.

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

References sourcextractor.config.model_fitting.ModelFitting.params_dict.

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

References sourcextractor.config.model_fitting.ModelFitting.params_dict.

Member Data Documentation

sourcextractor.config.model_fitting.ModelFitting.constant_model_dict

Definition at line 1045 of file model_fitting.py.

Referenced by sourcextractor.config.model_fitting.ModelFitting._register_model().

sourcextractor.config.model_fitting.ModelFitting.constant_parameter_dict

Definition at line 1040 of file model_fitting.py.

Referenced by sourcextractor.config.model_fitting.ModelFitting._is_param_known(), sourcextractor.config.model_fitting.ModelFitting._register_parameter(), and sourcextractor.config.model_fitting.ModelFitting.print_parameters().

sourcextractor.config.model_fitting.ModelFitting.de_vaucouleurs_model_dict

Definition at line 1049 of file model_fitting.py.

Referenced by sourcextractor.config.model_fitting.ModelFitting._register_model().

sourcextractor.config.model_fitting.ModelFitting.dependent_parameter_dict

Definition at line 1042 of file model_fitting.py.

Referenced by sourcextractor.config.model_fitting.ModelFitting._is_param_known(), sourcextractor.config.model_fitting.ModelFitting._register_parameter(), and sourcextractor.config.model_fitting.ModelFitting.print_parameters().

sourcextractor.config.model_fitting.ModelFitting.exponential_model_dict

Definition at line 1048 of file model_fitting.py.

Referenced by sourcextractor.config.model_fitting.ModelFitting._register_model().

sourcextractor.config.model_fitting.ModelFitting.frame_models_dict

Definition at line 1043 of file model_fitting.py.

Referenced by sourcextractor.config.model_fitting.ModelFitting._set_model_to_frames().

sourcextractor.config.model_fitting.ModelFitting.free_parameter_dict

Definition at line 1041 of file model_fitting.py.

Referenced by sourcextractor.config.model_fitting.ModelFitting._is_param_known(), sourcextractor.config.model_fitting.ModelFitting._register_parameter(), and sourcextractor.config.model_fitting.ModelFitting.print_parameters().

sourcextractor.config.model_fitting.ModelFitting.onnx_model_dict

Definition at line 1050 of file model_fitting.py.

Referenced by sourcextractor.config.model_fitting.ModelFitting._register_model().

sourcextractor.config.model_fitting.ModelFitting.params_dict

Definition at line 1051 of file model_fitting.py.

Referenced by sourcextractor.config.model_fitting.ModelFitting.set_deblend_factor(), sourcextractor.config.model_fitting.ModelFitting.set_engine(), sourcextractor.config.model_fitting.ModelFitting.set_max_iterations(), sourcextractor.config.model_fitting.ModelFitting.set_meta_iteration_stop(), sourcextractor.config.model_fitting.ModelFitting.set_meta_iterations(), sourcextractor.config.model_fitting.ModelFitting.set_modified_chi_squared_scale(), and sourcextractor.config.model_fitting.ModelFitting.use_iterative_fitting().

sourcextractor.config.model_fitting.ModelFitting.point_source_model_dict

Definition at line 1046 of file model_fitting.py.

Referenced by sourcextractor.config.model_fitting.ModelFitting._register_model().

sourcextractor.config.model_fitting.ModelFitting.prior_dict

Definition at line 1044 of file model_fitting.py.

Referenced by sourcextractor.config.model_fitting.ModelFitting.add_prior().

sourcextractor.config.model_fitting.ModelFitting.sersic_model_dict

Definition at line 1047 of file model_fitting.py.

Referenced by sourcextractor.config.model_fitting.ModelFitting._register_model().

---

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

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