InterpolationEnhancement

class ansys.speos.core.bsdf.InterpolationEnhancement(bsdf, bsdf_namespace, index_1=1.0, index_2=1.0)

Class to facilitate Specular interpolation enhancement.

Parameters:

bsdfUnion[ ansys.speos.core.bsdf.AnisotropicBSDF, ansys.speos.core.bsdf.SpectralBRDF],

BSDF type object to be interpolated.

bsdf_namespaceUnion[ ansys.api.speos.bsdf.v1.spectral_bsdf_pb2, ansys.api.speos.bsdf.v1.anisotropic_bsdf_pb2],

namespace for the methods.

index_1Optional[float],

index on reflection side.

index_2Optional[float],

index on transmission side.

Parameters:

• bsdf (Union[AnisotropicBSDF, SpectralBRDF])

• bsdf_namespace (Union[ansys.api.speos.bsdf.v1.spectral_bsdf_pb2, ansys.api.speos.bsdf.v1.anisotropic_bsdf_pb2])

• index_1 (Optional[float])

• index_2 (Optional[float])

Notes

Do not instantiate this class yourself

Overview

Methods

set_interpolation_settings

Set interpolation obtained from bsdf Class or that modified by user.

Properties

index1	Property of refractive index on reflection side.
index2	Refractive index on transmission side.
get_reflection_interpolation_settings	Return a fixed dictionary for reflection interpolation settings to be set by user.
get_transmission_interpolation_settings	Return a fixed dictionary for reflection interpolation settings to be set by user.

Import detail

from ansys.speos.core.bsdf import InterpolationEnhancement

Property detail

property InterpolationEnhancement.index1: float

Property of refractive index on reflection side.

Parameters:

valuerefractive index.

Refractive index on reflection side.

Returns:

float

Refractive index on reflection side.

property InterpolationEnhancement.index2: float

Refractive index on transmission side.

Parameters:

valuerefractive index.

Refractive index on transmission side.

Returns:

float

Refractive index on transmission side.

property InterpolationEnhancement.get_reflection_interpolation_settings: None | _InterpolationSettings

Return a fixed dictionary for reflection interpolation settings to be set by user.

Returns:

Union[None, ansys.speos.core.bsdf.InterpolationEnhancement._InterpolationSettings]

A fixed dictionary for reflection interpolation settings to be set by user.

property InterpolationEnhancement.get_transmission_interpolation_settings: None | _InterpolationSettings

Return a fixed dictionary for reflection interpolation settings to be set by user.

Returns:

Union[None, nsys.speos.core.bsdf.InterpolationEnhancement._InterpolationSettings]

A fixed dictionary for reflection interpolation settings to be set by user.

Method detail

InterpolationEnhancement.set_interpolation_settings(is_brdf, settings)

Set interpolation obtained from bsdf Class or that modified by user.

Parameters:

is_brdfbool

true if settings is for brdf, else for btdf

settingsnsys.speos.core.bsdf.InterpolationEnhancement._InterpolationSettings

interpolation settings to set.