Post Processor Report Refactoring (#1017)

* New Report Objects added

* New Report Objects added

* New Report Objects added

* improved UT and Examples

* improved UT and Examples

* added few more methods to Report

* added few more methods to Report

* added few more methods to Report

* added few more methods to Report

Co-authored-by: maxcapodi78 <Shark78>

Author: maxcapodi78

_unittest/test_12_PostProcessing.py

@@ -209,6 +209,9 @@ def test_08_manipulate_report(self):
 
     def test_09_manipulate_report(self):
         assert self.aedtapp.post.create_report("dB(S(1,1))")
+        new_report = self.aedtapp.post.reports_by_category.modal_solution("dB(S(1,1))")
+        assert new_report.create()
+
         data = self.aedtapp.post.get_solution_data("S(1,1)")
         assert data.primary_sweep == "Freq"
         assert data.expressions[0] == "S(1,1)"
@@ -227,6 +230,15 @@ def test_09_manipulate_report(self):
             context="3D",
             report_category="Far Fields",
         )
+        new_report = self.field_test.post.reports_by_category.far_field(
+            "db(RealizedGainTotal)", self.field_test.nominal_adaptive
+        )
+        new_report.variations = variations
+        new_report.report_type = "3D Polar Plot"
+        new_report.far_field_sphere = "3D"
+        assert new_report.create()
+        new_report.report_type = "Rectangular Contour Plot"
+        assert new_report.create()
         data = self.field_test.post.get_solution_data(
             "GainTotal",
             self.field_test.nominal_adaptive,
@@ -252,6 +264,10 @@ def test_09_manipulate_report(self):
             context="Poly1",
             report_category="Fields",
         )
+        new_report = self.field_test.post.reports_by_category.fields("Mag_H", self.field_test.nominal_adaptive)
+        new_report.variations = variations2
+        new_report.polyline = "Poly1"
+        assert new_report.create()
         assert data.primary_sweep == "Theta"
         assert data.data_magnitude("GainTotal")
         assert not data.data_magnitude("GainTotal2")
@@ -261,11 +277,44 @@ def test_09_manipulate_report(self):
             variations=variations,
             plot_type="Smith Chart",
         )
+        new_report = self.field_test.post.reports_by_category.modal_solution("S(1,1)")
+        new_report.plot_type = "Smith Chart"
+        assert new_report.create()
+        pass
 
-    def test_09b_export_report(self):
+    def test_09b_export_report(self):  # pragma: no cover
         files = self.aedtapp.export_results()
         assert len(files) > 0
 
+    @pytest.mark.skipif(
+        config["build_machine"], reason="Skipped because it cannot run on build machine in non-graphical mode"
+    )
+    def test_09c_create_monitor(self):  # pragma: no cover
+        assert self.aedtapp.post.create_report("dB(S(1,1))")
+        new_report = self.aedtapp.post.reports_by_category.modal_solution("dB(S(1,1))")
+        assert new_report.create()
+
+        assert new_report.add_cartesian_x_marker("3GHz")
+        assert new_report.add_cartesian_y_marker("-55")
+
+    @pytest.mark.skipif(
+        config["build_machine"], reason="Skipped because it cannot run on build machine in non-graphical mode"
+    )
+    def test_09d_add_line_from_point(self):  # pragma: no cover
+        assert self.aedtapp.post.create_report("dB(S(1,1))")
+        new_report = self.aedtapp.post.reports_by_category.modal_solution("dB(S(1,1))")
+        assert new_report.create()
+        assert new_report.add_limit_line_from_points([3, 5, 5, 3], [-50, -50, -60, -60], "GHz")
+
+    @pytest.mark.skipif(
+        config["build_machine"], reason="Skipped because it cannot run on build machine in non-graphical mode"
+    )
+    def test_09e_add_line_from_equation(self):
+        assert self.aedtapp.post.create_report("dB(S(1,1))")
+        new_report = self.aedtapp.post.reports_by_category.modal_solution("dB(S(1,1))")
+        assert new_report.create()
+        assert new_report.add_limit_line_from_equation(1, 20, 0.5, "GHz")
+
     def test_10_delete_report(self):
         assert self.aedtapp.post.delete_report("MyNewScattering")
 
@@ -329,9 +378,16 @@ def test_17_circuit(self):
         self.circuit_test.analyze_setup("LNA")
         self.circuit_test.analyze_setup("Transient")
         assert self.circuit_test.post.create_report(["dB(S(Port1, Port1))", "dB(S(Port1, Port2))"], "LNA")
+        new_report = self.circuit_test.post.reports_by_category.standard(
+            ["dB(S(Port1, Port1))", "dB(S(Port1, Port2))"], "LNA"
+        )
+        assert new_report.create()
         data1 = self.circuit_test.post.get_solution_data(["dB(S(Port1, Port1))", "dB(S(Port1, Port2))"], "LNA")
         assert data1.primary_sweep == "Freq"
         assert self.circuit_test.post.create_report(["V(net_11)"], "Transient", "Time")
+        new_report = self.circuit_test.post.reports_by_category.standard(["V(net_11)"], "Transient")
+        new_report.domain = "Time"
+        assert new_report.create()
         data2 = self.circuit_test.post.get_solution_data(["V(net_11)"], "Transient", "Time")
         assert data2.primary_sweep == "Time"
         assert data2.data_magnitude()
@@ -349,6 +405,10 @@ def test_18_diff_plot(self):
             primary_sweep_variable="l1",
             context="Differential Pairs",
         )
+        new_report = self.diff_test.post.reports_by_category.standard("dB(S(1,1))")
+        new_report.differential_pairs = True
+        assert new_report.create()
+        assert new_report.get_solution_data()
         data1 = self.diff_test.post.get_solution_data(
             ["S(Diff1, Diff1)"],
             "LinearFrequency",
@@ -436,8 +496,35 @@ def test_56_test_export_q3d_results(self):
         self.q3dtest.analyze_nominal()
         assert os.path.exists(self.q3dtest.export_convergence("Setup1"))
         assert os.path.exists(self.q3dtest.export_profile("Setup1"))
+        new_report = self.q3dtest.post.reports_by_category.standard(self.q3dtest.get_traces_for_plot())
+        assert new_report.create()
+        self.q3dtest.modeler.create_polyline([[0, -5, 0.425], [0.5, 5, 0.5]], name="Poly1", non_model=True)
+        new_report = self.q3dtest.post.reports_by_category.cg_fields("SmoothQ", polyline="Polyline1")
+        assert new_report.create()
+        new_report = self.q3dtest.post.reports_by_category.rl_fields("Mag_SurfaceJac", polyline="Polyline1")
+        assert new_report.create()
+        new_report = self.q3dtest.post.reports_by_category.dc_fields("Mag_VolumeJdc", polyline="Polyline1")
+        assert new_report.create()
+        assert len(self.q3dtest.post.plots) == 4
 
     def test_57_test_export_q2d_results(self):
         self.q2dtest.analyze_nominal()
         assert os.path.exists(self.q2dtest.export_convergence("Setup1"))
         assert os.path.exists(self.q2dtest.export_profile("Setup1"))
+        new_report = self.q2dtest.post.reports_by_category.standard(self.q2dtest.get_traces_for_plot())
+        assert new_report.create()
+        self.q2dtest.modeler.create_polyline([[-1.9, -0.1, 0], [-1.2, -0.2, 0]], name="Poly1", non_model=True)
+        new_report = self.q2dtest.post.reports_by_category.cg_fields("Mag_E", polyline="Poly1")
+        assert new_report.create()
+        new_report = self.q2dtest.post.reports_by_category.rl_fields("Mag_H", polyline="Poly1")
+        assert new_report.create()
+        assert len(self.q2dtest.post.plots) == 3
+
+    def test_58_test_no_report(self):
+        assert not self.aedtapp.post.reports_by_category.eye_diagram()
+        assert not self.q3dtest.post.reports_by_category.modal_solution()
+        assert not self.q3dtest.post.reports_by_category.terminal_solution()
+        assert not self.q2dtest.post.reports_by_category.far_field()
+        assert not self.q2dtest.post.reports_by_category.near_field()
+        assert self.aedtapp.post.reports_by_category.eigenmode()
+        assert not self.q2dtest.post.reports_by_category.eigenmode()

_unittest/test_21_Circuit.py

@@ -100,6 +100,9 @@ def test_06b_add_3dlayout_component(self):
             report_category="Standard",
             subdesign_id=myedb.id,
         )
+        new_report = self.aedtapp.post.reports_by_category.standard(insertions)
+        new_report.sub_design_id = myedb.id
+        assert new_report.create()
 
     def test_07_add_hfss_component(self):
         my_model, myname = self.aedtapp.modeler.schematic.create_field_model(

_unittest/test_98_Icepak.py

@@ -224,9 +224,21 @@ def test_16_create_output_variable(self):
         assert self.aedtapp.create_output_variable("OutputVariable1", "abs(Variable1)")  # test creation
         assert self.aedtapp.create_output_variable("OutputVariable1", "asin(Variable1)")  # test update
 
+    def test_16_surface_monitor(self):
+        self.aedtapp.modeler.create_rectangle(self.aedtapp.PLANE.XY, [0, 0, 0], [10, 20], name="surf1")
+        assert self.aedtapp.assign_surface_monitor("surf1", monitor_name="monitor_surf")
+
+    def test_16_point_monitor(self):
+        assert self.aedtapp.assign_point_monitor([0, 0, 0], monitor_name="monitor_point")
+
     def test_17_analyze(self):
         self.aedtapp.analyze_nominal()
 
+    def test_17_post_processing(self):
+        rep = self.aedtapp.post.reports_by_category.monitor(["monitor_surf.Temperature", "monitor_point.Temperature"])
+        assert rep.create()
+        assert len(self.aedtapp.post.plots) == 1
+
     def test_17_get_output_variable(self):
         value = self.aedtapp.get_output_variable("OutputVariable1")
         tol = 1e-9
@@ -324,13 +336,6 @@ def test_36_create_source(self):
             temperature="28cel",
         )
 
-    def test_37_surface_monitor(self):
-        self.aedtapp.modeler.create_rectangle(self.aedtapp.PLANE.XY, [0, 0, 0], [10, 20], name="surf1")
-        assert self.aedtapp.assign_surface_monitor("surf1")
-
-    def test_38_point_monitor(self):
-        assert self.aedtapp.assign_point_monitor([0, 0, 0])
-
     def test_39_import_idf(self):
         self.aedtapp.insert_design("IDF")
         assert self.aedtapp.import_idf(os.path.join(local_path, "example_models", "brd_board.emn"))

_unittest_ironpython/test_36_Q2D_PostProcessing.py

@@ -0,0 +1,23 @@
+
+from conf_unittest import test_generator, PytestMockup
+import os
+
+test_filter = "test_"
+
+test_name = os.path.basename(__file__).replace(".py", "")
+mymodule = __import__('_unittest.' + test_name, fromlist=['TestClass'])
+test_obj = mymodule.TestClass()
+
+class TestSequenceFunctionsGenerate(PytestMockup):
+    @classmethod
+    def setUpClass(cls):
+        test_obj.setup_class()
+
+    @classmethod
+    def tearDownClass(cls):
+        test_obj.teardown_class()
+
+test_names = [name for name in dir(test_obj) if name.startswith(test_filter)]
+for test_name in test_names:
+    test_fn = test_generator(test_obj, test_name)
+    setattr(TestSequenceFunctionsGenerate, test_name, test_fn)

doc/source/API/Post.rst

@@ -19,6 +19,11 @@ They are accessible through the ``post`` property:
 
     # this call return a SolutionData Object
     my_data = post.get_report_data(expression=trace_names)
+
+    # this call return a new Standard Report Object and creates one or multiple report from it.
+    standard_report = post.report_by_category.standard("db(S(1,1))")
+    standard_report.create()
+    sols = standard_report.get_solution_data()
     ...
 
 .. note::
@@ -40,4 +45,10 @@ They are accessible through the ``post`` property:
    PostProcessor.SolutionData
    PostProcessor.FieldPlot
    AdvancedPostProcessing.ModelPlotter
+   report_templates.Standard
+   report_templates.Fields
+   report_templates.NearField
+   report_templates.FarField
+   report_templates.EyeDiagram
+   report_templates.Emission
 

examples/02-HFSS/HFSS_Dipole.py

@@ -118,7 +118,36 @@
 )
 
 ###############################################################################
-# Postprocessing
+# Postprocessing using report objects
+# -----------------------------------
+# Another way to create a plot is using report_by_category.
+# This gives more freedom to the user in report creation.
+
+new_report = hfss.post.reports_by_category.far_field("db(RealizedGainTotal)", hfss.nominal_adaptive, "3D")
+new_report.variations = variations
+new_report.primary_sweep = "Theta"
+new_report.create("Realized2D")
+
+###############################################################################
+# Multiple Reports
+# ----------------
+# The same object new_report can be used to create multiple reports.
+# In this example a 2d and a 3d polar plot is created.
+
+new_report.report_type = "3D Polar Plot"
+new_report.secondary_sweep = "Phi"
+new_report.create("Realized3D")
+
+###############################################################################
+# Solution Data
+# -------------
+# The same object new_report can be used to get solution data and post process or plot outside AEDT.
+
+solution_data = new_report.get_solution_data()
+solution_data.plot()
+
+###############################################################################
+# Far Field Plot
 # --------------
 # Create post processing variable and assign to new coordinate system.
 # A post processing variable can be created directly from setter
@@ -128,42 +157,48 @@
 hfss.variable_manager.set_variable("y_post", 1, postprocessing=True)
 hfss.modeler.create_coordinate_system(["post_x", "y_post", 0], name="CS_Post")
 hfss.insert_infinite_sphere(custom_coordinate_system="CS_Post", name="Sphere_Custom")
+
 ###############################################################################
-# Postprocessing
-# --------------
+# Get Solution Data
+# -----------------
 # The same report can be obtained outside electronic desktop with the
 # following commands.
 
-solutions = hfss.post.get_solution_data(
-    "GainTotal",
-    hfss.nominal_adaptive,
-    variations,
-    primary_sweep_variable="Theta",
-    context="3D",
-    report_category="Far Fields",
-)
-
-solutions_custom = hfss.post.get_solution_data(
-    "GainTotal",
-    hfss.nominal_adaptive,
-    variations,
-    primary_sweep_variable="Theta",
-    context="Sphere_Custom",
-    report_category="Far Fields",
-)
+new_report = hfss.post.reports_by_category.far_field("GainTotal", hfss.nominal_adaptive, "3D")
+new_report.primary_sweep = "Theta"
+new_report.far_field_sphere = "3D"
+solutions = new_report.get_solution_data()
+# solutions = hfss.post.get_solution_data(
+#     "GainTotal",
+#     hfss.nominal_adaptive,
+#     variations,
+#     primary_sweep_variable="Theta",
+#     context="3D",
+#     report_category="Far Fields",
+# )
+#
+# solutions_custom = hfss.post.get_solution_data(
+#     "GainTotal",
+#     hfss.nominal_adaptive,
+#     variations,
+#     primary_sweep_variable="Theta",
+#     context="Sphere_Custom",
+#     report_category="Far Fields",
+# )
 
 ###############################################################################
 # 3D Plot
 # -------
 # plot_3d method created a 3d plot using matplotlib.
-
 solutions.plot_3d()
 
 ###############################################################################
 # 3D Plot
 # -------
 # plot_3d method created a 3d plot using matplotlib.
 
+new_report.far_field_sphere = "Sphere_Custom"
+solutions_custom = new_report.get_solution_data()
 solutions_custom.plot_3d()
 
 ###############################################################################