`SensorIrradiance`#

class ansys.speos.core.sensor.SensorIrradiance(project, name, description='', metadata=None, sensor_instance=None, default_values=True)#

Bases: BaseSensor

Sensor feature: Irradiance.

By default, regarding inherent characteristics, an irradiance sensor of type photometric and illuminance type planar is chosen. By default, regarding properties, an axis system is selected to position the sensor, 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_valuesbool: Uses default values when True. By default, True.

Parameters:

project (SensorIrradiance.__init__.project)
name (str)
description (str)
metadata (Optional[Mapping[str, str]])
sensor_instance (Optional[ansys.speos.core.kernel.scene.ProtoScene.SensorInstance])
default_values (bool)

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_illuminance_type_planar`	Set illuminance type planar.
`set_illuminance_type_radial`	Set illuminance type radial.
`set_illuminance_type_hemispherical`	Set illuminance type hemispherical.
`set_illuminance_type_cylindrical`	Set illuminance type cylindrical.
`set_illuminance_type_semi_cylindrical`	Set illuminance type semi cylindrical.
`set_axis_system`	Set position of the sensor.
`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.
`set_layer_type_face`	Define layer separation as by face.
`set_layer_type_sequence`	Define layer separation as by sequence.
`set_layer_type_polarization`	Define layer separation as by polarization.
`set_layer_type_incidence_angle`	Define layer separation as by incidence angle.
`set_output_face_geometries`	Select output faces for inverse simulation optimization.

Properties

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

Import detail#

from ansys.speos.core.sensor import SensorIrradiance

Property detail#

property SensorIrradiance.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 SensorIrradiance.type: str#

Type of sensor.

Returns:

str: Sensor type as string

property SensorIrradiance.colorimetric: None | BaseSensor#

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

Returns:

Union[None, ansys.speos.core.sensor.BaseSensor.Colorimetric]: Instance of Colorimetric Class for this sensor feature

property SensorIrradiance.spectral: None | BaseSensor#

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

Returns:

Union[None, ansys.speos.core.sensor.BaseSensor.Spectral]: Instance of Spectral Class for this sensor feature

property SensorIrradiance.layer: None | SensorIrradiance | BaseSensor | BaseSensor | BaseSensor#

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

Returns:

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

Method detail#

SensorIrradiance.set_dimensions()#

Set the dimensions of the sensor.

Returns:

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

SensorIrradiance.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.SensorIrradiance: Irradiance sensor

SensorIrradiance.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.

SensorIrradiance.set_type_radiometric()#

Set type radiometric.

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

Returns:

ansys.speos.core.sensor.SensorIrradiance: Irradiance sensor.

SensorIrradiance.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.

SensorIrradiance.set_illuminance_type_planar(integration_direction=None)#

Set illuminance type planar.

The integration is made orthogonally with the sensor plane.

Parameters:

integration_directionList[float], optional: Sensor global integration direction [x,y,z]. By default, None. None means that a default direction is chosen (anti-normal of the sensor plane).

Returns:

ansys.speos.core.sensor.SensorIrradiance: Irradiance sensor.

SensorIrradiance.set_illuminance_type_radial()#

Set illuminance type radial.

Returns:

ansys.speos.core.sensor.SensorIrradiance: Irradiance sensor.

SensorIrradiance.set_illuminance_type_hemispherical()#

Set illuminance type hemispherical.

Returns:

ansys.speos.core.sensor.SensorIrradiance: Irradiance sensor.

SensorIrradiance.set_illuminance_type_cylindrical()#

Set illuminance type cylindrical.

Returns:

ansys.speos.core.sensor.SensorIrradiance: Irradiance sensor.

SensorIrradiance.set_illuminance_type_semi_cylindrical(integration_direction=None)#

Set illuminance type semi cylindrical.

Parameters:

integration_directionList[float], optional: Sensor global integration direction [x,y,z]. By default, None. None means that a default direction is chosen (anti-normal of the sensor plane).

Returns:

ansys.speos.core.sensor.SensorIrradiance: Irradiance sensor.

SensorIrradiance.set_axis_system(axis_system=None)#

Set position of the sensor.

Parameters:

axis_systemOptional[List[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:

ansys.speos.core.sensor.SensorIrradiance: Irradiance sensor.

SensorIrradiance.set_ray_file_type_none()#

Set no ray file generation.

Returns:

ansys.speos.core.sensor.SensorIrradiance: Irradiance sensor.

SensorIrradiance.set_ray_file_type_classic()#

Set ray file generation without polarization data.

Returns:

ansys.speos.core.sensor.SensorIrradiance: Irradiance sensor.

SensorIrradiance.set_ray_file_type_polarization()#

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

Returns:

ansys.speos.core.sensor.SensorIrradiance: Irradiance sensor.

SensorIrradiance.set_ray_file_type_tm25()#

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

Returns:

ansys.speos.core.sensor.SensorIrradiance: Irradiance sensor.

SensorIrradiance.set_ray_file_type_tm25_no_polarization()#

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

Returns:

ansys.speos.core.sensor.SensorIrradiance: Irradiance sensor.

SensorIrradiance.set_layer_type_none()#

Define layer separation type as None.

Returns:

ansys.speos.core.sensor.SensorIrradiance: irradiance class instance

SensorIrradiance.set_layer_type_source()#

Define layer separation as by source.

Returns:

ansys.speos.core.sensor.SensorIrradiance: irradiance class instance

SensorIrradiance.set_layer_type_face()#

Define layer separation as by face.

Returns:

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

SensorIrradiance.set_layer_type_sequence()#

Define layer separation as by sequence.

Returns:

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

SensorIrradiance.set_layer_type_polarization()#

Define layer separation as by polarization.

Returns:

ansys.speos.core.sensor.SensorIrradiance: Irradiance class instance

SensorIrradiance.set_layer_type_incidence_angle()#

Define layer separation as by incidence angle.

Returns:

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

SensorIrradiance.set_output_face_geometries(geometries=None)#

Select output faces for inverse simulation optimization.

Parameters:

geometriesList[ansys.speos.core.geo_ref.GeoRef]: List of geometries that will be considered as output faces. By default, [], ie no output faces.

Returns:

ansys.speos.core.sensor.SensorIrradiance: Irradiance sensor.

SensorIrradiance#

Overview#

Import detail#

Property detail#

Method detail#

`SensorIrradiance`#