`Library`#

class ansys.speos.core.intensity.Intensity.Library(library, library_props, default_parameters=None)#

Intensity of type: Library.

By default, orientation as axis system is chosen and no exit geometries.

Parameters:

libraryansys.api.speos.intensity.v1.IntensityTemplate.Library: Library to complete.
library_propsansys.api.speos.scene.v2.scene_pb2.Scene.SourceInstance.IntensityProperties.LibraryProperties: Library properties to complete.
default_parametersOptional[ ansys.speos.core.generic.parameters.IntensityLibraryParameters, ] = None: If defined the values in the Library instance will be overwritten by the values of the data class.

Parameters:

library (ansys.speos.core.kernel.intensity_template.ProtoIntensityTemplate.Library)
library_props (ansys.speos.core.kernel.scene.ProtoScene.SourceInstance.IntensityProperties.LibraryProperties)
default_parameters (Optional[ansys.speos.core.generic.parameters.IntensityLibraryParameters])

Overview#

Methods

`set_orientation_normal_to_surface`	Set the intensity orientation as normal to surface.
`set_orientation_normal_to_uv_map`	Set the intensity orientation as normal to uv map.

Properties

`intensity_file_uri`	Property of the intensity file uri.
`orientation_axis_system`	Intensity orientation property from an axis system.
`exit_geometries`	Property of exit geometries.

from ansys.speos.core.intensity.Intensity import Library

property Library.intensity_file_uri: str#

Property of the intensity file uri.

Parameters:

uriUnion[pathlib.Path, str]: uri of the intensity file IES (.ies), Eulumdat (.ldt), speos intensities (.xmp)

Returns:

uristr: uri of the intensity file IES (.ies), Eulumdat (.ldt), speos intensities (.xmp)

property Library.orientation_axis_system: List[float]#

Intensity orientation property from an axis system.

Parameters:

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

property Library.exit_geometries: List[ansys.speos.core.geo_ref.GeoRef]#

Property of exit geometries.

Parameters:

exit_geometriesOptional[List[Union[ ansys.speos.core.geo_ref.GeoRef, ansys.speos.core.body.Body]]]: Exit geometries list. By default, [].

Returns:

Library.set_orientation_normal_to_surface()#

Set the intensity orientation as normal to surface.

Returns:

Library.set_orientation_normal_to_uv_map()#

Set the intensity orientation as normal to uv map.

Returns: