Skip to content
Flex RF Flex RF Flex RF

flex_rf.tidy3d.DirectivityMonitorSpec

Type: class │ Base(s): MicrowaveBaseModel

Description

Section titled “Description”

Specification for automatically generating a DirectivityMonitor.

Notes

Section titled “Notes”

When included in the radiation_monitors tuple, a DirectivityMonitor will be automatically generated with the specified parameters. This allows users to mix manual DirectivityMonitor objects with automatically generated ones, each with customizable parameters.

The default origin (custom_origin) for defining observation points in the automatically generated monitor is set to (0, 0, 0) in the global coordinate system.

Example(s)

Section titled “Example(s)”
auto_monitor = DirectivityMonitorSpec(
    name="custom_auto",
    buffer=3,
    num_theta_points=50,
    num_phi_points=100
)

Parameters

Section titled “Parameters”
name [str | None] = None

Optional name for the auto-generated monitor. If not provided, defaults to ‘radiation_’ + index of the monitor in the list of radiation monitors.
freqs [tuple[NonNegativeInt, ...] | None] = None

Frequencies to obtain fields at. If not provided, uses all frequencies from the TerminalComponentModeler. Must be a subset of modeler frequencies if provided.
buffer [NonNegativeInt] = AUTO_RADIATION_MONITOR_BUFFER

Number of grid cells to maintain between monitor and PML/domain boundaries. Default: 2 cells.
num_theta_points [NonNegativeInt] = AUTO_RADIATION_MONITOR_NUM_POINTS_THETA

Number of elevation angle (theta) sample points from 0 to π. Default: 100.
num_phi_points [NonNegativeInt] = AUTO_RADIATION_MONITOR_NUM_POINTS_PHI

Number of azimuthal angle (phi) sample points from -π to π. Default: 200.
custom_origin [Coordinate | None] = (0, 0, 0)

Local origin used for defining observation points. If None, uses the monitor’s center.

Machine-Readable Export

Section titled “Machine-Readable Export”