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.
`FarField.delete`()	Delete current report.
`FarField.delete_traces`(plot_name, traces_list)	Delete an existing trace or traces.
`FarField.edit_general_settings`([...])	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.
`FarField.get_solution_data`()	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.
`FarField.update_expressions_with_defaults`([...])	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

`FarField.differential_pairs`	Differential pairs flag.
`FarField.domain`	Plot domain.
`FarField.expressions`	Expressions.
`FarField.far_field_sphere`	Far field sphere name.
`FarField.limit_lines`	List of available limit lines in the report.
`FarField.matrix`	2D or Q3D matrix name.
`FarField.notes`	List of available notes in the report.
`FarField.plot_name`	Plot name.
`FarField.polyline`	Polyline name for the field report.
`FarField.primary_sweep`	Primary sweep report.
`FarField.primary_sweep_range`	Primary sweep range report.
`FarField.report_category`	Report category.
`FarField.report_type`	Report type.
`FarField.secondary_sweep`	Secondary sweep report.
`FarField.secondary_sweep_range`	Secondary sweep range report.
`FarField.traces`	List of available traces in the report.
`FarField.use_pulse_in_tdr`	Defines if the TDR should use a pulse or step.
`FarField.variations`	Variations.