create_sbr_plane_visual_ray_tracing#

PostProcessor.create_sbr_plane_visual_ray_tracing(max_frequency='1GHz', ray_density=2, number_of_bounces=5, multi_bounce=False, mbrd_max_sub_division=2, shoot_utd=False, incident_theta=0, incident_phi=0, is_vertical_polarization=False, shoot_filter_type='All Rays', ray_index_start=0, ray_index_stop=1, ray_index_step=1, ray_box=None)[source]#

Create an SBR Plane Wave Visual Ray Tracing and return the class object.

Parameters:

max_frequencystr, optional: Maximum Frequency. Default is "1GHz".
ray_densityint, optional: Ray Density. Default is 2.
number_of_bouncesint, optional: Maximum number of bounces. Default is 5.
multi_bouncebool, optional: Whether if enable or not Multi-Bounce ray density control. Default is False.
mbrd_max_sub_divisionint, optional: Maximum number of MBRD subdivisions. Default is 2.
shoot_utdbool, optional: Whether if enable or UTD Rays shooting or not. Default is False.
incident_thetastr, optional: Incident plane wave theta. Default is "0deg".
incident_phistr, optional: Incident plane wave phi. Default is "0deg".
is_vertical_polarizationbool, optional: Whether if enable or Vertical Polarization or not. Default is False.
shoot_filter_typestr, optional: Shooter Type. Default is "All Rays". Options are "Rays by index", "Rays in box".
ray_index_startint, optional: Ray index start. Valid only if "Rays by index" is chosen. Default is 0.
ray_index_stopint, optional: Ray index stop. Valid only if "Rays by index" is chosen. Default is 1.
ray_index_stepint, optional: Ray index step. Valid only if "Rays by index" is chosen. Default is 1.
ray_boxint or str optional: Ray box name or id. Valid only if "Rays by box" is chosen. Default is None.

Returns:

:class:` pyaedt.modules.solutions.VRTFieldPlot`