LightPathFinder

class ansys.speos.core.lxp.LightPathFinder(speos, path)

Define an interface to read LPF files.

LPF files contain a set of simulated rays including their intersections and properties.

Parameters:

speosansys.speos.core.speos.Speos

Speos Session (connected to Speos gRPC server).

pathstr

Path to the LPF file to be opened.

Parameters:

• speos (ansys.speos.core.project.Speos)

• path (str)

Overview

Methods

filter_by_face_ids	Filter ray paths based on face IDs and populates filtered_rays property.
filter_by_body_ids	Filter ray paths based on body IDs and populates filtered_rays property.
filter_error_rays	Filter ray paths and only shows rays in error.
remove_error_rays	Filter rays and only shows rays not in error.
preview	Preview LPF file with pyvista.

Properties

nb_traces	Number of light paths within LPF data set.
nb_xmps	Number of sensors involved within LPF data set.
has_sensor_contributions	Define if a LPF file contains information regarding the sensor contribution.
sensor_names	List of involved sensor names.
rays	List ray paths within LPF file.
filtered_rays	List of filtered ray paths.

Attributes

client

Speos instance client

Special methods

__str__

Create string representation of LightPathFinder.

Import detail

from ansys.speos.core.lxp import LightPathFinder

Property detail

property LightPathFinder.nb_traces: int

Number of light paths within LPF data set.

property LightPathFinder.nb_xmps: int

Number of sensors involved within LPF data set.

property LightPathFinder.has_sensor_contributions: bool

Define if a LPF file contains information regarding the sensor contribution.

property LightPathFinder.sensor_names: list[str]

List of involved sensor names.

property LightPathFinder.rays: list[RayPath]

List ray paths within LPF file.

property LightPathFinder.filtered_rays: list[RayPath]

List of filtered ray paths.

Attribute detail

LightPathFinder.client

Speos instance client

Method detail

LightPathFinder.__str__()

Create string representation of LightPathFinder.

LightPathFinder.filter_by_face_ids(options, new=True)

Filter ray paths based on face IDs and populates filtered_rays property.

Parameters:

optionslist[int]

List of face IDs.

newbool

Define if a new filter is created or an existing filter is filtered.

Returns:

ansys.speos.core.lxp.LightPathFinder

LightPathFinder Instance.

LightPathFinder.filter_by_body_ids(options, new=True)

Filter ray paths based on body IDs and populates filtered_rays property.

Parameters:

optionslist[int]

List of body IDs.

newbool

Define if a new filter is created or an existing filter is filtered.

Returns:

ansys.speos.core.lxp.LightPathFinder

LightPathFinder Instance.

LightPathFinder.filter_error_rays()

Filter ray paths and only shows rays in error.

Returns:

ansys.speos.core.lxp.LightPathFinder

LightPathFinder Instance.

LightPathFinder.remove_error_rays()

Filter rays and only shows rays not in error.

Returns:

ansys.speos.core.lxp.LightPathFinder

LightPathFinder Instance.

LightPathFinder.preview(nb_ray=100, max_ray_length=50.0, ray_filter=False, project=None)

Preview LPF file with pyvista.

Parameters:

nb_rayint

Number of rays to be visualized.

max_ray_lengthfloat

Length of last ray.

ray_filterbool

Boolean to decide if filtered rays or all rays should be shown.

projectansys.speos.core.project.Project

Speos Project/Geometry to be added to pyvista visualisation.

Returns:

ansys.speos.core.lxp.LightPathFinder

LightPathFinder Instance.