Skip to content

RF Output Data

RF and microwave workflows return xarray-backed data containers for mode amplitudes, transmission-line quantities, directivity, and antenna metrics.

Data objectContents
MicrowaveModeDataMode amplitudes with transmission-line parameters such as Z0, voltage, current, propagation constant, attenuation, and phase.
MicrowaveModeSolverDataComplete 2D mode field profiles with transmission-line parameters and mode classification.
DirectivityDataFar-field radiation patterns, directivity, and radiated power.
AntennaMetricsDataAntenna gain, radiation efficiency, reflection efficiency, realized gain, supplied power, and polarization metrics.

Microwave mode data includes transmission-line datasets that can contain:

QuantityMeaning
Z0Characteristic impedance.
voltage_coeffsVoltage coefficients for computed modes.
current_coeffsCurrent coefficients for computed modes.
gammaComplex propagation constant.
alphaAttenuation constant.
betaPhase constant.
phase_velocityPhase velocity.
group_velocityGroup velocity.

These quantities are typically indexed by frequency, mode index, terminal, or port dimensions depending on the monitor and workflow.

# Component modeler S-parameters.
smatrix = my_tcm_data.smatrix()
s11 = smatrix.data.sel(port_in="P1", port_out="P1")
# Wave-port mode data.
mode_data = my_tcm_data.data["P1"]["mode_monitor"]
z0 = mode_data.transmission_line_data.Z0.sel(mode_index=0)
# Antenna metrics.
antenna_metrics = my_tcm_data.get_antenna_metrics_data()
gain = antenna_metrics.gain
realized_gain = antenna_metrics.realized_gain
SymbolPurpose
TerminalComponentModelerDataResult container returned by terminal component modeler runs.
MicrowaveSMatrixDataS-parameter matrix and reference impedance data.
PortDataArrayPort-indexed data array.
TerminalPortDataArrayTerminal-port S-parameter array.
MicrowaveModeDataMicrowave mode monitor data.
MicrowaveModeSolverDataMicrowave mode solver data.
DirectivityDataDirectivity monitor data.
AntennaMetricsDataAntenna metrics data.
PageWhy open it
Terminal Component ModelerLoad component modeler results and extract S-parameters.
RF Mode AnalysisGenerate microwave mode data and transmission-line parameters.
Radiation And ScatteringGenerate antenna and far-field radiation metrics.