RayPath#

class ansys.speos.core.lxp.RayPath(raypath, sensor_contribution=False)#

Framework representing a singular ray path.

Parameters:
raypathansys.api.speos.lpf.v2.lpf_file_reader__v2__pb2.RayPath

RayPath object

sensor_contributionbool

Defines if sensor contributions are stored within the data. By default False.

Parameters:

  • raypath (ansys.api.speos.lpf.v2.lpf_file_reader_pb2.RayPath)

  • sensor_contribution (bool)

Overview#

get

Retrieve any information from the RayPath object.

nb_impacts

Number of impacts contained in ray path.

impacts

XYZ coordinates for each impact.

wl

Wavelength of the ray.

body_ids

Body ID of interacted body for each impact.

face_ids

Face ID of interacted body for each impact.

last_direction

Last direction of the ray.

intersection_type

Intersection type of the ray for each impact.

sensor_contribution

Provide the sensor contribution information for each sensor.

__str__

Create string representation of a RayPath.

Import detail#

from ansys.speos.core.lxp import RayPath

Property detail#

property RayPath.nb_impacts: int#

Number of impacts contained in ray path.

Returns:
int

Number of impacts

property RayPath.impacts: List[List[float]]#

XYZ coordinates for each impact.

Returns:
List[List[float]]

list containing the impact coordinates [[x0,y0,z0],[x1,y1,z1],…]

property RayPath.wl: float#

Wavelength of the ray.

Returns:
float

Wavelength in nm

property RayPath.body_ids: List[int]#

Body ID of interacted body for each impact.

Returns:
List[int]

List of body IDs for each impact.

property RayPath.face_ids: List[int]#

Face ID of interacted body for each impact.

Returns:
List[int]

List of face IDs for each impact.

property RayPath.last_direction: List[float]#

Last direction of the ray.

Returns:
List[float]

Last direction of the rays as list[x,y,z].

property RayPath.intersection_type: List[int]#

Intersection type of the ray for each impact.

Returns:
List[int]

Intersection type at each impact.

Notes

Available intersection types:

  • StatusAbsorbed = 0

  • StatusSpecularTransmitted = 1

  • StatusGaussianTransmitted = 2

  • StatusLambertianTransmitted = 3

  • StatusVolumicDiffused = 4

  • StatusJustEmitted = 5

  • StatusDiracTransmitted = 6

  • StatusError = 7

  • StatusErrorVolumicBodyNotClosed = 8

  • StatusErrorVolumeConflict = 9

  • StatusError2DTangency = 10

  • StatusError2DIntersect3DWarning = 11

  • StatusErrorNonOpticalMaterial = 12

  • StatusErrorIntersection = 13

  • StatusErrorNonOpticalMaterialAtEmission = 14

  • StatusError3DTextureSupportTangency = 15

  • StatusLast = 16

  • StatusFirst = -7

  • StatusDiracReflected = -6

  • StatusReserved = -5

  • StatusGrinStep = -4

  • StatusLambertianReflected = -3

  • StatusGaussianReflected = -2

  • StatusSpecularReflected = -1

property RayPath.sensor_contribution: None | List[dict]#

Provide the sensor contribution information for each sensor.

Returns:
Union[None, List[dict]]

If no sensor contribution, None will be returned. If there is sensor contribution, a dictionary with the following information is returned: {“sensor_id”: sc.sensor_id, “position”: [sc.coordinates.x, sc.coordinates.y]}

Method detail#

RayPath.get(key='')#

Retrieve any information from the RayPath object.

Parameters:
keystr

Name of the property.

Returns:
property

Values/content of the associated property.

RayPath.__str__()#

Create string representation of a RayPath.