`SimulationVirtualBSDF`#

class ansys.speos.core.simulation.SimulationVirtualBSDF(project, name, description='', metadata=None, simulation_instance=None, default_values=True)#

Bases: BaseSimulation

Type of simulation : Virtual BSDF Bench.

By default, geometry distance tolerance is set to 0.01, maximum number of impacts is set to 100, a colorimetric standard is set to CIE 1931, and weight’s minimum energy percentage is set to 0.005.

Parameters:

projectansys.speos.core.project.Project: Project in which simulation shall be created.
namestr: Name of the simulation.
descriptionstr: Description of the Simulation. By default, "".
metadataOptional[Mapping[str, str]]: Metadata of the feature. By default, {}.
simulation_instanceansys.api.speos.scene.v2.scene_pb2.Scene.SimulationInstance, optional: Simulation instance to provide if the feature does not have to be created from scratch By default, None, means that the feature is created from scratch by default.
default_valuesbool: Uses default values when True.

Parameters:

project (SimulationVirtualBSDF.__init__.project)
name (str)
description (str)
metadata (Optional[Mapping[str, str]])
simulation_instance (Optional[ansys.speos.core.kernel.scene.ProtoScene.SimulationInstance])
default_values (bool)

Overview#

Abstract methods

`set_sensor_paths`	Disabled - Setting sensor paths is not available for this simulation type.
`set_source_paths`	Disabled - Setting source paths is not available for this simulation type.

Methods

`set_weight`	Activate weight. Highly recommended to fill.
`set_weight_none`	Deactivate weight.
`set_colorimetric_standard_CIE_1931`	Set the colorimetric standard to CIE 1931.
`set_colorimetric_standard_CIE_1964`	Set the colorimetric standard to CIE 1964.
`set_mode_roughness_only`	Set BSDF depends on surface roughness only.
`set_mode_all_characteristics`	Set BSDF depends on all properties.
`set_wavelengths_range`	Set the range of wavelengths.
`set_sensor_sampling_uniform`	Set sensor sampling uniform.
`set_sensor_sampling_automatic`	Set sensor sampling automatic.

Properties

`integration_angle`	Sensor integration angle.
`axis_system`	Axis system of the bsdf bench.
`analysis_x_ratio`	Analysis x ratio.
`analysis_y_ratio`	Analysis y ratio.
`stop_condition_ray_number`	Stop condition as ray number.

Import detail#

from ansys.speos.core.simulation import SimulationVirtualBSDF

Property detail#

property SimulationVirtualBSDF.integration_angle: float#

Sensor integration angle.

This property gets or sets the sensor integration angle used by the virtual BSDF bench simulation.

Parameters:

anglefloat: The sensor integration angle to assign.

Returns:

float: The current sensor integration angle.

property SimulationVirtualBSDF.axis_system: List[float]#

Axis system of the bsdf bench.

This property gets or sets the axis system used by the virtual BSDF bench simulation.

Parameters:

valueList[float]: The axis coordinate system to assign.

Returns:

List[float]: The axis system of the bsdf bench.

property SimulationVirtualBSDF.analysis_x_ratio: float#

Analysis x ratio.

This property gets or sets the analysis ratio in range [0., 100.] in x direction used by the virtual BSDF bench simulation

Parameters:

value: float: The analysis x ratio to assign.

Returns:

float: Ratio to reduce the analysis area following x

property SimulationVirtualBSDF.analysis_y_ratio: float#

Analysis y ratio.

This property gets or sets the analysis ratio in range [0., 100.] in y direction used by the virtual BSDF bench simulation

Parameters:

value: float: The analysis y ratio to assign.

Returns:

float: Ratio to reduce the analysis area following y

property SimulationVirtualBSDF.stop_condition_ray_number: int#

Stop condition as ray number.

This property gets or sets the ray number stop condition used by the virtual BSDF bench simulation.

Parameters:

value: int: The ray stop condition ray number to assign.

Returns:

int: The ray stop condition ray number.

Method detail#

abstract SimulationVirtualBSDF.set_sensor_paths(sensor_paths)#

Disabled - Setting sensor paths is not available for this simulation type.

This method is intentionally not supported in SimulationVirtualBSDF. It exists only to satisfy the interface defined in the base class and will always raise a NotImplementedError when called.

Parameters:

sensor_pathsList[str]: Ignored. Present only for compatibility with the base class.

Returns:

None: This method does not return anything. It always raises an exception.

Raises:

NotImplementedError: Always raised, since this method is disabled in this subclass.

abstract SimulationVirtualBSDF.set_source_paths(source_paths)#

Disabled - Setting source paths is not available for this simulation type.

This method is intentionally not supported in SimulationVirtualBSDF. It exists only to satisfy the interface defined in the base class and will always raise a NotImplementedError when called.

Parameters:

source_pathsList[str]: Ignored. Present only for compatibility with the base class.

Returns:

None: This method does not return anything. It always raises an exception.

Raises:

NotImplementedError: Always raised, since this method is disabled in this subclass.

SimulationVirtualBSDF.set_weight()#

Activate weight. Highly recommended to fill.

Returns:

ansys.speos.core.simulation.BaseSimulation.Weight: Weight

SimulationVirtualBSDF.set_weight_none()#

Deactivate weight.

Returns:

ansys.speos.core.simulation.SimulationVirtualBSDF: SimulationVirtualBSDF simulation

SimulationVirtualBSDF.set_colorimetric_standard_CIE_1931()#

Set the colorimetric standard to CIE 1931.

2 degrees CIE Standard Colorimetric Observer Data.

Returns:

ansys.speos.core.simulation.SimulationVirtualBSDF: SimulationVirtualBSDF simulation

SimulationVirtualBSDF.set_colorimetric_standard_CIE_1964()#

Set the colorimetric standard to CIE 1964.

10 degrees CIE Standard Colorimetric Observer Data.

Returns:

ansys.speos.core.simulation.SimulationVirtualBSDF: SimulationVirtualBSDF simulation

SimulationVirtualBSDF.set_mode_roughness_only()#

Set BSDF depends on surface roughness only.

Returns:

ansys.speos.core.simulation.SimulationVirtualBSDF.RoughnessOnly: roughness only settings

SimulationVirtualBSDF.set_mode_all_characteristics()#

Set BSDF depends on all properties.

Returns:

ansys.speos.core.simulation.SimulationVirtualBSDF.AllCharacteristics: all properties settings

SimulationVirtualBSDF.set_wavelengths_range()#

Set the range of wavelengths.

Returns:

ansys.speos.core.simulation.SimulationVirtualBSDF.WavelengthsRange: Wavelengths range settings for SimulationVirtualBSDF

SimulationVirtualBSDF.set_sensor_sampling_uniform()#

Set sensor sampling uniform.

Returns:

ansys.speos.core.simulation.SimulationVirtualBSDF.SensorUniform: uniform type of sensor settings

SimulationVirtualBSDF.set_sensor_sampling_automatic()#

Set sensor sampling automatic.

Returns:

ansys.speos.core.simulation.SimulationVirtualBSDF: SimulationVirtualBSDF simulation

Classes#

`RoughnessOnly`	Roughness only mode of BSDF bench measurement.
`AllCharacteristics`	BSDF depends on all properties mode of BSDF bench measurement.
`WavelengthsRange`	Range of wavelengths.
`SensorUniform`	BSDF bench sensor settings.

SimulationVirtualBSDF#

Overview#

Import detail#

Property detail#

Method detail#

Classes#

`SimulationVirtualBSDF`#