Sionna RT
  • Tutorials
    • Introduction to Sionna RT
      • Imports
      • Loading and Visualizing Scenes
      • Inspecting SceneObjects and Editing of Scenes
      • Ray tracing of Propagation Paths
      • From Paths to Channel Impulse and Frequency Responses
      • Radio Maps
      • Summary
    • Tutorial on Diffraction
      • Table of Contents
      • Background Information
        • Wedge vs Edge
      • Configuration and Imports
      • Experiments with a Simple Wedge
      • Coverage Maps with Diffraction
      • References
    • Tutorial on Mobility
      • Background Information
      • Configuration and Imports
      • Controlling Position and Orientation of Scene Objects
      • Time Evolution of Channels Via Doppler Shift
        • Example: Delay-Doppler Spectrum
      • Comparison of Doppler- vs Position-based Time Evolution
      • Summary
    • Tutorial on Radio Maps
      • Imports
      • Understanding radio maps
        • Metrics
        • Multiple transmitters
        • User association
        • Sampling of random user positions
        • Directional antennas and precoding vectors
      • Radio map for a realistic scene
        • Channel impulse responses for random user locations
      • Radio maps on meshes
      • Conclusions
    • Tutorial on Scattering
      • Imports
      • Scattering Basics
      • Scattering Patterns
      • Validation Against the “Far”-Wall Approximation
      • Radio Maps With Scattering
      • Impact on Channel Impulse Response
      • Summary
      • References
    • Tutorial on Loading and Editing of Scenes
      • Imports
      • Loading Scenes and Merging Objects
      • Editing Scenes
      • Path Computation with the Edited Scene
      • Summary
  • Primer on Electromagnetics
    • Coordinate system, rotations, and vector fields
    • Planar Time-Harmonic Waves
    • Far Field of a Transmitting Antenna
    • Modelling of a Receiving Antenna
    • General Propagation Path
    • Frequency & Impulse Response
    • Reflection and Refraction
      • Single-layer Slab
    • Diffraction
    • Scattering
    • Reconfigurable Intelligent Surfaces (RIS)
  • API Documentation
    • Antenna Arrays
      • AntennaArray
        • AntennaArray.antenna_pattern
        • AntennaArray.array_size
        • AntennaArray.normalized_positions
        • AntennaArray.num_ant
        • AntennaArray.positions()
        • AntennaArray.rotate()
      • PlanarArray
        • PlanarArray.antenna_pattern
        • PlanarArray.array_size
        • PlanarArray.normalized_positions
        • PlanarArray.num_ant
        • PlanarArray.positions()
        • PlanarArray.rotate()
        • PlanarArray.show()
    • Antenna Patterns
      • AntennaPattern
        • AntennaPattern.compute_gain()
        • AntennaPattern.patterns
        • AntennaPattern.show()
      • PolarizedAntennaPattern
        • PolarizedAntennaPattern.compute_gain()
        • PolarizedAntennaPattern.patterns
        • PolarizedAntennaPattern.show()
      • Vertically Polarized Antenna Pattern Functions
        • v_iso_pattern()
        • v_dipole_pattern()
        • v_hw_dipole_pattern()
        • v_tr38901_pattern()
      • Polarization Models
        • polarization_model_tr38901_1()
        • polarization_model_tr38901_2()
      • Utility Functions
        • antenna_pattern_to_world_implicit()
        • complex2real_antenna_pattern()
        • register_antenna_pattern()
        • register_polarization()
        • register_polarization_model()
    • Cameras
      • Camera
        • Camera.look_at()
        • Camera.orientation
        • Camera.position
    • Paths
      • Paths
        • Paths.a
        • Paths.cfr()
        • Paths.cir()
        • Paths.doppler
        • Paths.interactions
        • Paths.num_rx
        • Paths.num_tx
        • Paths.objects
        • Paths.phi_r
        • Paths.phi_t
        • Paths.primitives
        • Paths.rx_array
        • Paths.sources
        • Paths.synthetic_array
        • Paths.taps()
        • Paths.targets
        • Paths.tau
        • Paths.theta_r
        • Paths.theta_t
        • Paths.tx_array
        • Paths.valid
        • Paths.vertices
      • Constants
        • InteractionType
          • InteractionType.DIFFRACTION
          • InteractionType.DIFFUSE
          • InteractionType.NONE
          • InteractionType.REFRACTION
          • InteractionType.SPECULAR
        • INVALID_SHAPE
        • INVALID_PRIMITIVE
    • Path Solvers
      • PathSolver
        • PathSolver.__call__()
        • PathSolver.loop_mode
    • Radio Devices
      • RadioDevice
        • RadioDevice.color
        • RadioDevice.display_radius
        • RadioDevice.look_at()
        • RadioDevice.name
        • RadioDevice.orientation
        • RadioDevice.position
        • RadioDevice.velocity
      • Receiver
      • Transmitter
        • Transmitter.power
        • Transmitter.power_dbm
    • Radio Maps
      • PlanarRadioMap
        • PlanarRadioMap.add_paths()
        • PlanarRadioMap.cell_centers
        • PlanarRadioMap.cell_size
        • PlanarRadioMap.cells_count
        • PlanarRadioMap.cells_per_dim
        • PlanarRadioMap.center
        • PlanarRadioMap.measurement_surface
        • PlanarRadioMap.orientation
        • PlanarRadioMap.path_gain
        • PlanarRadioMap.rx_cell_indices
        • PlanarRadioMap.sample_positions()
        • PlanarRadioMap.show()
        • PlanarRadioMap.show_association()
        • PlanarRadioMap.size
        • PlanarRadioMap.tx_association()
        • PlanarRadioMap.tx_cell_indices
      • MeshRadioMap
        • MeshRadioMap.add_paths()
        • MeshRadioMap.cell_centers
        • MeshRadioMap.cells_count
        • MeshRadioMap.measurement_surface
        • MeshRadioMap.path_gain
        • MeshRadioMap.sample_positions()
      • RadioMap
        • RadioMap.add_paths()
        • RadioMap.cdf()
        • RadioMap.cell_centers
        • RadioMap.cells_count
        • RadioMap.measurement_surface
        • RadioMap.num_rx
        • RadioMap.num_tx
        • RadioMap.path_gain
        • RadioMap.rss
        • RadioMap.sample_cells()
        • RadioMap.sinr
        • RadioMap.transmitter_radio_map()
        • RadioMap.tx_association()
    • Radio Map Solvers
      • RadioMapSolver
        • RadioMapSolver.__call__()
        • RadioMapSolver.loop_mode
    • Radio Materials
      • RadioMaterialBase
        • RadioMaterialBase.color
        • RadioMaterialBase.eval()
        • RadioMaterialBase.name
        • RadioMaterialBase.pdf()
        • RadioMaterialBase.sample()
        • RadioMaterialBase.scene
        • RadioMaterialBase.to_string()
        • RadioMaterialBase.traverse()
      • RadioMaterial
        • RadioMaterial.conductivity
        • RadioMaterial.frequency_update()
        • RadioMaterial.frequency_update_callback
        • RadioMaterial.relative_permittivity
        • RadioMaterial.scattering_coefficient
        • RadioMaterial.scattering_pattern
        • RadioMaterial.thickness
        • RadioMaterial.xpd_coefficient
      • ITURadioMaterial
        • ITURadioMaterial.itu_type
        • ITURadioMaterial.to_string()
      • Scattering Patterns
        • ScatteringPattern
          • ScatteringPattern.__call__()
          • ScatteringPattern.show()
        • LambertianPattern
          • LambertianPattern.__call__()
          • LambertianPattern.show()
        • DirectivePattern
          • DirectivePattern.__call__()
          • DirectivePattern.alpha_r
          • DirectivePattern.show()
        • BackscatteringPattern
          • BackscatteringPattern.__call__()
          • BackscatteringPattern.alpha_i
          • BackscatteringPattern.alpha_r
          • BackscatteringPattern.lambda_
          • BackscatteringPattern.show()
        • register_scattering_pattern()
    • Scenes
      • load_scene()
      • Scene
        • Scene.add()
        • Scene.all_set()
        • Scene.angular_frequency
        • Scene.bandwidth
        • Scene.edit()
        • Scene.frequency
        • Scene.get()
        • Scene.mi_scene
        • Scene.mi_scene_params
        • Scene.objects
        • Scene.paths_solver
        • Scene.preview()
        • Scene.radio_materials
        • Scene.receivers
        • Scene.remove()
        • Scene.render()
        • Scene.render_to_file()
        • Scene.rx_array
        • Scene.scene_geometry_updated()
        • Scene.sources()
        • Scene.targets()
        • Scene.temperature
        • Scene.thermal_noise_power
        • Scene.transmitters
        • Scene.tx_array
        • Scene.wavelength
        • Scene.wavenumber
      • Built-in scenes
        • box
        • box_one_screen
        • box_two_screens
        • double_reflector
        • etoile
        • floor_wall
        • florence
        • munich
        • san_francisco
        • simple_reflector
        • simple_street_canyon
        • simple_street_canyon_with_cars
        • simple_wedge
        • triple_reflector
      • Built-in meshes
        • low_poly_car
        • sphere
    • Scene Objects
      • SceneObject
        • SceneObject.clone()
        • SceneObject.look_at()
        • SceneObject.mi_mesh
        • SceneObject.name
        • SceneObject.object_id
        • SceneObject.orientation
        • SceneObject.position
        • SceneObject.radio_material
        • SceneObject.scaling
        • SceneObject.scene
        • SceneObject.velocity
    • Utility Functions
      • Complex-valued tensors
        • cpx_abs()
        • cpx_abs_square()
        • cpx_add()
        • cpx_convert()
        • cpx_div()
        • cpx_exp()
        • cpx_mul()
        • cpx_sqrt()
        • cpx_sub()
      • Electromagnetics
        • complex_relative_permittivity()
        • fresnel()
        • f_utd()
        • fresnel_reflection_coefficients_simplified()
        • itu_coefficients_single_layer_slab()
      • Geometry
        • phi_hat()
        • theta_hat()
        • r_hat()
        • theta_phi_from_unit_vec()
        • rotation_matrix()
      • Jones calculus
        • implicit_basis_vector()
        • jones_matrix_rotator()
        • jones_matrix_rotator_flip_forward()
        • to_world_jones_rotator()
        • jones_matrix_to_world_implicit()
        • jones_vec_dot()
      • Meshes
        • load_mesh()
        • transform_mesh()
      • Miscellaneous
        • complex_sqrt()
        • dbm_to_watt()
        • isclose()
        • log10()
        • sigmoid()
        • sinc()
        • subcarrier_frequencies()
        • watt_to_dbm()
      • Ray tracing
        • fibonacci_lattice()
        • spawn_ray_from_sources()
        • offset_p()
        • spawn_ray_towards()
        • spawn_ray_to()
  • Developer Guides
    • Compatibility with other Frameworks
      • Type conversions
      • Gradients
      • Training-Loop in PyTorch
    • Understanding the Paths Object
    • Custom Antenna Patterns
      • Gradient-based Optimization
    • Understanding Radio Materials
      • Modifying Parameters of Radio Materials
      • Calibrating Material Parameters Through Gradient Descent
      • Custom Radio Materials
        • Representation of Jones vector and Matrices
        • Implicit Basis
        • The Local Interaction Basis
        • Mandatory Subclass Methods
          • sample()
          • eval()
          • pdf()
          • traverse()
          • to_string()
        • Implementation of a Simple Radio Material Model
        • A More Complex Material Model
    • Custom Scattering Patterns
      • Differentiable Parameters
  • Technical Report
  • Sionna RT GUI
  • References
  • Get the Code
Sionna RT
  • Developer Guides

Developer Guides

  • Compatibility with other Frameworks
  • Understanding the Paths Object
  • Custom Antenna Patterns
  • Understanding Radio Materials
  • Custom Scattering Patterns
Previous Next

© Copyright 2021-2026 NVIDIA CORPORATION.

Built with Sphinx using a theme provided by Read the Docs.