Intensity

class ansys.speos.core.intensity.Intensity(speos_client, name, description='', metadata=None, intensity_props_to_complete=None, key='')

Speos feature : Intensity.

By default, a lambertian intensity is created (cos with N=1 and total_angle=180).

Parameters:

speos_clientansys.speos.core.kernel.client.SpeosClient

The Speos instance client.

namestr

Name of the feature.

descriptionstr

Description of the feature. By default, "".

metadataOptional[Mapping[str, str]]

Metadata of the feature. By default, {}.

intensity_props_to_completeansys.api.speos.scene.v2.scene_pb2.Scene.SourceInstance.IntensityProperties, optional

Intensity properties to complete. By default, None.

keystr

Creation from an IntensityTemplateLink key

Attributes:

intensity_template_linkansys.speos.core.kernel.intensity_template.IntensityTemplateLink

Link object for the intensity template in database.

Parameters:

• speos_client (ansys.speos.core.kernel.client.SpeosClient)

• name (str)

• description (str)

• metadata (Optional[Mapping[str, str]])

• intensity_props_to_complete (Optional[ansys.speos.core.kernel.scene.ProtoScene.SourceInstance.IntensityProperties])

• key (str)

Overview

Methods

set_library	Set the intensity as library.
set_cos	Set the intensity as cos.
set_gaussian	Set the intensity as gaussian.
commit	Save feature: send the local data to the speos server database.
reset	Reset feature: override local data by the one from the speos server database.
delete	Delete feature: delete data from the speos server database.

Properties

type	Return type of sensor.

Attributes

intensity_template_link

Link object for the intensity template in database.

Special methods

__str__

Return the string representation of the intensity.

Import detail

from ansys.speos.core.intensity import Intensity

Property detail

property Intensity.type: type

Return type of sensor.

Returns:

Example: None for lambertian or ansys.speos.core.intensity.Intensity.Library

Attribute detail

Intensity.intensity_template_link = None

Link object for the intensity template in database.

Method detail

Intensity.set_library()

Set the intensity as library.

Returns:

ansys.speos.core.intensity.Intensity.Library

Library intensity.

Intensity.set_cos(n=3, total_angle=180)

Set the intensity as cos.

Parameters:

nfloat

Order of cos law. By default, 3.

total_anglefloat

Total angle in degrees of the emission of the light source. By default, 180.0.

Returns:

ansys.speos.core.intensity.Intensity

Intensity feature.

Intensity.set_gaussian()

Set the intensity as gaussian.

Returns:

ansys.speos.core.intensity.Intensity.Gaussian

Gaussian intensity.

Intensity.__str__()

Return the string representation of the intensity.

Intensity.commit()

Save feature: send the local data to the speos server database.

Returns:

ansys.speos.core.intensity.Intensity

Intensity feature.

Intensity.reset()

Reset feature: override local data by the one from the speos server database.

Returns:

ansys.speos.core.intensity.Intensity

Intensity feature.

Intensity.delete()

Delete feature: delete data from the speos server database.

The local data are still available

Returns:

ansys.speos.core.intensity.Intensity

Intensity feature.

Classes

Library	Intensity of type: Library.
Gaussian	Intensity of type: Gaussian.