SensorImmersive

class ansys.speos.core.sensor.SensorImmersive(project, name, description='', metadata=None, sensor_instance=None, default_parameters=None)

Bases: BaseSensor

Sensor feature: Immersive.

An immersive sensor wraps the observer inside a cube and collects light from all six faces. By default, a sampling of 600 pixels per face, an integration angle of 5 degrees, a spectral range from 400 nm to 700 nm (sampling 13), no layer separation, and no face exclusions are chosen.

Parameters:

projectansys.speos.core.project.Project

Project that will own the feature.

namestr

Name of the feature.

descriptionstr

Description of the feature. By default, "".

metadataOptional[Mapping[str, str]]

Metadata of the feature. By default, {}.

sensor_instanceansys.api.speos.scene.v2.scene_pb2.Scene.SensorInstance, optional

Sensor 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.

default_parametersansys.speos.core.generic.parameters.ImmersiveSensorParameters, optional

If defined the values in the sensor instance will be overwritten by the values of the dataclass. By default, None.

Parameters:

• project (SensorImmersive.__init__.project)

• name (str)

• description (str)

• metadata (Optional[Mapping[str, str]])

• sensor_instance (Optional[ansys.speos.core.kernel.scene.ProtoScene.SensorInstance])

• default_parameters (Optional[ansys.speos.core.generic.parameters.ImmersiveSensorParameters])

Overview

Methods

set_wavelengths_range	Configure the wavelength range of the sensor.
set_layer_type_none	Set layer separation to None (no layer separation).
set_layer_type_source	Set layer separation to by source.

Properties

sampling	Pixel count (horizontal and vertical) per cube face.
integration_angle	Integration angle in degrees for direct simulations.
stereo_interocular_distance	Stereo interocular distance in mm.
exclude_front	Whether the front face is excluded.
exclude_back	Whether the back face is excluded.
exclude_left	Whether the left face is excluded.
exclude_right	Whether the right face is excluded.
exclude_top	Whether the top face is excluded.
exclude_bottom	Whether the bottom face is excluded.
axis_system	Position of the sensor.
layer	Current layer separation type.

Import detail

from ansys.speos.core.sensor import SensorImmersive

Property detail

property SensorImmersive.sampling: int

Pixel count (horizontal and vertical) per cube face.

Parameters:

valueint

Pixel count per face. By default, 600.

Returns:

int

Current sampling value.

property SensorImmersive.integration_angle: float

Integration angle in degrees for direct simulations.

Parameters:

valuefloat

Integration angle (degrees). By default, 5.0.

Returns:

float

Current integration angle.

property SensorImmersive.stereo_interocular_distance: float

Stereo interocular distance in mm.

Parameters:

valueNone | float

Set stereo interocular distance in mm. By default, None as deactivate the stereo setting. Or, set value to stereo interocular distance value will activate the stereo setting.

Returns:

float

Current stereo interocular distance in mm. If stereo setting is not activated, distance will be 0 mm.

property SensorImmersive.exclude_front: bool

Whether the front face is excluded.

Parameters:

valuebool

Returns:

bool

property SensorImmersive.exclude_back: bool

Whether the back face is excluded.

Parameters:

valuebool

Returns:

bool

property SensorImmersive.exclude_left: bool

Whether the left face is excluded.

Parameters:

valuebool

Returns:

bool

property SensorImmersive.exclude_right: bool

Whether the right face is excluded.

Parameters:

valuebool

Returns:

bool

property SensorImmersive.exclude_top: bool

Whether the top face is excluded.

Parameters:

valuebool

Returns:

bool

property SensorImmersive.exclude_bottom: bool

Whether the bottom face is excluded.

Parameters:

valuebool

Returns:

bool

property SensorImmersive.axis_system: list[float]

Position of the sensor.

Parameters:

valuelist[float]

Position [Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz]. X is Front, Y is Top, Z is Right. By default, [0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1].

Returns:

list[float]

Current axis system.

property SensorImmersive.layer: str | None

Current layer separation type.

Returns:

Union[str, None]

"none", "by_source", or None when not yet set.

Method detail

SensorImmersive.set_wavelengths_range()

Configure the wavelength range of the sensor.

Returns:

ansys.speos.core.sensor.BaseSensor.WavelengthsRange

Wavelength range object.

SensorImmersive.set_layer_type_none()

Set layer separation to None (no layer separation).

Returns:

ansys.speos.core.sensor.SensorImmersive

This immersive sensor.

SensorImmersive.set_layer_type_source()

Set layer separation to by source.

Returns:

ansys.speos.core.sensor.SensorImmersive

This immersive sensor.