SensorObserver

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

Bases: BaseSensor

Sensor feature: Observer.

An observer sensor places multiple sensor instances on a sphere around a focal point, configured by angular ranges and optional stereo parameters. By default, a focal length of 250mm, integration angle of 5 degrees, a spectral range from 400nm to 700nm (sampling 13), sphere distance of 100mm, and horizontal angular range from -45 to 45 degrees with 5 sampling, vertical range from -30 to 30 degrees with 3 sampling 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.ObserverSensorParameters, optional

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

Parameters:

• project (SensorObserver.__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.ObserverSensorParameters])

Overview

Methods

set_wavelengths_range	Configure the wavelength range of the sensor.
set_dimensions	Set the dimensions of the sensor.
set_angular_range	Configure the angular range for sensor locations on the sphere.
set_layer_type_none	Define layer separation type as None.
set_layer_type_source	Define layer separation as by source.

Properties

focal	Focal distance (distance between sensor radiance plan and observer point).
integration_angle	Integration angle in degrees for direct simulations.
distance	Distance (radius of sphere on which sensors are placed).
stereo_interocular_distance	Stereo interocular distance in mm.
axis_system	Position of the sensor.
layer	Current layer separation type.

Import detail

from ansys.speos.core.sensor import SensorObserver

Property detail

property SensorObserver.focal: float

Focal distance (distance between sensor radiance plan and observer point).

Parameters:

valuefloat

Focal length in mm. By default, 250.0.

Returns:

float

Current focal distance.

property SensorObserver.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 SensorObserver.distance: float

Distance (radius of sphere on which sensors are placed).

Parameters:

valuefloat

Sphere radius in mm. By default, 100.0.

Returns:

float

Current distance value.

property SensorObserver.stereo_interocular_distance: float | None

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:

Union[float, None]

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

property SensorObserver.axis_system: list[float]

Position of the sensor.

Whereas Horizontal direction is represented by X-Component and vertical by Z-Component of the axis-system

Parameters:

valuelist[float]

Position [Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz]. By default, [0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1].

Returns:

list[float]

Current axis system.

property SensorObserver.layer: str | None

Current layer separation type.

Returns:

Union[str, None]

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

Method detail

SensorObserver.set_wavelengths_range()

Configure the wavelength range of the sensor.

Returns:

ansys.speos.core.sensor.BaseSensor.WavelengthsRange

Wavelength range object.

SensorObserver.set_dimensions()

Set the dimensions of the sensor.

Returns:

ansys.speos.core.sensor.BaseSensor.Dimensions

Dimension class

SensorObserver.set_angular_range()

Configure the angular range for sensor locations on the sphere.

Returns:

ansys.speos.core.sensor.BaseSensor.AngularRange

Angular range object.

SensorObserver.set_layer_type_none()

Define layer separation type as None.

Returns:

ansys.speos.core.sensor.SensorIrradiance

irradiance class instance

SensorObserver.set_layer_type_source()

Define layer separation as by source.

Returns:

ansys.speos.core.sensor.SensorIrradiance

irradiance class instance