The input_files package

Summary

Submodules

bsdf	Provides a way to interact with Speos BSDF file.
coated_surface	Provides the Speos *.coated input file format.
fluorescence	Models Speos fluorescent pigment files and pigment data in material files.
material	Provides the Speos *.material input file format.
ray_file	Provides the Speos *.ray input file format.
scattering_surface	Provides the Speos *.scattering input file format.
simple_scattering_surface	Provides the Speos *.simplescattering input file format.
spectrum_file	Provides the Speos *.spectrum input file format.
texture_3d	Provides a way to interact with the Speos 3D Texture mapping files.

Classes

SpeosFileFormat	Base class for the Speos input files that PySpeos reads and writes locally.
SpeosTextFileFormat	Base class for the line-oriented text formats of Speos.
AnisotropicBSDF	BSDF - Bidirectional scattering distribution function.
BaseBSDF	Super class for all BSDF datamodels.
BxdfDatapoint	Class to store a BxDF data point.
InterpolationEnhancement	Class to facilitate Specular interpolation enhancement.
SpectralBRDF	BSDF - Bidirectional scattering distribution function.
CoatedSurfaceFile	Speos *.coated file, a non-scattering coating varying with angle and wavelength.
CoatedSurfaceSample	Coating response at one angle of incidence and one wavelength.
FluorescentPigment	A dye entry in the fluorescence table of a material file.
FluorescentPigmentFile	Speos *.dye pigment, with sampled absorption and emission spectra.
MaterialBirefringentCurve	Refractive indices of a birefringent material along its three axes.
MaterialBirefringentKettlerHelmholtz	Dispersion of a birefringent material given by the Kettler-Helmholtz coefficients.
MaterialBirefringentSellmeier	Dispersion of a birefringent material given by the Sellmeier coefficients.
MaterialConstringence	Dispersion of a volume material given by its index and its Abbe number.
MaterialDispersionCurve	Dispersion of a volume material given by an explicit index curve.
MaterialFile	Speos *.material file, holding the volume optical properties of a body.
MaterialKettlerHelmholtz	Dispersion of a glass given by the Kettler-Helmholtz coefficients.
MaterialMetallicCurve	Dispersion of a metal given by its complex refractive index.
MaterialSellmeier	Dispersion of a volume material given by the Sellmeier coefficients.
VolumeScatteringDoubleHenyeyGreenstein	Double Henyey-Greenstein scattering phase function.
VolumeScatteringGegenbauer	Gegenbauer scattering phase function.
VolumeScatteringHenyeyGreenstein	Henyey-Greenstein scattering phase function.
VolumeScatteringUserDefined	Scattering phase function given as a scattering efficiency per angle.
Ray	Single ray of a Speos ray file.
RayFile	Speos ray file, holding the rays emitted by a measured or simulated source.
ScatteringSurfaceFile	Speos *.scattering file, a scattering surface varying with angle and wavelength.
ScatteringSurfaceSample	Scattering contributions of a surface at one angle of incidence and one wavelength.
SimpleScatteringSurfaceFile	Speos *.simplescattering file, a scattering surface with no spectral dependency.
SpectrumFile	Speos *.spectrum file, holding a sampled spectral distribution.
Texture3DMappingFile	Speos *.OPT3DMapping file, laying out the patterns of a 3D Texture.
TexturePattern	Placement of one pattern of a Speos 3D Texture.

Enums

MaterialOpticalClass	Classify a birefringent material as negative uniaxial, positive uniaxial, or biaxial.
MaterialType	Select the volume material flavor.
SimpleScatteringMode	Selects whether the surface scatters reflected light, transmitted light, or both.

Functions

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

Description

Speos input file formats and BSDF tools.

Most file-format classes in this package read and write files locally without a Speos gRPC connection. The BSDF models and builders are an exception: importing, exporting, editing, interpolating, and generating BSDF data requires a live Speos gRPC connection. Each module covers a file format or a related set of input-file operations.

Local file-format models use explicit constructors and properties that validate assignments before storing data. List properties return copied containers; nested model objects remain shared and editable through their setters. Empty collections support staged construction, while validate() and save() require complete data.

Use MaterialType to select the volume material model. Use MaterialOpticalClass to classify a birefringent material as negative uniaxial, positive uniaxial, or biaxial. Use FluorescentPigmentFile and FluorescentPigment to add dye data to a fluorescent material. Use SimpleScatteringMode to select which side of a surface scatters light.

Module detail