The bsdf.py module

Summary

Classes

BaseBSDF	Super class for all BSDF datamodels.
InterpolationEnhancement	Class to facilitate Specular interpolation enhancement.
AnisotropicBSDF	BSDF - Bidirectional scattering distribution function.
SpectralBRDF	BSDF - Bidirectional scattering distribution function.
BxdfDatapoint	Class to store a BxDF data point.

Functions

create_bsdf180	Create a bsdf180 from 2 bsdf.
create_spectral_brdf	Create a brdf from multiple bsdf.
create_anisotropic_bsdf	Create an anisotropic bsdf from anisotropic bsdf files.

Description

Provides a way to interact with Speos BSDF file.

Module detail

bsdf.create_bsdf180(speos, bsdf180_file_path, path_normal_bsdf, path_opposite_bsdf)

Create a bsdf180 from 2 bsdf.

This function allows to create BSDF180 from 2 bsdf files allowed files: *.coated *.brdf *.anisotropicbsdf *.scattering

Parameters:

speosansys.speos.core.Speos

Speos Object to connect to RPC server

bsdf180_file_pathUnion[str, Path]

File location of created bsdf180

path_normal_bsdfUnion[str, Path]

File location of first file, which represent normal direction Allowed files: *.coated, *.brdf, *.anisotropicbsdf, *.scattering

path_opposite_bsdfUnion[str, Path]

File location of first file, which represent anti-normal direction Allowed files: *.coated, *.brdf, *.anisotropicbsdf, *.scattering

fix_disparitybool

This allows to create a bsdf when the two files are not normalized to each other. By default, False

Returns:

Path

Returns where the file location of the bsdf180

bsdf.create_spectral_brdf(speos, spectral_bsdf_file_path, wavelength_list, anisotropic_bsdf_file_list)

Create a brdf from multiple bsdf.

This function allows to create BRDF from multiple bsdf files allowed files: *.anisotropicbsdf

Parameters:

speosansys.speos.core.Speos

Speos Object to connect to RPC server

spectral_bsdf_file_pathUnion[str, Path]

File location of created BRDF file

wavelength_listlist[float]

List of wavelength

anisotropic_bsdf_file_listlist[Union[Path, str]]

list of bsdf file locations

Returns:

Path

Location of created BRDF

bsdf.create_anisotropic_bsdf(speos, anisotropic_bsdf_file_path, anisotropy_list, anisotropic_bsdf_file_list, fix_disparity=False)

Create an anisotropic bsdf from anisotropic bsdf files.

Parameters:

speosansys.speos.core.Speos

Speos Object to connect to RPC server

anisotropic_bsdf_file_pathUnion[str, Path]

File location of created Anisotropic BSDF file

anisotropy_listlist[float]

ordered List of anisotropy value, in radian

anisotropic_bsdf_file_listlist[Union[Path, str]]

list of bsdf file locations

fix_disparitybool

Fixes normalization disparity between BSDF, By default: False

Returns:

Path

Location of created Anisotropic BSDF files

Notes

Please note that the bsdf files from the bsdf list need to be isotropic.