atomcloud.process_fits.analyze module

Created on Sat Sep 3 12:09:07 2022

@author: hofer

class atomcloud.process_fits.analyze.AnalyzeFitDicts

Bases: IterateFitDict

Class to analyze the fit parameters from a multi-function fit or series of multi-function fits.

analyze_fitdict(fit_dict, dict_type=None)

Analyze the fit parameters from a multi-function fit or series of multi-function fits. If a multi-level fit dict is passed, the analysis will be applied to each level of the dict using the parent class IterateFitDict. The analysis functions themselves are defined by the individual function objects in atomcloud.functions.funcs_1d or atomcloud.functions.funcs_2d.

Parameters:

• fit_dict (dict) – fit dictionary to be analyzed

• dict_type (str | None) – type of fit dictionary. If not given, the type will be inferred from the fit dict.

Returns:

analyzed fit dictionary

Return type:

dict

process_fitdict1d(fit_dict, *args, **kwargs)

Calls the analyze_1d_fit function to analyze the fit parameters, but within the context of the IterateFitDict class. This allows the analysis to be applied to each level of a multi-level fit dict.

Parameters:

fit_dict (dict) –

Return type:

dict

process_fitdict2d(fit_dict, *args, **kwargs)

Calls the analyze_2d_fit function to analyze the fit parameters, but within the context of the IterateFitDict class. This allows the analysis to be applied to each level of a multi-level fit dict.

Parameters:

fit_dict (dict) –

Return type:

dict

atomcloud.process_fits.analyze.analyze_1d_fit(fit_dict)

Caculates the analysis parameters for a 1d cloud multi-function fit. using the function objects in atomcloud.functions.funcs_1d

Parameters:

fit_dict (dict) – dictionary of fit results and info

Returns:

The input fit dict, but with the analysis parameters added

Return type:

dict

atomcloud.process_fits.analyze.analyze_2d_fit(fit_dict)

Caculates the analysis parameters for a 2d multi-function fit. using the function objects in atomcloud.functions.funcs_2d.

Parameters:

fit_dict (dict) – dictionary of fit results and info

Returns:

The input fit dict, but with the analysis parameters added

Return type:

dict

atomcloud.process_fits.analyze.analyze_fitdict(fit_dicts, dict_type=None)

Initialize the AnalyzeFitDicts class and call the analyze_fitdict method. This allows any fit dict to be analyzed without having to initialize the class. The analysis functions themselves are defined by the individual function objects in atomcloud.functions.funcs_1d or atomcloud.functions.funcs_2d.

Parameters:

• fit_dicts (dict) – fit dictionary to be analyzed

• dict_type (str | None) – type of fit dictionary. If not given, the type will be inferred from the fit dict.

Returns:

analyzed fit dictionary

Return type:

dict

atomcloud.process_fits.analyze.parameter_analysis(fit_dict, func_registry)

Analyze the fit parameters from a multi-function fit. The analysis functions themselves are defined by the individual function objects in atomcloud.functions.funcs_1d or atomcloud.functions.funcs_2d. By default these include integrating the fitted function and calculating the lab-frame widths for the 2d fits.

Parameters:

• fit_dict (dict) – dictionary of fit results and info

• func_registry (object) – registry of either 1d or 2d function objects

Returns:

The input fit dict, but with the analysis parameters added

Return type:

dict