AnisotropicBSDF

class ansys.speos.core.bsdf.AnisotropicBSDF(speos, file_path=None)

Bases: BaseBSDF

BSDF - Bidirectional scattering distribution function.

This class contains the methods and functions to load and edit existing Speos bsdf datasets.

Parameters:

speosansys.speos.core.speos.Speos

Speos Object to connect to speos rpc server

file_pathUnion[pathlib.Path, str]

File path to bsdf file

Parameters:

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

• file_path (Union[pathlib.Path, str])

Overview

Methods

get	Retrieve any information from the BSDF object.
reset	Reset BSDF data to what was stored in file.
commit	Sent Data to gRPC interface.
save	Save a Speos anistropic bsdf.

Properties

anisotropic_angles	Anisotropic angles available in bsdf data.
spectrum_incidence	Incident angle (theta) of spectrum measurement.
spectrum_anisotropy	Incident angle (phi) of spectrum measurement.
reflection_spectrum	Reflection Spectrum of the bsdf.
transmission_spectrum	Transmission Spectrum of the bsdf.

Special methods

__str__

Create string representation of a BSDF.

Import detail

from ansys.speos.core.bsdf import AnisotropicBSDF

Property detail

property AnisotropicBSDF.anisotropic_angles: List[List[float]]

Anisotropic angles available in bsdf data.

Returns:

List[List[float]]

List of anisotropic angles.

property AnisotropicBSDF.spectrum_incidence: List[float] | float

Incident angle (theta) of spectrum measurement.

Parameters:

valueUnion[List[float], float]

First value is for reflection second for transmission

Returns:

Union[List[float], float]

First value is for reflection second for transmission

property AnisotropicBSDF.spectrum_anisotropy: List[float] | float

Incident angle (phi) of spectrum measurement.

Parameters:

valueUnion[List[float], float]

First value is for reflection second for transmission.

Returns:

Union[List[float], float]

First value is for reflection second for transmission

property AnisotropicBSDF.reflection_spectrum

Reflection Spectrum of the bsdf.

Parameters:

valueList[Collection[float], Collection[float]]

The spectrum is used to modulate the bsdf

Returns:

List[Collection[float], Collection[float]]

The spectrum is used to modulate the bsdf.

property AnisotropicBSDF.transmission_spectrum

Transmission Spectrum of the bsdf.

Parameters:

valueList[Collection[float], Collection[float]]

The spectrum is used to modulate the bsdf

Returns:

List[Collection[float], Collection[float]]

The spectrum is used to modulate the bsdf.

Method detail

AnisotropicBSDF.get(key='')

Retrieve any information from the BSDF object.

Parameters:

keystr

Name of the property.

Returns:

property

Values/content of the associated property.

AnisotropicBSDF.__str__()

Create string representation of a BSDF.

AnisotropicBSDF.reset()

Reset BSDF data to what was stored in file.

AnisotropicBSDF.commit()

Sent Data to gRPC interface.

AnisotropicBSDF.save(file_path, commit=True)

Save a Speos anistropic bsdf.

Parameters:

file_pathUnion[pathlib.Path, str]

Filepath to save bsdf

commitbool

commit data before saving

Returns:

pathlib.Path

File location