cst_get_farfield_metrics
Retrieve antenna metrics after a solve: S11, radiation/total efficiency, and peak realized gain from the farfield plot. Use this to get simulation results compatible with the CST GUI.
Instructions
Read antenna metrics after a solve: S11 + radiation/total efficiency from 1D Results, plus max realized gain via official FarfieldPlot.GetMax (SelectTreeItem Farfields\farfield (f=X) [1] → Plot → GetMax). Does NOT use ASCIIExportSummary (that API spams Message on CST 2026). Solve sonrası S11, verimlilik ve max gain; GUI farfield ile uyumlu.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| monitor_name | No | Optional exact monitor label, e.g. farfield (f=2.4) [1] | |
| frequency_ghz | No | Design frequency in GHz (for nearest efficiency sample) | |
| try_farfield_plot | No | If true (default), also run FarfieldPlot.GetMax for peak realized gain. Set false for 1D-only metrics. |