ImmersiveSensorParameters

class ansys.speos.core.generic.parameters.ImmersiveSensorParameters

Parameters for SensorImmersive.

Parameters:

samplingint, optional

Horizontal and vertical number of pixels for a face. By default, 600.

integration_anglefloat, optional

Integration angle in degrees for direct simulations. By default, 5.0.

wavelengths_rangeansys.speos.core.generic.parameters.WavelengthsRangeParameters, optional

Spectral range to use for simulation. By default, a range from 400nm to 700nm with sampling of 13.

axis_systemlist[float], optional

Position of the sensor (Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz). X corresponds to Front direction. Y corresponds to Top direction. By default, [0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1].

layer_typeUnion[LayerTypes.none, LayerTypes.by_source], optional

Layer separation type. By default, LayerTypes.none.

exclude_frontbool, optional

Exclude front face. By default, False.

exclude_backbool, optional

Exclude back face. By default, False.

exclude_leftbool, optional

Exclude left face. By default, False.

exclude_rightbool, optional

Exclude right face. By default, False.

exclude_topbool, optional

Exclude top face. By default, False.

exclude_bottombool, optional

Exclude bottom face. By default, False.

interocular_distancefloat, optional

Distance between the left and right eyes, in millimeters. By default, None.

Overview

Attributes

sampling	Horizontal and vertical pixel count per face.
integration_angle	Integration angle in degrees.
wavelengths_range	Spectral range.
axis_system	Position of the sensor.
layer_type	Layer separation type.
exclude_front	Exclude front face.
exclude_back	Exclude back face.
exclude_left	Exclude left face.
exclude_right	Exclude right face.
exclude_top	Exclude top face.
exclude_bottom	Exclude bottom face.
interocular_distance	Distance between viewpoints in mm.

Import detail

from ansys.speos.core.generic.parameters import ImmersiveSensorParameters

Attribute detail

ImmersiveSensorParameters.sampling: int = 600

Horizontal and vertical pixel count per face.

ImmersiveSensorParameters.integration_angle: float = 5.0

Integration angle in degrees.

ImmersiveSensorParameters.wavelengths_range: WavelengthsRangeParameters

Spectral range.

ImmersiveSensorParameters.axis_system: list[float] = [0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1]

Position of the sensor.

ImmersiveSensorParameters.layer_type: LayerTypes

Layer separation type.

ImmersiveSensorParameters.exclude_front: bool = False

Exclude front face.

ImmersiveSensorParameters.exclude_back: bool = False

Exclude back face.

ImmersiveSensorParameters.exclude_left: bool = False

Exclude left face.

ImmersiveSensorParameters.exclude_right: bool = False

Exclude right face.

ImmersiveSensorParameters.exclude_top: bool = False

Exclude top face.

ImmersiveSensorParameters.exclude_bottom: bool = False

Exclude bottom face.

ImmersiveSensorParameters.interocular_distance: float | None = None

Distance between viewpoints in mm.