`Sensor3DEnergyDensity`#

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

Bases: BaseSensor

Sensor feature: volumetric 3D energy density.

Parameters:

projectansys.speos.core.project.Project: Project that owns the feature.
namestr: Name of the feature.
descriptionstr, optional: Description of the feature.
metadataMapping[str, str], optional: User metadata.
sensor_instanceProtoScene.SensorInstance, optional: Existing instance to load instead of creating a new sensor.
default_parametersEnergyDensity3DSensorParameters, optional: Parameters to apply. When loading, None preserves existing values.

Parameters:

project (Sensor3DEnergyDensity.__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.EnergyDensity3DSensorParameters])

Notes

Requires Speos 2027 R1 SP0 and sensor template v2. The default photometric volume is a 50 mm cube centered on its axis-system origin, sampled with 100 voxels along each edge, with no layer separation. Result-file readers and VTP export are not provided for this sensor. Light Expert (LXP) is not supported.

Overview#

Methods

`set_dimensions`	Configure volume dimensions.
`set_type_photometric`	Select photometric mode.
`set_type_radiometric`	Select radiometric mode.
`set_layer_type_none`	Disable layer separation.
`set_layer_type_source`	Separate results by source.
`set_layer_type_face`	Separate results by face.

Properties

`dimensions`	Volume dimensions.
`lxp_path_number`	Light Expert setting, unsupported for energy density sensors.
`type`	Sensor mode.
`axis_system`	Position and orientation as twelve axis-system values.
`layer`	Layer separation configuration.
`visual_data`	Oriented volume preview, independent of voxel sampling.

Import detail#

from ansys.speos.core.sensor import Sensor3DEnergyDensity

Property detail#

property Sensor3DEnergyDensity.dimensions: Sensor3DEnergyDensity#

Volume dimensions.

Returns:

Sensor3DEnergyDensity.Dimensions3D: Sizes and voxel counts.

property Sensor3DEnergyDensity.lxp_path_number: None#

Light Expert setting, unsupported for energy density sensors.

Returns:

None: Light Expert is disabled.

property Sensor3DEnergyDensity.type: str#

Sensor mode.

Returns:

str: "Photometric" or "Radiometric".

property Sensor3DEnergyDensity.axis_system: list[float]#

Position and orientation as twelve axis-system values.

Returns:

list[float]: Origin followed by the X, Y, and Z directions.

Notes

Provide an orthonormal, right-handed coordinate frame.

property Sensor3DEnergyDensity.layer: ansys.speos.core.generic.parameters.LayerTypes | BaseSensor | None#

Layer separation configuration.

Returns:

LayerTypes or BaseSensor.LayerTypeFace or None: Active layer configuration, or None if absent in a loaded instance.

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

Oriented volume preview, independent of voxel sampling.

Returns:

ansys.speos.core.generic.visualization_methods._VisualData: Box surface and coordinate axes.

Notes

Uses local dimensions and positioning so uncommitted edits are visible.

Method detail#

Sensor3DEnergyDensity.set_dimensions()#

Configure volume dimensions.

Returns:

Sensor3DEnergyDensity.Dimensions3D: Sizes and voxel counts.

Sensor3DEnergyDensity.set_type_photometric()#

Select photometric mode.

Returns:

Sensor3DEnergyDensity: This sensor.

Sensor3DEnergyDensity.set_type_radiometric()#

Select radiometric mode.

Returns:

Sensor3DEnergyDensity: This sensor.

Sensor3DEnergyDensity.set_layer_type_none()#

Disable layer separation.

Returns:

Sensor3DEnergyDensity: This sensor.

Sensor3DEnergyDensity.set_layer_type_source()#

Separate results by source.

Returns:

Sensor3DEnergyDensity: This sensor.

Sensor3DEnergyDensity.set_layer_type_face()#

Separate results by face.

Returns:

BaseSensor.LayerTypeFace: Face groups and filtering configuration.

Classes#

Dimensions3D

Dimensions and voxel counts of an energy density volume.