Photometric

class ansys.speos.core.sensor.SensorCamera.Photometric(mode_photometric, camera_props, default_values=True, stable_ctr=False)

Mode of camera sensor : Photometric.

This allows to set every Camera Sensor parameters, including the photometric definition parameters. By default, a camera with mode color is chosen (vs monochromatic mode).

Parameters:

mode_photometricansys.api.speos.sensor.v1.camera_sensor_pb2.SensorCameraModePhotometric

SensorCameraModePhotometric protobuf object to modify.

default_valuesbool

Uses default values when True.

stable_ctrbool

Variable to indicate if usage is inside class scope

Parameters:

• mode_photometric (ansys.api.speos.sensor.v1.camera_sensor_pb2.SensorCameraModePhotometric)

• camera_props (ansys.speos.core.kernel.scene.ProtoScene.SensorInstance.CameraProperties)

• default_values (bool)

• stable_ctr (bool)

Notes

Do not instantiate this class yourself, use set_type_photometric method available in sensor classes.

Overview

Methods

set_acquisition_integration	Set the acquisition integration value.
set_acquisition_lag_time	Set the acquisition lag time value.
set_transmittance_file_uri	Set the transmittance file.
set_gamma_correction	Set the gamma correction.
set_png_bits_08	Choose 08-bits for png.
set_png_bits_10	Choose 10-bits for png.
set_png_bits_12	Choose 12-bits for png.
set_png_bits_16	Choose 16-bits for png.
set_wavelengths_range	Set the range of wavelengths.
set_mode_monochromatic	Set the monochromatic mode.
set_mode_color	Set the color mode.
set_trajectory_file_uri	Set the trajectory file.
set_layer_type_none	Set no layer separation: includes the simulation’s results in one layer.
set_layer_type_source	Set layer separation by source: includes one layer per active source in the result.

Import detail

from ansys.speos.core.sensor.SensorCamera import Photometric

Method detail

Photometric.set_acquisition_integration(value=0.01)

Set the acquisition integration value.

Parameters:

valuefloat

Acquisition integration value (s). By default, 0.01.

Returns:

ansys.speos.core.sensor.SensorCamera.Photometric

Photometric mode.

Photometric.set_acquisition_lag_time(value=0.0)

Set the acquisition lag time value.

Parameters:

valuefloat

Acquisition lag time value (s). By default, 0.0.

Returns:

ansys.speos.core.sensor.SensorCamera.Photometric

Photometric mode.

Photometric.set_transmittance_file_uri(uri)

Set the transmittance file.

Parameters:

uristr

Amount of light of the source that passes through the lens and reaches the sensor. The transmittance is expressed in a .spectrum file.

Returns:

ansys.speos.core.sensor.SensorCamera.Photometric

Photometric mode.

Photometric.set_gamma_correction(value=2.2)

Set the gamma correction.

Parameters:

valuefloat

Compensation of the curve before the display on the screen. By default, 2.2.

Returns:

ansys.speos.core.sensor.SensorCamera.Photometric

Photometric mode.

Photometric.set_png_bits_08()

Choose 08-bits for png.

Returns:

ansys.speos.core.sensor.SensorCamera.Photometric

Photometric mode.

Photometric.set_png_bits_10()

Choose 10-bits for png.

Returns:

ansys.speos.core.sensor.SensorCamera.Photometric

Photometric mode.

Photometric.set_png_bits_12()

Choose 12-bits for png.

Returns:

ansys.speos.core.sensor.SensorCamera.Photometric

Photometric mode.

Photometric.set_png_bits_16()

Choose 16-bits for png.

Returns:

ansys.speos.core.sensor.SensorCamera.Photometric

Photometric mode.

Photometric.set_wavelengths_range()

Set the range of wavelengths.

Returns:

ansys.speos.core.sensor.BaseSensor.WavelengthsRange

Wavelengths range.

Photometric.set_mode_monochromatic(spectrum_file_uri)

Set the monochromatic mode.

Results will be available in grey scale.

Parameters:

spectrum_file_uristr

Spectrum file uri.

Returns:

ansys.speos.core.sensor.SensorCamera.Photometric

Photometric mode.

Photometric.set_mode_color()

Set the color mode.

Results will be available in color.

Returns:

ansys.speos.core.sensor.SensorCamera.Photometric.Color

Color mode.

Photometric.set_trajectory_file_uri(uri)

Set the trajectory file.

Parameters:

uristr

Trajectory file, used to define the position and orientations of the Camera sensor in time.

Returns:

ansys.speos.core.sensor.SensorCamera.Photometric

Photometric mode.

Photometric.set_layer_type_none()

Set no layer separation: includes the simulation’s results in one layer.

Returns:

ansys.speos.core.sensor.SensorCamera.Photometric

Photometric mode.

Photometric.set_layer_type_source()

Set layer separation by source: includes one layer per active source in the result.

Returns:

ansys.speos.core.sensor.SensorCamera.Photometric

Photometric mode.

Classes

Color

Mode of camera sensor : Color.