pyOptiShared.Material.Material

class pyOptiShared.Material.Material(mat_name: str)

Material base class.

Parameters:: mat_name (str) – Material name.
Raises:: NotImplementedError – For methods that need to be implemented by a child class.

Methods

`eps`(wavelength)	This method returns the permittivity at particular wavelengths.
`eps_imag`(wavelength)	Returns the real part of the permmittivity values.
`eps_real`(wavelength)	Returns the real part of the permmittivity values.
`index`(wavelength)	This method returns the refractive index at particular wavelengths.
`index_imag`(wavelength)	Return the imaginary part of the index of refraction at a given wavelengths.
`index_real`(wavelength)	Return the real part of the index of refraction at a given wavelengths.

Attributes

`color`	The color of the material for eventual visualization purposes.
`name`	Material name.

eps(wavelength: float | list | ndarray) → ndarray

This method returns the permittivity at particular wavelengths.

Parameters:: wavelength (float | list[float] | numpy.ndarray) – A set of wavelength values to calculate the permittivity.
Returns:: Permittivity array for requested wavelength values.
Return type:: numpy.ndarray

eps_imag(wavelength: float | list | ndarray) → ndarray

Returns the real part of the permmittivity values.

Parameters:: wavelength (float | list | numpy.ndarray) – Wavelength values.
Returns:: imaginary values of permittivity at the particular wavelength values.
Return type:: float

eps_real(wavelength: float | list | ndarray) → ndarray

Returns the real part of the permmittivity values.

Parameters:: wavelength (float | list | numpy.ndarray) – Wavelength values.
Returns:: real values of permittivity at the particular wavelength values.
Return type:: numpy.ndarray

index(wavelength: float | list | ndarray) → ndarray

This method returns the refractive index at particular wavelengths.

Parameters:: wavelength (float | list[float] | numpy.ndarray) – A set of wavelength values to calculate the ref. index.
Returns:: Refractive index array for requested wavelength values.
Return type:: numpy.ndarray

index_imag(wavelength: float | list | ndarray) → ndarray

Return the imaginary part of the index of refraction at a given wavelengths.

Parameters:: wavelength (float | list | numpy.ndarray) – Wavelength values.
Returns:: The imaginary part of the refractive index.
Return type:: numpy.ndarray

index_real(wavelength: float | list | ndarray) → ndarray

Return the real part of the index of refraction at a given wavelengths.

Parameters:: wavelength (float | list | numpy.ndarray) – Wavelength values.
Returns:: The real part of the refractive index.
Return type:: numpy.ndarray

property color: The color of the material for eventual visualization purposes.