SellmeierZemax

class gwcs.spectroscopy.SellmeierZemax(temperature=Parameter('temperature', value=0.0), ref_temperature=Parameter('ref_temperature', value=0.0), ref_pressure=Parameter('ref_pressure', value=0.0), pressure=Parameter('pressure', value=0.0), B_coef=Parameter('B_coef', value=[1. 1. 1.]), C_coef=Parameter('C_coef', value=[0. 0. 0.]), D_coef=Parameter('D_coef', value=[0. 0. 0.]), E_coef=Parameter('E_coef', value=[1. 1. 1.]), **kwargs)[source]

Bases: Model

Sellmeier equation used by Zemax.

Parameters:
temperaturefloat

Temperature of the material in u.Kelvin.

ref_temperaturefloat

Reference emperature of the glass in u.Kelvin.

ref_pressurefloat

Reference pressure in ATM.

pressurefloat

Measured pressure in ATM.

B_coefndarray

Iterable of size 3 containing B coefficients.

C_coefndarray

Iterable of size 3 containing C coefficients in units of u.um**2.

D_coefndarray

Iterable of size 3 containing constants to describe the behavior of the material.

E_coefndarray

Iterable of size 3 containing constants to describe the behavior of the material.

Returns:
nfloat

Refractive index.

Attributes Summary

B_coef

C_coef

D_coef

E_coef

linear

n_inputs

The number of inputs.

n_outputs

The number of outputs.

param_names

Names of the parameters that describe models of this type.

pressure

ref_pressure

ref_temperature

standard_broadcasting

temperature

Methods Summary

__call__(*inputs[, model_set_axis, ...])

Evaluate this model using the given input(s) and the parameter values that were specified when the model was instantiated.

evaluate(wavelength, temp, ref_temp, ...)

Input wavelength is in units of microns.

Attributes Documentation

B_coef = Parameter('B_coef', value=[1. 1. 1.])
C_coef = Parameter('C_coef', value=[0. 0. 0.])
D_coef = Parameter('D_coef', value=[0. 0. 0.])
E_coef = Parameter('E_coef', value=[1. 1. 1.])
linear = False
n_inputs = 1

The number of inputs.

n_outputs = 1

The number of outputs.

param_names = ('temperature', 'ref_temperature', 'ref_pressure', 'pressure', 'B_coef', 'C_coef', 'D_coef', 'E_coef')

Names of the parameters that describe models of this type.

The parameters in this tuple are in the same order they should be passed in when initializing a model of a specific type. Some types of models, such as polynomial models, have a different number of parameters depending on some other property of the model, such as the degree.

When defining a custom model class the value of this attribute is automatically set by the Parameter attributes defined in the class body.

pressure = Parameter('pressure', value=0.0)
ref_pressure = Parameter('ref_pressure', value=0.0)
ref_temperature = Parameter('ref_temperature', value=0.0)
standard_broadcasting = False
temperature = Parameter('temperature', value=0.0)

Methods Documentation

__call__(*inputs, model_set_axis=None, with_bounding_box=False, fill_value=nan, equivalencies=None, inputs_map=None, **new_inputs)

Evaluate this model using the given input(s) and the parameter values that were specified when the model was instantiated.

evaluate(wavelength, temp, ref_temp, ref_pressure, pressure, B_coef, C_coef, D_coef, E_coef)[source]

Input wavelength is in units of microns.