BaseBSDF

class ansys.speos.core.bsdf.BaseBSDF(speos, stub, namespace)

Super class for all BSDF datamodels.

Parameters:

speosansys.speos.core.speos.Speos

stub

grpc stub to connect to BSDF service

namespace

grpc namespace for the bsdf

Parameters:

speos (ansys.speos.core.speos.Speos)

Notes

This is a Super class, Do not instantiate this class yourself

Overview

Methods

create_interpolation_enhancement

Apply automatic interpolation enhancement.

Properties

has_transmission	Contains the BSDF Transmission data.
has_reflection	Contains the BSDF Reflection data.
brdf	List of BRDFDatapoints.
btdf	List of BTDFDatapoints.
nb_incidents	Number of incidence angle for reflection and transmission.
incident_angles	List of incident angles for reflection and transmission.
interpolation_settings	Interpolation enhancement settings of the bsdf file.

Attributes

client
anisotropy_vector
description

Import detail

from ansys.speos.core.bsdf import BaseBSDF

Property detail

property BaseBSDF.has_transmission: bool

Contains the BSDF Transmission data.

property BaseBSDF.has_reflection: bool

Contains the BSDF Reflection data.

property BaseBSDF.brdf: collections.abc.Collection[BxdfDatapoint]

List of BRDFDatapoints.

property BaseBSDF.btdf: collections.abc.Collection[BxdfDatapoint]

List of BTDFDatapoints.

property BaseBSDF.nb_incidents: list[int]

Number of incidence angle for reflection and transmission.

Returns:

list[int]:

first value of the list is nb of reflective data, second value is nb of transmittive data

property BaseBSDF.incident_angles: list[list[float] | None, list[float] | None]

List of incident angles for reflection and transmission.

Returns:

list[Union[list[float], None],Union[list[float], None]]

Returns a nested list of incidence angels for reflective and transmittive data if not available the value will be None

property BaseBSDF.interpolation_settings: None | InterpolationEnhancement

Interpolation enhancement settings of the bsdf file.

If bsdf file does not have interpolation enhancement settings, return None. if bsdf file has interpolation enhancement settings, return InterpolationEnhancement.

Attribute detail

BaseBSDF.client

BaseBSDF.anisotropy_vector = [1, 0, 0]

BaseBSDF.description = ''

Method detail

BaseBSDF.create_interpolation_enhancement(index_1=1.0, index_2=1.0)

Apply automatic interpolation enhancement.

Return interpolation settings to user if settings need change.

Parameters:

index_1float

outside refractive index

index_2float

inside refractive index

Returns:

ansys.speos.core.bsdf._InterpolationEnhancement

automatic interpolation settings with index_1 = 1 and index_2 = 1 by default.