`Photometric`#

class ansys.speos.core.sensor.SensorCamera.Photometric(mode_photometric, camera_props, default_parameters=None, 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: Camera photometric mode protobuf object to modify.
default_parametersOptional[ ansys.speos.core.generic.parameters.PhotometricCameraParameters] = None: If defined the values in the sensor instance will be overwritten by the values of the data class
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_parameters (Optional[ansys.speos.core.generic.parameters.PhotometricCameraParameters])
stable_ctr (bool)

Notes

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

Overview#

Methods

`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_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.

Properties

`acquisition_integration`	Value of the acquisition integration.
`acquisition_lag_time`	Value of the acquisition lag time.
`transmittance_file_uri`	Location of the transmittance file.
`gamma_correction`	Value used to apply the gamma correction.
`consider_diffraction_effects`	Whether to consider diffraction effects in the Camera Sensor.
`trajectory_file_uri`	Location of the trajectory file.

Import detail#

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

Property detail#

property Photometric.acquisition_integration: float#

Value of the acquisition integration.

Parameters:

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

Returns:

float: Acquisition integration value (s).

property Photometric.acquisition_lag_time: float#

Value of the acquisition lag time.

Parameters:

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

Returns:

float: Acquisition lag time value (s).

property Photometric.transmittance_file_uri: str#

Location of the transmittance file.

Parameters:

uriUnion[str, pathlib.Path]: Amount of light of the source that passes through the lens and reaches the sensor. The transmittance is expressed in a .spectrum file.

Returns:

str: Amount of light of the source that passes through the lens and reaches the sensor.

property Photometric.gamma_correction: float#

Value used to apply the gamma correction.

Parameters:

valuefloat: Gamma Correction value. By default, 2.2.

Returns:

float: Gamma Correction value

property Photometric.consider_diffraction_effects: bool#

Whether to consider diffraction effects in the Camera Sensor.

Parameters:

valuebool: Enable (True) or disable (False) diffraction effects. By default, False.

Returns:

bool: Whether diffraction effects are considered.

Notes

This feature is available in Speos 2026 R1 SP3 or later. Not all Distortion files do contain diffractive effects. You may get an RPC error on commit when using a distortion file that does not contain diffractive effects while having set this option to true.

property Photometric.trajectory_file_uri: str#

Location of the trajectory file.

Parameters: