RayTracingProbe Class

Ray-Tracing probe for dose estimation.

Inheritance Hierarchy

SystemObject
ema3d.Api.V25APISimObjectBaseRayTracingProbe
ema3d.Api.V25.Charging.ProbesRayTracingProbe

Namespace: ema3d.Api.V25.Charging.Probes
Assembly: ema3d.Api.V25 (in ema3d.Api.V25.dll) Version: 0.0.0.0

Syntax

C++

Copy

public class RayTracingProbe : APISimObjectBase<RayTracingProbe>

Public Class RayTracingProbe
	Inherits APISimObjectBase(Of RayTracingProbe)

public ref class RayTracingProbe : public APISimObjectBase<RayTracingProbe^>

type RayTracingProbe = 
    class
        inherit APISimObjectBase<RayTracingProbe>
    end

The RayTracingProbe type exposes the following members.

Properties

	Name	Description
	AddedThickness	Get/set virtual thickness to add to ray-tracing results.
	AngleDeviation	Get/set maximum allowable deviation from surface normals in the tessellation.
	DisplayName	Gets/Sets the display name of the underlying sim object. (Inherited from APISimObjectBaseTWrapper)
	Geometry	Get/set surfaces associated with this detector.
	MaxAspectRatio	Get/set maximum allowable aspect ratio in the tessellation.
	MaxEdgeLength	Get/set maximum allowable edge length in the tessellation.
	SurfaceDeviation	Get/set maximum allowable deviation from surfaces in the tessellation.

Top

Methods

	Name	Description
	AddBody	Add all surfaces from a body to the detector.
	AddSurface	Add a single surface to the detector.
	Create	Create a new ray-tracing probe for the provided surfaces and tessellation options.
	Delete	Deletes sim object. (Inherited from APISimObjectBaseTWrapper)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	GetAll	Retrieve all RayTracingProbe objects in the document.
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetName	Returns the name of the object. (Inherited from APISimObjectBaseTWrapper)
	GetSiblings	Get all objects that share this object's type in the document. (Overrides APISimObjectBaseTWrapperGetSiblings(Document))
	GetType	Gets the Type of the current instance. (Inherited from Object)
	SetName	Sets the name of the object (Inherited from APISimObjectBaseTWrapper)
	SetVisibility	Sets the visibility status of the object. (Inherited from APISimObjectBaseTWrapper)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Example

Python

Copy

from ema3d.Api.V25.Charging.Probes.RayTracingProbe import RayTracingProbe as RayTracingProbe
#create probe for a body
newProbe = RayTracingProbe.Create(doc)
newProbe.DisplayName = body.GetName()
newProbe.AddBody(body)
newProbe.MaxEdgeLength = 0.0025
newprobe.AddedThickness = 0.001

Reference

ema3d.Api.V25.Charging.Probes Namespace