export_report_to_file#

PostProcessor3DLayout.export_report_to_file(output_dir: str, plot_name: str, extension: str, unique_file: bool = False, uniform: bool = False, start: str = None, end: str = None, step: str = None, use_trace_number_format: bool = False) → str#

Export a 2D Plot data to a file.

This method leaves the data in the plot (as data) as a reference for the Plot after the loops.

Parameters:
output_dirstr

Path to the directory of exported report

plot_namestr

Name of the plot to export.

extensionstr
Extension of export , one of

  • (CSV) .csv

  • (Tab delimited) .tab

  • (Post processor format) .txt

  • (Ensight XY data) .exy

  • (Anosft Plot Data) .dat

  • (Ansoft Report Data Files) .rdat

unique_filebool

If set to True, generates unique file in output_dit

uniformbool, optional

Whether the export uniform points to the file. The default is False.

startstr, optional

Start range with units for the sweep if the uniform parameter is set to True.

endstr, optional

End range with units for the sweep if the uniform parameter is set to True.

stepstr, optional

Step range with units for the sweep if the uniform parameter is set to True.

use_trace_number_formatbool, optional

Whether to use trace number formats and use separate columns for curve. The default is False.

Returns:
str

Path of exported file.

References

>>> oModule.ExportReportDataToFile
>>> oModule.ExportUniformPointsToFile
>>> oModule.ExportToFile

Examples

>>> from ansys.aedt.core import Circuit
>>> cir = Circuit("my_project.aedt")
>>> report = cir.post.create_report("MyScattering")
>>> cir.post.export_report_to_file("C:\\temp", "MyTestScattering", ".csv")