SpectralBRDF

class ansys.speos.core.bsdf.SpectralBRDF(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[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.
sanity_check	Verify BSDF data is correctly defined.
commit	Sent Data to gRPC interface.
save	Save a Speos anistropic bsdf.

Properties

wavelength

List of all Wavelength in BRDF.

Special methods

__str__

Create string representation of a BSDF.

Import detail

from ansys.speos.core.bsdf import SpectralBRDF

Property detail

property SpectralBRDF.wavelength

List of all Wavelength in BRDF.

Method detail

SpectralBRDF.get(key='')

Retrieve any information from the BSDF object.

Parameters:

keystr

Name of the property.

Returns:

property

Values/content of the associated property.

SpectralBRDF.__str__()

Create string representation of a BSDF.

SpectralBRDF.reset()

Reset BSDF data to what was stored in file.

SpectralBRDF.sanity_check(silent=True)

Verify BSDF data is correctly defined.

Parameters:

silentbool

If False Warnings will be raised else not, by Default True

Returns:

WarningInformationstr

Description of what data is missing or incorrect

SpectralBRDF.commit()

Sent Data to gRPC interface.

SpectralBRDF.save(file_path, commit=True)

Save a Speos anistropic bsdf.

Parameters:

file_pathUnion[Path, str]

Filepath to save bsdf

commitbool

commit data before saving

Returns:

Path

File location