wpspecdev.MieDriver¶
- class wpspecdev.MieDriver(args)[source]¶
Compute the absorption, scattering, and extinction spectra of a sphere using Mie theory
- Variables
~MieDriver.radius (float) – the radius of the sphere
~MieDriver.number_of_wavelengths (int) – the number of wavelengths over which the cross sections / efficiencies will be computed
~MieDriver.wavelength_array (1 x number_of_wavelengths numpy array of floats) – the array of wavelengths in meters over which you will compute the spectra
~MieDriver._size_factor_array (1 x number_of_wavelengths numpy array of floats) – size factor of the sphere
~MieDriver._relative_refractive_index_array (1 x number_of_wavelengths numpy array of complex floats) – the array of refractive index values corresponding to wavelength_array
~MieDriver._medium_refractive_index (float) – the refractive index of the surrounding medium - assumed to be real and wavelength-independent
~MieDriver.q_scat (numpy array of floats) – the scattering efficiency as a function of wavelength
~MieDriver.q_ext (numpy array of floats) – the extenction efficiency as a function of wavelength
~MieDriver.q_abs (1 x number_of_wavelengths numpy array of floats) – the absorption efficiency as a function of wavelength
~MieDriver.c_scat (numpy array of floats) – the scattering cross section as a function of wavelength
~MieDriver.c_ext (numpy array of floats) – the extinction cross section as a function of wavelength
~MieDriver.c_abs (1 x number_of_wavelengths numpy array of floats) – the absorption efficiency as a function of wavelength
~MieDriver._max_coefficient_n (int) – the maximum coefficient to be computed in the Mie expansion
~MieDriver._n_array (1 x _max_coefficient_n array of ints) – array of indices for the terms in the Mie expansion
~MieDriver._an (_max_coefficient x number_of_wavelengths numpy array of complex floats) – the array of a coefficients in the Mie expansion
~MieDriver._bn (_max_coefficientx x number_of_wavelengths numpy array of complex floats) – the array of b coefficients in the Mie expansion
~MieDriver._cn (_max_coefficientx x number_of_wavelengths numpy array of complex floats) – the array of c coefficients in the Mie expansion
~MieDriver._dn (_max_coefficientx x number_of_wavelengths numpy array of complex floats) – the array of d coefficients in the Mie expansion
- Return type
None
Examples
>>> fill_in_with_actual_example!
Methods
__init__
(args)compute_hamiltonian
(N, h, drude_dictionary, ...)docstring goes here!
compute_spectrum
()Will prepare the attributes forcomputing q_ext, q_abs, q_scat, c_abs, c_ext, c_scat via computing the mie coefficients
insert_layer
(layer_number)insert an air layer between layer_number-1 and layer_number e.g.
material_Ag
(layer_number[, ...])material_Air
(layer_number)defines the refractive index layer of layer_number to be air assuming static refractive index of n = 1.0 + 0j
material_Al
(layer_number)material_Al2O3
(layer_number)material_AlN
(layer_number[, ...])material_Au
(layer_number[, ...])material_H2O
(layer_number)defines the refractive index layer of layer_number to be water assuming static refractive index of n = 1.33 + 0j
material_HfO2
(layer_number)material_Pb
(layer_number[, ...])material_Pt
(layer_number)material_Re
(layer_number[, ...])material_Rh
(layer_number)material_Ru
(layer_number)material_Si
(layer_number[, ...])material_SiO2
(layer_number)material_Ta2O5
(layer_number[, ...])material_TiN
(layer_number)material_TiO2
(layer_number)material_W
(layer_number[, wavelength_range, ...])material_from_file
(layer_number, file_name)material_polystyrene
(layer_number)material_static_refractive_index
(...)parse_input
(args)set_refractive_indicex_array
()once materials are specified, define the refractive_index_array values