xopto.materials.ri.util.model.herzberg module¶

class HerzbergerEx_3_2(params, pp: Optional[xopto.materials.ri.util.model.base.Scale] = None, **kwargs)[source]¶

Bases: xopto.materials.ri.util.model.base.Model

Extended herzberg 3x2 model of the refractive index.

$n = A + B\lambda^{2} + C\lambda^{4} + D/(\lambda^{2} - E) + F/(\lambda^{2} - G)^{2}$

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 HerzbergerEx_4_2(params, pp: Optional[xopto.materials.ri.util.model.base.Scale] = None, **kwargs)[source]¶

Bases: xopto.materials.ri.util.model.base.Model

Extended Herzberg 4x2 model of the refractive index.

$n = A + B\lambda^{2} + C\lambda^{4} + D\lambda^{6} + E/(\lambda^{2} - F) + G/(\lambda^{2} - H)^{2}$

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 Herzberger_3_2(params, pp: Optional[xopto.materials.ri.util.model.base.Scale] = None, **kwargs)[source]¶

Bases: xopto.materials.ri.util.model.base.Model

Herzberg 3x2 model of the refractive index.

$n = A + B\lambda^{2} + C\lambda^{4} + D/(\lambda^{2} - 0.028) + E/(\lambda^{2} - 0.028)^{2}$

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 Herzberger_4_2(params, pp: Optional[xopto.materials.ri.util.model.base.Scale] = None, **kwargs)[source]¶

Bases: xopto.materials.ri.util.model.base.Model

Herzberg 4x2 model of the refractive index.

$n = A + B\lambda^{2} + C\lambda^{4} + D\lambda^{6} + E/(\lambda^{2} - 0.028) + F/(\lambda^{2} - 0.028)^{2}$

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