FarField#
- class pyaedt.modules.report_templates.FarField(app, report_category, setup_name, expressions=None)[source]#
Provides for managing far field reports.
Methods
FarField.add_cartesian_x_marker
(val[, name])Add a cartesian X marker.
FarField.add_cartesian_y_marker
(val[, name, ...])Add a cartesian Y marker.
FarField.add_limit_line_from_equation
(...[, ...])Add a Cartesian limit line from point lists.
FarField.add_limit_line_from_points
(x_list, ...)Add a Cartesian limit line from point lists.
FarField.add_note
(text[, x_position, y_position])Add a note at a position.
FarField.add_trace_to_report
(traces[, ...])Add a trace to a specific report.
FarField.create
([plot_name])Create a report.
Delete current report.
FarField.delete_traces
(plot_name, traces_list)Delete an existing trace or traces.
Edit general settings for the plot.
FarField.edit_grid
([minor_x, minor_y, ...])Edit the grid settings for the plot.
FarField.edit_header
([company_name, ...])Edit the plot header.
FarField.edit_legend
([show_solution_name, ...])Edit the plot legend.
FarField.edit_x_axis
([font, font_size, ...])Edit the X-axis settings.
FarField.edit_x_axis_scaling
([...])Edit the X-axis scaling settings.
FarField.edit_y_axis
([axis_name, font, ...])Edit the Y-axis settings.
FarField.edit_y_axis_scaling
([axis_name, ...])Edit the Y-axis scaling settings.
Get the report solution data.
FarField.hide_legend
([solution_name, ...])Hide the Legend.
FarField.import_traces
(file_path, plot_name)Import report data from a file into a specified report.
Update the list of expressions by taking all quantities from a given category.
FarField.update_trace_in_report
(traces[, ...])Update a trace in a specific report.
Attributes
Differential pairs flag.
Plot domain.
Expressions.
Far field sphere name.
List of available limit lines in the report.
2D or Q3D matrix name.
List of available notes in the report.
Plot name.
Polyline name for the field report.
Primary sweep report.
Primary sweep range report.
Report category.
Report type.
Secondary sweep report.
Secondary sweep range report.
List of available traces in the report.
Defines if the TDR should use a pulse or step.
Variations.