Sensor3DIrradiance

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

Bases: BaseSensor

Sensor feature: 3D Irradiance.

By default, regarding inherent characteristics, a 3d irradiance sensor of type photometric and illuminance type planar is chosen, Reflection, Transmission, and Absorption measurements are activated. By default, regarding properties, no layer separation and no ray file generation 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 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.Irradiance3DSensorParameters, optional

If defined the values in the sensor instance will be overwritten by the values of the data class

Parameters:

• project (Sensor3DIrradiance.__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.Irradiance3DSensorParameters])

Overview

Methods

set_type_photometric	Set type photometric.
set_type_radiometric	Set type radiometric.
set_type_colorimetric	Set type colorimetric.
set_ray_file_type_none	Set no ray file generation.
set_ray_file_type_classic	Set ray file generation without polarization data.
set_ray_file_type_polarization	Set ray file generation with the polarization data for each ray.
set_ray_file_type_tm25	Set ray file generation: a .tm25ray file with polarization data for each ray.
set_ray_file_type_tm25_no_polarization	Set ray file generation: a .tm25ray file without polarization data.
set_layer_type_none	Define layer separation type as None.
set_layer_type_source	Define layer separation as by source.

Properties

type	Type of sensor.
colorimetric	Type of sensor.
photometric	Type of sensor.
radiometric	Type of sensor.
layer	Property containing all options in regard to the layer separation property.
visual_data	Property containing 3d irradiance sensor visualization data.
geometries	Geometry faces/bodies to be defined with 3D irradiance sensor.

Import detail

from ansys.speos.core.sensor import Sensor3DIrradiance

Property detail

property Sensor3DIrradiance.type: str

Type of sensor.

Returns:

str

Sensor type as string

property Sensor3DIrradiance.colorimetric: Colorimetric

Type of sensor.

Returns:

Colorimetric

instance of the Colorimetric class

property Sensor3DIrradiance.photometric: Photometric

Type of sensor.

Returns:

Photometric

instance of the Photometric class

property Sensor3DIrradiance.radiometric: Radiometric

Type of sensor.

Returns:

Radiometric

instance of the Radiometric class

property Sensor3DIrradiance.layer: str | BaseSensor | BaseSensor

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

Returns:

Union[str, BaseSensor.LayerTypeFace, BaseSensor.LayerTypeSequence]

Layer type used

property Sensor3DIrradiance.visual_data: ansys.speos.core.generic.visualization_methods._VisualData

Property containing 3d irradiance sensor visualization data.

Returns:

ansys.speos.core.generic.visualization_methods._VisualData

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

property Sensor3DIrradiance.geometries: List[str]

Geometry faces/bodies to be defined with 3D irradiance sensor.

Parameters:

geometriesList[Union[ ansys.speos.core.geo_ref.GeoRef, ansys.speos.core.body.Body, ansys.speos.core.face.Face, ansys.speos.core.part.Part.SubPart]]

List of geometries that will be considered as Sensor

Returns:

List[str]

List of geometries that will be considered as Sensor

Method detail

Sensor3DIrradiance.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.Sensor3DIrradiance.Photometric

3D Irradiance sensor.

Sensor3DIrradiance.set_type_radiometric()

Set type radiometric.

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

Returns:

ansys.speos.core.sensor.Sensor3DIrradiance.Radiometric

3D Irradiance sensor

Sensor3DIrradiance.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.Sensor3DIrradiance.Colorimetric

Colorimetric type.

Sensor3DIrradiance.set_ray_file_type_none()

Set no ray file generation.

Returns:

ansys.speos.core.sensor.Sensor3DIrradiance

3D Irradiance sensor

Sensor3DIrradiance.set_ray_file_type_classic()

Set ray file generation without polarization data.

Returns:

ansys.speos.core.sensor.Sensor3DIrradiance

3D Irradiance sensor

Sensor3DIrradiance.set_ray_file_type_polarization()

Set ray file generation with the polarization data for each ray.

Returns:

ansys.speos.core.sensor.Sensor3DIrradiance

3D Irradiance sensor

Sensor3DIrradiance.set_ray_file_type_tm25()

Set ray file generation: a .tm25ray file with polarization data for each ray.

Returns:

ansys.speos.core.sensor.Sensor3DIrradiance

3D Irradiance sensor

Sensor3DIrradiance.set_ray_file_type_tm25_no_polarization()

Set ray file generation: a .tm25ray file without polarization data.

Returns:

ansys.speos.core.sensor.Sensor3DIrradiance

3D Irradiance sensor

Sensor3DIrradiance.set_layer_type_none()

Define layer separation type as None.

Returns:

ansys.speos.core.sensor.Sensor3DIrradiance

3D Irradiance sensor

Sensor3DIrradiance.set_layer_type_source()

Define layer separation as by source.

Returns:

ansys.speos.core.sensor.Sensor3DIrradiance

3D Irradiance sensor

Classes

Radiometric	Class computing the radiant intensity (in W.sr-1).
Photometric	Class computing the luminous intensity (in cd).
Measures	Measures settings of 3D irradiance sensor : Additional Measures.
Colorimetric	Class computing the color results.