atomcloud.functions.funcs_1d module
Created on Fri Mar 18 21:16:36 2022
@author: hofer
- class atomcloud.functions.funcs_1d.EnhancedBose1D[source]
Bases:
FixedEnhancedBose1DSee FunctionBase for documentation
- create_function(anp)[source]
Creates the function using the numpy or jax object given. This method must be overridden by the child class. :param anp: The numpy or jax object to use for the function
- Returns:
The created function
- class atomcloud.functions.funcs_1d.FixedEnhancedBose1D[source]
Bases:
Gaussian1DSee FunctionBase for documentation
- class atomcloud.functions.funcs_1d.FixedOffset1D[source]
Bases:
FunctionBaseSee FunctionBase for documentation
- create_function(anp)[source]
Creates the function using the numpy or jax object given. This method must be overridden by the child class. :param anp: The numpy or jax object to use for the function
- Returns:
The created function
- initial_seed(x, data)[source]
Returns the initial seed parameters for the fit. The default is to return a list of ones for the parameters. This method can be overridden to return a different initial seed if something more intelligent is desired. :param coords: The coordinates to fit the function to :param data: The data to fit the function to
- Returns:
The initial seed parameters for the fit
- rescale_parameters(params, scale)[source]
Rescales the parameters of the function determined by the fit by the scales given for the x y and z axes. :param params: The parameters of the function determined by the fit :param scales: The scales for the x y and z axes
- Returns:
The rescaled fit parameters
- class atomcloud.functions.funcs_1d.Function1DBase[source]
Bases:
FunctionBaseSee FunctionBase for documentation
- analyze_parameters(params)[source]
Analyzes the fit parameters of the function and returns a dictionary of the analysis parameters. :param params: The function parameters determined by the fit
- Returns:
A dictionary of the analysis parameters
- Parameters:
params (list[float]) –
- Return type:
dict
- default_bounds()[source]
Returns the default bounds for the fit. The default is to return (-np.inf, np.inf) for all parameters. This method can be overridden to return a different set of bounds if something more intelligent is desired. :returns: The default bounds for the fit
- initial_seed(x, data)[source]
Returns the initial seed parameters for the fit. The default is to return a list of ones for the parameters. This method can be overridden to return a different initial seed if something more intelligent is desired. :param coords: The coordinates to fit the function to :param data: The data to fit the function to
- Returns:
The initial seed parameters for the fit
- rescale_analysis_params(params, scales)[source]
Rescales the analysis parameters constructed from the fit parameters by the scales given for the x y and z axes. :param params: The analysis parameters constructed from the fit parameters :param scales: The scales for the x y and z axes
- Returns:
The rescaled analysis parameters
- Parameters:
params (dict) –
scales (list) –
- Return type:
dict
- rescale_parameters(params, scale)[source]
Rescales the parameters of the function determined by the fit by the scales given for the x y and z axes. :param params: The parameters of the function determined by the fit :param scales: The scales for the x y and z axes
- Returns:
The rescaled fit parameters
- class atomcloud.functions.funcs_1d.Gaussian1D[source]
Bases:
Function1DBaseSee FunctionBase for documentation
- class atomcloud.functions.funcs_1d.Parabola1D[source]
Bases:
Function1DBaseSee FunctionBase for documentation
- class atomcloud.functions.funcs_1d.ThomasFermi1D[source]
Bases:
Parabola1DSee FunctionBase for documentation