xopto.materials.ri.util.model.conrady module¶
- class ConradyEx_1(params, pp: Optional[xopto.materials.ri.util.model.base.Scale] = None, **kwargs)[source]¶
Bases:
xopto.materials.ri.util.model.base.Model
Extended Conrady 1 model of the refractive index.
- Parameters
params (np.ndarray) – Default model parameters.
pp (xopto.materials.ri.util.model.base.Scale or xopto.materials.ri.util.model.base.Normalize) – Wavelength preprocessor instance.
kwargs (dict) – Parameters passed to the baseclass.
- guess(wavelengths: numpy.ndarray, n: numpy.ndarray) → list[source]¶
Returns an initial guess of the model parameters for optimization/fit.
- Parameters
wavelengths (np.ndarray) – The wavelengths of light at which the values of refractive index are defined.
n (np.ndarray) – The values of refractive index at the given wavelengths of light.
- Returns
params0 – Initial guess for the values of the model parameters
- Return type
np.ndarray
- ri(params: numpy.ndarray, wavelengths: numpy.ndarray)[source]¶
Compute the refractive index for the given model parameters and wavelengths of light.
- Parameters
params (np.ndarray) – Model parameters.
wavelengths (np.ndarray) – Wavelengths of light (m).
- Returns
n – Refractive index estimated for the given model parameters and at the given wavelengths of light.
- Return type
np.ndarray
- class ConradyEx_2(params, pp: Optional[xopto.materials.ri.util.model.base.Scale] = None, **kwargs)[source]¶
Bases:
xopto.materials.ri.util.model.base.Model
Extended Conrady 2 model of the refractive index.
- Parameters
params (np.ndarray) – Default model parameters.
pp (xopto.materials.ri.util.model.base.Scale or xopto.materials.ri.util.model.base.Normalize) – Wavelength preprocessor instance.
kwargs (dict) – Parameters passed to the baseclass.
- guess(wavelengths: numpy.ndarray, n: numpy.ndarray) → list[source]¶
Returns an initial guess of the model parameters for optimization/fit.
- Parameters
wavelengths (np.ndarray) – The wavelengths of light at which the values of refractive index are defined.
n (np.ndarray) – The values of refractive index at the given wavelengths of light.
- Returns
params0 – Initial guess for the values of the model parameters
- Return type
np.ndarray
- ri(params: numpy.ndarray, wavelengths: numpy.ndarray)[source]¶
Compute the refractive index for the given model parameters and wavelengths of light.
- Parameters
params (np.ndarray) – Model parameters.
wavelengths (np.ndarray) – Wavelengths of light (m).
- Returns
n – Refractive index estimated for the given model parameters and at the given wavelengths of light.
- Return type
np.ndarray
- class Conrady_1(params, pp: Optional[xopto.materials.ri.util.model.base.Scale] = None, **kwargs)[source]¶
Bases:
xopto.materials.ri.util.model.base.Model
Conrady 1 model of the refractive index.
- Parameters
params (np.ndarray) – Default model parameters.
pp (xopto.materials.ri.util.model.base.Scale or xopto.materials.ri.util.model.base.Normalize) – Wavelength preprocessor instance.
kwargs (dict) – Parameters passed to the baseclass.
- guess(wavelengths: numpy.ndarray, n: numpy.ndarray) → list[source]¶
Returns an initial guess of the model parameters for optimization/fit.
- Parameters
wavelengths (np.ndarray) – The wavelengths of light at which the values of refractive index are defined.
n (np.ndarray) – The values of refractive index at the given wavelengths of light.
- Returns
params0 – Initial guess for the values of the model parameters
- Return type
np.ndarray
- ri(params: numpy.ndarray, wavelengths: numpy.ndarray)[source]¶
Compute the refractive index for the given model parameters and wavelengths of light.
- Parameters
params (np.ndarray) – Model parameters.
wavelengths (np.ndarray) – Wavelengths of light (m).
- Returns
n – Refractive index estimated for the given model parameters and at the given wavelengths of light.
- Return type
np.ndarray
- class Conrady_2(params, pp: Optional[xopto.materials.ri.util.model.base.Scale] = None, **kwargs)[source]¶
Bases:
xopto.materials.ri.util.model.base.Model
Conrady 2 model of the refractive index.
- Parameters
params (np.ndarray) – Default model parameters.
pp (xopto.materials.ri.util.model.base.Scale or xopto.materials.ri.util.model.base.Normalize) – Wavelength preprocessor instance.
kwargs (dict) – Parameters passed to the baseclass.
- guess(wavelengths: numpy.ndarray, n: numpy.ndarray) → list[source]¶
Returns an initial guess of the model parameters for optimization/fit.
- Parameters
wavelengths (np.ndarray) – The wavelengths of light at which the values of refractive index are defined.
n (np.ndarray) – The values of refractive index at the given wavelengths of light.
- Returns
params0 – Initial guess for the values of the model parameters
- Return type
np.ndarray
- ri(params: numpy.ndarray, wavelengths: numpy.ndarray)[source]¶
Compute the refractive index for the given model parameters and wavelengths of light.
- Parameters
params (np.ndarray) – Model parameters.
wavelengths (np.ndarray) – Wavelengths of light (m).
- Returns
n – Refractive index estimated for the given model parameters and at the given wavelengths of light.
- Return type
np.ndarray