SensorXMPIntensity

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

Bases: BaseSensor

Class for XMP intensity sensor.

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.IntensityXMPSensorParameters, optional

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

Parameters:

• project (SensorXMPIntensity.__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.IntensityXMPSensorParameters])

Overview

Methods

set_orientation_x_as_meridian	Set Orientation type: X As Meridian, Y as Parallel.
set_orientation_x_as_parallel	Set Orientation type: X as Parallel, Y as Meridian.
set_orientation_conoscopic	Set Orientation type to conoscopic.
set_viewing_direction_from_source	Set viewing direction from source looking at sensor.
set_viewing_direction_from_sensor	Set viewing direction from sensor looking at source.
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 intensity sensor visualization data.
near_field	Return True if the sensor is positioned in nearfield, otherwise False.
cell_distance	Distance of the Detector to origin in mm.
cell_diameter	Cell diameter in mm.
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.
x_start	The minimum value on x-axis (deg).
x_end	The maximum value on x-axis (deg).
x_sampling	Pixel sampling along x-Axis.
y_end	The maximum value on y-axis (deg).
y_start	The minimum value on y-axis (deg).
y_sampling	Sampling along y-axis.
theta_max	Maximum theta angle on conoscopic type (in deg).
theta_sampling	Sampling on conoscopic type.
axis_system	Position of the sensor.

Import detail

from ansys.speos.core.sensor import SensorXMPIntensity

Property detail

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

Property containing intensity sensor visualization data.

Returns:

ansys.speos.core.generic.visualization_methods._VisualData

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

property SensorXMPIntensity.near_field: bool

Return True if the sensor is positioned in nearfield, otherwise False.

Parameters:

valuebool

Defines if near-field is active or not

Returns:

bool

Boolean to determine if sensor is in near-field.

property SensorXMPIntensity.cell_distance: float | None

Distance of the Detector to origin in mm.

By default, 10

Parameters:

valuefloat

Distance of the measurement cell from the origin in mm.

Returns:

Union[None, float]

Distance of the measurement cell or None if Sensor is not in near field.

property SensorXMPIntensity.cell_diameter: None | float

Cell diameter in mm.

By default, 0.3491

Parameters:

valuefloat

Diameter of the measurement cell in mm.

Returns:

Union[None, float]

Diameter of the measurement cell or None if Sensor is not in near field.

property SensorXMPIntensity.type: str

Type of sensor.

Returns:

str

Sensor type as string

property SensorXMPIntensity.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 SensorXMPIntensity.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 SensorXMPIntensity.layer: ansys.speos.core.generic.parameters.LayerTypes | BaseSensor | BaseSensor

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

Returns:

Union[ ansys.speos.core.generic.parameters.LayerTypes, ansys.speos.core.sensor.BaseSensor.LayerTypeFace, ansys.speos.core.sensor.BaseSensor.LayerTypeSequence]

Instance of Layertype Class for this sensor feature

property SensorXMPIntensity.x_start: None | float

The minimum value on x-axis (deg).

Parameters:

valuefloat

Start value for x-axis (degree).

Returns:

Union[None, float]:

Minimum of x-axis in degree.

property SensorXMPIntensity.x_end: None | float

The maximum value on x-axis (deg).

Parameters:

valuefloat

End value for x-axis (degree).

Returns:

Union[None, float]:

Maximum of x-axis in degree.

property SensorXMPIntensity.x_sampling: None | int

Pixel sampling along x-Axis.

Parameters:

valueint

Sampling for x-axis.

Returns:

Union[None, int]:

Number of Pixels along x-Axis.

property SensorXMPIntensity.y_end: None | float

The maximum value on y-axis (deg).

Parameters:

valuefloat

End value for y-axis (degree).

Returns:

Union[None, float]:

Maximum of y-axis in degree.

property SensorXMPIntensity.y_start: None | float

The minimum value on y-axis (deg).

Parameters:

valuefloat

Start value for y-axis (degree).

Returns:

Union[None, float]:

Minimum of y-axis in degree.

property SensorXMPIntensity.y_sampling: None | int

Sampling along y-axis.

Parameters:

valueint

Sampling along the y-axis.

Returns:

Union[None, int]:

Number of Pixels along the y-axis.

property SensorXMPIntensity.theta_max: None | float

Maximum theta angle on conoscopic type (in deg).

Parameters:

valuefloat

Maximum value for Theta in a conoscopic map. (degree).

Returns:

Union[None, float]:

Maximum value for Theta angle.

property SensorXMPIntensity.theta_sampling: None | int

Sampling on conoscopic type.

Parameters:

valueint

Sampling along theta axis in a conoscopic map. (degree). Speos ensure that equal resolution along phi is maintained.

Returns:

Union[None, int]:

Sampling along theta axis in a conoscopic map.

property SensorXMPIntensity.axis_system: list[float]

Position of the sensor.

Parameters:

valuelist[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]

Axis system information as np.array.

Method detail

SensorXMPIntensity.set_orientation_x_as_meridian()

Set Orientation type: X As Meridian, Y as Parallel.

SensorXMPIntensity.set_orientation_x_as_parallel()

Set Orientation type: X as Parallel, Y as Meridian.

SensorXMPIntensity.set_orientation_conoscopic()

Set Orientation type to conoscopic.

SensorXMPIntensity.set_viewing_direction_from_source()

Set viewing direction from source looking at sensor.

SensorXMPIntensity.set_viewing_direction_from_sensor()

Set viewing direction from sensor looking at source.

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

Intensity sensor

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

SensorXMPIntensity.set_type_radiometric()

Set type radiometric.

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

Returns:

ansys.speos.core.sensor.SensorXMPIntensity

Intensity sensor.

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

SensorXMPIntensity.set_layer_type_none()

Define layer separation type as None.

Returns:

ansys.speos.core.sensor.SensorXMPIntensity

Intensity sensor

SensorXMPIntensity.set_layer_type_source()

Define layer separation as by source.

Returns:

ansys.speos.core.sensor.SensorXMPIntensity

Intensity sensor

SensorXMPIntensity.set_layer_type_face()

Define layer separation as by face.

Returns:

ansys.speos.core.sensor.BaseSensor.LayerTypeFace

LayerTypeFace property instance

SensorXMPIntensity.set_layer_type_sequence()

Define layer separation as by sequence.

Returns:

ansys.speos.core.sensor.BaseSensor.LayerTypeSequence

LayerTypeSequence property instance