SceneLink

class ansys.speos.core.kernel.scene.SceneLink(db, key)

Bases: ansys.speos.core.kernel.crud.CrudItem

Link object for a scene in database.

Parameters:

dbansys.speos.core.kernel.scene.SceneStub

Database to link to.

keystr

Key of the scene in the database.

Parameters:

key (str)

Examples

>>> from ansys.speos.core.speos import Speos
>>> from ansys.speos.core.kernel.scene import ProtoScene
>>> speos = Speos(host="localhost", port=50098)
>>> sce_db = speos.client.scenes()
>>> sce_link = sce_db.create(message=ProtoScene(name="Empty_Scene"))

Overview

Methods

get	Get the datamodel from database.
set	Change datamodel in database.
delete	Remove datamodel from database.
load_file	Load speos file to fill the scene.
get_source_ray_paths	Retrieve source ray paths.

Special methods

__str__

Return the string representation of the scene.

Import detail

from ansys.speos.core.kernel.scene import SceneLink

Method detail

SceneLink.__str__()

Return the string representation of the scene.

SceneLink.get()

Get the datamodel from database.

Returns:

scene.Scene

Scene datamodel.

SceneLink.set(data)

Change datamodel in database.

Parameters:

datascene.Scene

New scene datamodel.

SceneLink.delete()

Remove datamodel from database.

SceneLink.load_file(file_uri)

Load speos file to fill the scene.

Parameters:

file_uristr

File to be loaded.

SceneLink.get_source_ray_paths(source_path, rays_nb=100, raw_data=True, display_data=False)

Retrieve source ray paths.

Parameters:

source_pathstr

Path to the source in the Scene : “” for a specific source in the current scene, or “/” for a specific source in a specific sub scene.

rays_nbint, optional

Number of rays generated by the source. By default, 100.

raw_data: bool, optional

If True, get the wavelengths in response stream.

display_data: bool, optional

If True, get the colors (RGB24 format) in response stream.

Returns:

Iterator[ansys.api.speos.results.v1.ray_path_pb2.RayPath]

Ray paths generated by the source.