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) | |
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 1038 of file model_fitting.py.
Constructor & Destructor Documentation
◆ __init__()
| sourcextractor.config.model_fitting.ModelFitting.__init__ | ( | self | ) |
Definition at line 1039 of file model_fitting.py.
Member Function Documentation
◆ _is_param_known()
|
protected |
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().
◆ _populate_parameters()
|
protected |
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().
◆ _register_model()
|
protected |
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().
◆ _register_parameter()
|
protected |
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().
◆ _set_model_to_frames()
|
protected |
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().
◆ 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 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().
◆ 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 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.
◆ 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 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.
◆ set_deblend_factor()
| 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.
◆ 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 1178 of file model_fitting.py.
References sourcextractor.config.model_fitting.ModelFitting.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 1157 of file model_fitting.py.
References sourcextractor.config.model_fitting.ModelFitting.params_dict.
◆ set_meta_iteration_stop()
| 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.
◆ 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 1196 of file model_fitting.py.
References sourcextractor.config.model_fitting.ModelFitting.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 1166 of file model_fitting.py.
References sourcextractor.config.model_fitting.ModelFitting.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 1187 of file model_fitting.py.
References sourcextractor.config.model_fitting.ModelFitting.params_dict.
Member Data Documentation
◆ constant_model_dict
| 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().
◆ constant_parameter_dict
| sourcextractor.config.model_fitting.ModelFitting.constant_parameter_dict |
◆ de_vaucouleurs_model_dict
| 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().
◆ dependent_parameter_dict
| sourcextractor.config.model_fitting.ModelFitting.dependent_parameter_dict |
◆ exponential_model_dict
| 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().
◆ frame_models_dict
| 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().
◆ free_parameter_dict
| sourcextractor.config.model_fitting.ModelFitting.free_parameter_dict |
◆ onnx_model_dict
| 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().
◆ params_dict
| 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().
◆ point_source_model_dict
| 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().
◆ prior_dict
| 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().
◆ sersic_model_dict
| 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
