`SensorRadiance`#

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

Bases: BaseSensor

Sensor feature: Radiance.

By default, regarding inherent characteristics, a radiance sensor of type photometric is chosen. By default, regarding properties, an axis system is selected to position the sensor and no layer separation is 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 has to be created from scratch By default, None, means that the feature is created from scratch by default.
default_parametersansys.speos.core.generic.parameters.RadianceSensorParameters, optional: If defined the values in the sensor instance will be overwritten by the values of the data class

Parameters:

project (SensorRadiance.__init__.project)
name (str)
description (str)
metadata (Optional[Mapping[str, str]])
sensor_instance (Optional[ansys.speos.core.kernel.scene.ProtoScene.SensorInstance])
default_parameters (Union[None, ansys.speos.core.generic.parameters.RadianceSensorParameters])

Overview#

Methods

`set_dimensions`	Set the dimensions of the sensor.
`set_type_photometric`	Set type photometric.
`set_type_colorimetric`	Set type colorimetric.
`set_type_radiometric`	Set type radiometric.
`set_type_spectral`	Set type spectral.
`set_layer_type_none`	Define layer separation type as None.
`set_layer_type_source`	Define layer separation as by source.
`set_layer_type_face`	Define layer separation as by face.
`set_layer_type_sequence`	Define layer separation as by sequence.

Properties

`visual_data`	Property containing radiance sensor visualization data.
`dimensions`	Property containing all options in regard to the Dimensions sensor properties.
`type`	Type of sensor.
`colorimetric`	Property containing all options in regard to the Colorimetric sensor properties.
`spectral`	Property containing all options in regard to the Spectral sensor properties.
`layer`	Property containing all options in regard to the layer separation property.
`focal`	Focal value of the Radiance Sensor.
`integration_angle`	Integration angle.
`axis_system`	Position of the sensor.
`observer_point`	The position of the observer point.

Import detail#

from ansys.speos.core.sensor import SensorRadiance

Property detail#

property SensorRadiance.visual_data: ansys.speos.core.generic.visualization_methods._VisualData#

Property containing radiance sensor visualization data.

Returns:

_VisualData: Instance of VisualData Class for pyvista.PolyData of feature faces, coordinate_systems.

property SensorRadiance.dimensions: BaseSensor#

Property containing all options in regard to the Dimensions sensor properties.

Returns:

ansys.speos.core.sensor.BaseSensor.Dimensions: Instance of Dimensions Class for this sensor feature

property SensorRadiance.type: str#

Type of sensor.

Returns:

str: Sensor type as string

property SensorRadiance.colorimetric: None | BaseSensor#

Property containing all options in regard to the Colorimetric sensor properties.

Returns:

ansys.speos.core.sensor.BaseSensor.Colorimetric: Instance of Colorimetric Class for this sensor feature

property SensorRadiance.spectral: None | BaseSensor#

Property containing all options in regard to the Spectral sensor properties.

Returns:

ansys.speos.core.sensor.BaseSensor.Spectral: Instance of Spectral Class for this sensor feature

property SensorRadiance.layer: None | BaseSensor | BaseSensor#

Property containing all options in regard to the layer separation property.

Returns:

Union[ None, ansys.speos.core.sensor.BaseSensor.LayerTypeFace, ansys.speos.core.sensor.BaseSensor.LayerTypeSequence ]: Instance of Layer type Class for this sensor feature

property SensorRadiance.focal: float#

Focal value of the Radiance Sensor.

Parameters:

valuefloat: Focal (mm). By default, 250.

Returns:

float: Focal length of the sensor

property SensorRadiance.integration_angle: float#

Integration angle.

Parameters:

valuefloat: integration angle (degree). By default, 5.

Returns:

float: integration angle of the Radiance Sensor

property SensorRadiance.axis_system: list[float]#

Position of the sensor.

Parameters:

axis_systemlist[float]: Position of the sensor [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]: Position of the sensor [Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz].

property SensorRadiance.observer_point: SensorRadiance#

The position of the observer point.

This is optional, because the focal length is used by default. Choosing to set an observer point will make the focal length ignored.

Parameters:

valuelist[float]: Position of the observer point [Ox Oy Oz]. By default, None. None means that the focal length is used.

Returns:

Union[None, list[float]]: Position of the observer point [Ox Oy Oz], None means that the focal length is used.

Method detail#

SensorRadiance.set_dimensions()#

Set the dimensions of the sensor.

Returns:

ansys.speos.core.sensor.BaseSensor.Dimensions: Dimension class

SensorRadiance.set_type_photometric()#

Set type photometric.

The sensor considers the visible spectrum and gets the results in lm/m2 or lx.

Returns:

ansys.speos.core.sensor.SensorRadiance: Radiance sensor.

SensorRadiance.set_type_colorimetric()#

Set type colorimetric.

The sensor will generate color results without any spectral data or layer separation in lx or W//m2.

Returns:

ansys.speos.core.sensor.BaseSensor.Colorimetric: Colorimetric type.

SensorRadiance.set_type_radiometric()#

Set type radiometric.

The sensor considers the entire spectrum and gets the results in W/m2.

Returns:

ansys.speos.core.sensor.SensorRadiance: Radiance sensor.

SensorRadiance.set_type_spectral()#

Set type spectral.

The sensor will generate color results and spectral data separated by wavelength in lx or W/m2.

Returns:

ansys.speos.core.sensor.BaseSensor.Spectral: Spectral type.

SensorRadiance.set_layer_type_none()#

Define layer separation type as None.

Returns:

ansys.speos.core.sensor.SensorRadiance: Radiance sensor

SensorRadiance.set_layer_type_source()#

Define layer separation as by source.

Returns:

ansys.speos.core.sensor.SensorRadiance: Radiance sensor

SensorRadiance.set_layer_type_face()#

Define layer separation as by face.

Returns:

ansys.speos.core.sensor.BaseSensor.LayerTypeFace: LayerTypeFace property instance

SensorRadiance.set_layer_type_sequence()#

Define layer separation as by sequence.

Returns:

ansys.speos.core.sensor.BaseSensor.LayerTypeSequence: LayerTypeSequence property instance