differt.em.compute_received_fields#
- compute_received_fields(paths, mesh, frequency=None, *, solver='geometric', **solver_kwargs)[source]#
Compute the received complex fields for each path.
This is a convenience wrapper around a
AbstractFieldSolver, defaulting toGeometricFieldSolver. Pass a customsolverinstance to customize how fields are computed, e.g., to add support for path interaction types beyondInteractionType.REFLECTION.- Parameters:
paths (
TracedPaths) – The paths.mesh (
Mesh) – The triangle mesh of the scene.frequency (
Float[ArrayLike, "*#batch"]|None) –The operating frequency (or frequencies) in Hz.
May be omitted (left to
None) whensolver’s (or thetx_polarizationsolver keyword argument’s)tx_polarizationis anAbstractAntennainstance, in which case its ownfrequencyis used instead.solver (
AbstractFieldSolver|Literal['geometric']) –The field solver configuration or string shortcut.
Defaults to a plain
GeometricFieldSolver.**solver_kwargs (
Any) – Parameters passed to the solver configuration when it is instantiated from a string shortcut (seeGeometricFieldSolver’s attributes, e.g.,tx_polarization,rx_polarization,radio_materials,tx_wavefront_radii,interaction_matrices, or per-callwavefront_radii). Not allowed whensolveris already a solver instance, except forwavefront_radii.
- Return type:
- Returns:
The received complex fields.