XY transposable plots V3 part 2: Updated all remaining plot functions (issue1072) #2544

jewettaijfc · 2025-06-05T21:01:03Z

This PR addresses the feature request from issue 1072, adding the ability to swap the horizontal and vertical axes of all Tidy3D plots.

Reviewer instructions

This PR has been based on top of PR2687. You must land that PR before this one.

Automatic Tests

poetry run pytest tests

Manual Tests

Open any of the tidy3d-notebook examples with jupyter.
Evaluate the cells to verify that the plots using transpose=True are flipped (with respect to the plots that omit the transpose argument).

I have tested this PR with over 150 examples (out of 191). It's possible that some advanced plot types which are not covered in these examples may have visual glitches or don't work when transpose=True.

But all plots that display simulations, scenes, structures, sources, monitors work with transpose=True. (Including geometry transformations and clipping.)

tidy3d/components/geometry/base.py

tidy3d/components/geometry/polyslab.py

tidy3d/components/tcad/data/sim_data.py

greptile-apps

PR Summary

Implements axis transposition functionality across Tidy3D's visualization system by adding a transpose parameter to plot-related functions.

Core implementation centers on new pop_axis_and_swap() and unpop_axis_and_swap() functions in geometry/base.py that handle coordinate transformations
Systematically propagates transpose parameter through all plotting functions that accept axis arguments (x,y,z)
Notable update to intersections_tilted_plane() in geometry/base.py contains potential bug where X,Y axis order ignores normal direction
Comprehensive test coverage added across components including parameterized tests for both transpose=True/False cases
Clean implementation using strategy of swapping geometry/limits pre-matplotlib rather than post-rendering axis manipulation

_{25 files reviewed, 3 comments}
_{Edit PR Review Bot Settings | Greptile}

tests/test_components/test_source.py

tidy3d/components/geometry/polyslab.py

tidy3d/components/base_sim/simulation.py

tylerflex

Looks pretty good! Just minor comments for now. You can focus on clearing these up + those from the new automated review bot 😆 and then request me again for another review.

Let's have @yaugenst-flex also take a look when he's back.

One thing I think we should do also before merging is pick a handful of existing notebooks at random (maybe 5-10) and just throw a transpose=True in to test this a bit more in some real world situations.

Thanks @jewettaijfc !

tests/test_components/test_geometry.py

tidy3d/components/geometry/base.py

tidy3d/components/geometry/polyslab.py

jewettaijfc · 2025-07-23T22:35:27Z

So many changes have been made since Greptile evaluated this code that it's comments are no longer relevant. So I hid those comments.

jewettaij · 2025-07-25T14:02:29Z

tidy3d/components/tcad/data/sim_data.py

        # only then overlay the mesh plot
-        field_data.plot(ax=ax, cmap=False, field=False, grid=True)


I'm not sure what is field_data is, or which function is being invoked by this line. And I could not find an example of a plot() function in Tidy3D which accepts cmap=False as an argument (usually cmap is a string). So I removed this argument when I invoked this function (on line 206).

Momchil wrote the original version of this function. Whoever ends up reviewing this code should reach out to him for clarification. He was on PTO at the time I submitted this PR (on my last day).

jewettaij · 2025-07-25T14:06:27Z

tidy3d/components/tcad/data/sim_data.py

+                func_name="plot_mesh",
+                arg="transpose",
+                val="True",
+            )


Of all the functions I modified for this PR, plot_mesh() is the function I have the most concerns about.

The changes I made to this file should be moved into a different PR which can be tested separately.

I did not find any tidy3d-notebook examples which invoke this plot_mesh() function. (However I think it is covered by the unit tests.)

(Also see my comment below on line 195.)

jewettaij · 2025-07-25T14:37:47Z

SUMMARY

I mentioned this in my later comments, but here's a summary:

I have tested this PR by successfully running 150 of the examples from tidy3d-notebooks using transpose=True (when possible).

Unfortunately, the examples I tried DID NOT invoke following functions that I modified in this PR:

Scene._pcolormesh_shape_custom_medium_structure_eps() (in components/scene.py)
TFSF.plot() (in tidy3d/components/source/field.py)
AbstractHeatChargeSimulationData.plot() (in components/tcad/data/sim_data.py)
CustomVoltageIntegral2D.plot() (in plugins/microwave/custom_path_integrals.py)
CustomCurrentIntegral2D.plot() (in plugins/microwave/custom_path_integrals.py)
VoltageIntegralAxisAligned.plot() (in tidy3d/plugins/microwave/path_integrals.py)
CurrentIntegralAxisAligned.plot() (in tidy3d/plugins/microwave/path_integrals.py)
RectangularDielectric.plot_geometry_edges() (in tidy3d/plugins/waveguide/rectangular_dielectric.py)

All of those functions are untested (visually with transpose=True).
Also:

Scene.plot_structure_property() function has been tested (in components/scene.py). But in some scenarios, it will invoke _pcolormesh_shape_custom_medium_structure_eps() (listed above). So those scenarios need to be tested.

You may want to remove those changes from this PR and move them into a followup PR.

jewettaij · 2025-07-27T20:51:11Z

tidy3d/plugins/smatrix/component_modelers/modal.py

@@ -244,7 +246,7 @@ def plot_sim_eps(
            mode_source_0 = self.to_source(port=port_source, mode_index=0)
            plot_sources.append(mode_source_0)
        sim_plot = self.simulation.copy(update={"sources": plot_sources})
-        return sim_plot.plot_eps(x=x, y=y, z=z, ax=ax, **kwargs)
+        return sim_plot.plot_eps(x=x, y=y, z=z, ax=ax, transpose=transpose, **kwargs)



I visually verified that the plot_eps() function works with transpose=True using the VizSimulation.ipynb notebook example.

jewettaij · 2025-07-27T20:52:18Z

tidy3d/plugins/smatrix/component_modelers/modal.py

@@ -217,6 +217,7 @@ def plot_sim(
        y: Optional[float] = None,
        z: Optional[float] = None,
        ax: Ax = None,
+        transpose: bool = False,


I visually verified that plot_sim() function works with transpose=True using the SMatrix.ipynb notebook example.

jewettaij · 2025-07-27T21:03:42Z

tidy3d/plugins/waveguide/rectangular_dielectric.py

+            warn_untested_argument(
+                cls_name=type(self).__name__, func_name="plot", arg="transpose", val="True"
+            )
+


This function has not yet been tested with transpose=True visually. I suggest moving changes to this function out of this PR.

jewettaij · 2025-07-27T21:09:00Z

tidy3d/plugins/waveguide/rectangular_dielectric.py

@@ -989,6 +1005,7 @@ def plot_structures_eps(
            cbar=cbar,
            reverse=reverse,
            ax=ax,
+            transpose=transpose,


If my memory is correct, Scene.plot_structures_eps() (invoked by this function) was tested visually (with transpose=True) using the ThermallyTunedRingResonator.ipynb notebook example.
You might want to verify it again, however.

jewettaij · 2025-07-28T02:09:58Z

tidy3d/plugins/microwave/custom_path_integrals.py

+            # Please remove this warning once someone has verified that `transpose=True` works.
+            warn_untested_argument(
+                cls_name=type(self).__name__, func_name="plot", arg="transpose", val="True"
+            )


Untested code!
The changes I made to this file should be moved into a different PR which can be tested separately.

I added this warning because I honestly can't remember if I tested the plot functions in this plugin with transpose=True.

Try running the cells in the CharacteristicImpedanceCalculator.ipynb (with transpose=True) to see if they work as expected.

jewettaij · 2025-07-28T02:10:42Z

tidy3d/plugins/microwave/path_integrals.py

+            warn_untested_argument(
+                cls_name=type(self).__name__, func_name="plot", arg="transpose", val="True"
+            )
+


Untested code!
The changes I made to this file should be moved into a different PR which can be tested separately.

I added this warning because I honestly can't remember if I tested the plot functions in this plugin with transpose=True. (See previous comment.)

jewettaij · 2025-07-28T02:12:40Z

tidy3d/plugins/microwave/custom_path_integrals.py

+            # Please remove this warning once someone has verified that `transpose=True` works.
+            warn_untested_argument(
+                cls_name=type(self).__name__, func_name="plot", arg="transpose", val="True"
+            )


Untested code!
The changes I made to this file should be moved into a different PR which can be tested separately.

I added this warning because I honestly can't remember if I tested the plot functions in this plugin with transpose=True. (See previous comment.)

jewettaij · 2025-07-28T02:13:23Z

tidy3d/plugins/microwave/path_integrals.py

+            warn_untested_argument(
+                cls_name=type(self).__name__, func_name="plot", arg="transpose", val="True"
+            )
+


See comment above.

jewettaij · 2025-07-28T02:21:20Z

tidy3d/components/eme/simulation.py

@@ -306,6 +307,7 @@ def plot_eme_ports(
        ax: Ax = None,
        hlim: Optional[tuple[float, float]] = None,
        vlim: Optional[tuple[float, float]] = None,
+        transpose: bool = False,


Untested!
I could not find an example from tidy3d-notebooks which tests this function.

The changes to this function should be moved to a different PR.

Incidentally, I did run the EMEBends.ipynb and EMESolver.ipynb examples with transpose=True, but I don't think it tests the functions in this file.

jewettaij · 2025-07-28T02:22:11Z

tidy3d/components/eme/simulation.py

@@ -350,6 +363,7 @@ def plot_eme_subgrid_boundaries(
        ax: Ax = None,
        hlim: Optional[tuple[float, float]] = None,
        vlim: Optional[tuple[float, float]] = None,
+        transpose: bool = False,


Untested!
I could not find an example from tidy3d-notebooks which tests this function.

The changes to this file should be moved to a different PR.

jewettaij · 2025-07-28T02:31:48Z

tidy3d/components/eme/simulation.py

@@ -402,22 +435,27 @@ def plot_eme_grid(
        ax: Ax = None,
        hlim: Optional[tuple[float, float]] = None,
        vlim: Optional[tuple[float, float]] = None,
+        transpose: bool = False,


Untested!
I could not find an example from tidy3d-notebooks which tests this function.

The changes to this file should be moved to a different PR.

jewettaij · 2025-07-28T02:32:38Z

tidy3d/components/eme/simulation.py

@@ -445,6 +490,7 @@ def plot(
        monitor_alpha: Optional[float] = None,
        hlim: Optional[tuple[float, float]] = None,
        vlim: Optional[tuple[float, float]] = None,
+        transpose: bool = False,


Untested!
I could not find an example from tidy3d-notebooks which tests this function.

The changes to this file should be moved to a different PR.

jewettaij · 2025-07-28T03:55:47Z

tidy3d/components/scene.py

+                arg="transpose",
+                val="True",
+            )
+


Untested code!

As mentioned earlier:

I could not find an example in tidy3d-notebooks which tests _pcolormesh_shape_custom_medium_structure_eps(), so I had no way to visually confirm that this function is working (when transpose=True).

For comparison, _pcolormesh_shape_doping_box() has been tested (visually) using one of the tidy3d-notebook examples.

Perhaps the changes I made to this function should be moved into a different PR which can be tested separately. (See comment above.)

jewettaij · 2025-07-28T04:05:06Z

tidy3d/components/scene.py

+                        ax,
+                        property,
+                        transpose=transpose,
+                        transpose_shape=False,  # We took care of transposing the shape earlier.


I can confirm that the function behaves correctly when it reaches this line and invokes _pcolormesh_shape_doping_box().

jewettaij · 2025-07-28T04:06:33Z

tidy3d/components/scene.py

@@ -993,10 +1084,22 @@ def plot_structures_property(
                        shape=shape,
                        ax=ax,
                        property="doping",
+                        # Note: I omitted `transpose` because we took care of that earlier.


I can confirm that the function behaves correctly when it reaches this line and invokes _plot_shape_structure_heat_charge_property().

jewettaij · 2025-07-28T05:00:09Z

tidy3d/components/mode/data/sim_data.py

@@ -50,6 +50,7 @@ def plot_field(
        vmin: Optional[float] = None,
        vmax: Optional[float] = None,
        ax: Ax = None,
+        transpose: bool = False,


The basic plot_field() function works and has been tested in at least 20 different examples from tidy3d-notebooks. (I cannot remember their names.)

jewettaij · 2025-07-28T05:11:12Z

tidy3d/components/scene.py

+    shape_swap_xy,
+    unpop_axis_and_swap,
+    warn_untested_argument,
+)


This file contains untested code

Almost all of the changes I made to scene.py have been tested visually, by running over 150 examples from tidy3d-notebooks, and adding the transpose=True argument to the various plot functions. All of them are working (when transpose=True), including:

VizSimulation.ipynb,

ChargeSolver.ipynb,

MachZehnderModulator.ipynb,

HeatSolver.ipynb,

HeatDissipationSOI.ipynb

However the Scene.plot_structures_property() function is huge and has a lot of conditional branching. One of those conditional branches was never reachable by any of the tidy3d-notebook examples I tried.

(See the comment I left below next to the _pcolormesh_shape_custom_medium_structure_eps() function for details.)

So you may wish to postpone this PR until that condition has been tested. (I am sorry I did not do this before I left.)

jewettaij · 2025-07-28T05:15:53Z

tidy3d/components/scene.py

@@ -1031,6 +1135,8 @@ def plot_structures_property(
                        ax,
                        grid,
                        eps_component=eps_component,
+                        transpose=transpose,
+                        transpose_shape=False,  # We took care of transposing the "shape" earlier.


Untested code!
As I mentioned earlier, I have not found an example which invokes plot_structures_property() in a way which tests this particular condition. (I tried 150 examples from tidy3d-notebooks.

The other conditions have tested and are working.

Perhaps the changes to this function could be postponed to another PR until this is tested).

Alternatively, perhaps this plot_structures_property() function needs to be cleaned up. It is really complicated and messy.

jewettaij · 2025-07-28T05:37:13Z

tidy3d/plugins/adjoint/components/simulation.py

@@ -539,6 +539,7 @@ def plot(
        monitor_alpha: Optional[float] = None,
        hlim: Optional[tuple[float, float]] = None,
        vlim: Optional[tuple[float, float]] = None,
+        transpose: bool = False,


I visually verified transpose=True works in all of the Adjoint examples from tidy3d-notebooks.

jewettaij · 2025-07-28T05:44:13Z

tidy3d/components/tcad/simulation/heat_charge.py

@@ -81,6 +81,7 @@
    plot_params_heat_source,
 )
 from tidy3d.components.types import TYPE_TAG_STR, Ax, Bound, ScalarSymmetry, Shapely, annotate_type
+from tidy3d.components.utils import shape_swap_xy


You can test the changes in these heat.py and heat_charge.py files by verifying that following tidy3d-notebook examples work with transpose=True:

HeatSolver.ipynb,

HeatDissipationSOI.ipynb

ThermallyTunedRingResonator.ipynb

MachZehnderModulator.ipynb,

ChargeSolver.ipynb

I visually verified that these examples work with transpose=True.

jewettaij · 2025-07-28T05:49:32Z

tidy3d/components/grid/grid.py

@@ -74,7 +74,8 @@ def cell_sizes(self) -> SpatialDataArray:
    @cached_property
    def cell_size_meshgrid(self):
        """Returns an N-dimensional grid where N is the number of coordinate arrays that have more than one
-        element. Each grid element corresponds to the size of the mesh cell in N-dimensions and 1 for N=0."""
+        element. Each grid element corresponds to the size of the mesh cell in N-dimensions and 1 for N=0.
+        """


This change was accidental.

jewettaij · 2025-07-28T05:57:01Z

tidy3d/components/mode/mode_solver.py

@@ -55,6 +55,7 @@
    PlotScale,
    Symmetry,
 )
+from tidy3d.components.utils import pop_axis_and_swap


Changes to the files in the mode/ folder were tested by visually confirming that transpose=True in the following tidy3d-notebook examples:

ModeSolver.ipynb

ModalSourcesMonitors.ipynb

MoS2Waveguide.ipynb

ThermallyTunedRingResonator.ipynb

jewettaij · 2025-07-28T06:08:56Z

tidy3d/components/monitor.py

@@ -358,12 +358,13 @@ def plot(
        y: Optional[float] = None,
        z: Optional[float] = None,
        ax: Ax = None,
+        transpose: bool = False,


I verified that the changes in this file work by verifying transpose=True works in VizSimulation.ipynb (and many other tidy3d-notebook examples).

jewettaij · 2025-07-28T06:09:28Z

tidy3d/components/source/base.py

@@ -74,14 +74,15 @@ def plot(
        y: Optional[float] = None,
        z: Optional[float] = None,
        ax: Ax = None,
+        transpose: bool = False,


I verified that the changes in this file work by verifying transpose=True works in VizSimulation.ipynb (and many other tidy3d-notebook examples).

jewettaij · 2025-07-28T06:09:46Z

tidy3d/components/source/field.py

        **patch_kwargs,
    ) -> Ax:
        # call Source.plot but with the base of the arrow centered on the injection plane
        patch_kwargs["arrow_base"] = self.injection_plane_center
-        ax = Source.plot(self, x=x, y=y, z=z, ax=ax, **patch_kwargs)
+        ax = Source.plot(self, x=x, y=y, z=z, ax=ax, transpose=transpose, **patch_kwargs)


Untested code!

After releasing this PR, I realize that I never got around to testing this function. But you can! Here are the relevant examples from tidy3d-notebooks:

TFSF.ipynb

90BendPolarizationSplitterRotator.ipynb

Try running the plot functions in these examples with the transpose=True argument and check visually that the horizontal and vertical axes are swapped.

jewettaij · 2025-07-28T06:10:33Z

tidy3d/components/tcad/bandgap.py

@@ -35,7 +35,8 @@ class SlotboomBandGapNarrowing(Tidy3dBaseModel):
            ...    min_N=1e15,
            ... )

-        .. [1] 'UNIFIED APPARENT BANDGAP NARROWING IN n- AND p-TYPE SILICON' Solid-State Electronics Vol. 35, No. 2, pp. 125-129, 1992"""
+        .. [1] 'UNIFIED APPARENT BANDGAP NARROWING IN n- AND p-TYPE SILICON' Solid-State Electronics Vol. 35, No. 2, pp. 125-129, 1992


This change was accidental.

This comment was marked as resolved.

Sign in to view

tylerflex reviewed Jun 5, 2025

View reviewed changes

tidy3d/components/geometry/base.py Outdated Show resolved Hide resolved

jewettaijfc mentioned this pull request Jun 5, 2025

XY transposable sim.plot() plots (issue1072) #2537

Closed

This comment was marked as resolved.

Sign in to view

jewettaijfc changed the title ~~Jewettaijfc/issue1072 v2~~ XY transposable sim.plot() plots (issue1072) VERSION 2 Jun 6, 2025

This comment was marked as resolved.

Sign in to view

jewettaijfc self-assigned this Jun 8, 2025

This comment was marked as resolved.

Sign in to view

tylerflex reviewed Jun 9, 2025

View reviewed changes

tidy3d/components/geometry/polyslab.py Outdated Show resolved Hide resolved

tylerflex reviewed Jun 9, 2025

View reviewed changes

tidy3d/components/geometry/polyslab.py Outdated Show resolved Hide resolved

tylerflex reviewed Jun 9, 2025

View reviewed changes

tidy3d/components/tcad/data/sim_data.py Outdated Show resolved Hide resolved

jewettaijfc force-pushed the jewettaijfc/issue1072_v2 branch from 2f38175 to de2d14d Compare June 9, 2025 15:29

This comment was marked as resolved.

Sign in to view

jewettaijfc force-pushed the jewettaijfc/issue1072_v2 branch from 2510f60 to f0995ca Compare June 10, 2025 18:32

This comment was marked as resolved.

Sign in to view

jewettaijfc marked this pull request as ready for review June 11, 2025 04:10

greptile-apps bot reviewed Jun 11, 2025

View reviewed changes

tests/test_components/test_source.py Outdated Show resolved Hide resolved

tidy3d/components/geometry/polyslab.py Outdated Show resolved Hide resolved

tidy3d/components/base_sim/simulation.py Show resolved Hide resolved

This comment was marked as outdated.

Sign in to view

tylerflex requested changes Jun 11, 2025

View reviewed changes

yaugenst-flex self-requested a review June 12, 2025 07:26

yaugenst-flex linked an issue Jun 12, 2025 that may be closed by this pull request

Add option to transpose plot #1072

Open

12 tasks

jewettaijfc force-pushed the jewettaijfc/issue1072_v2 branch from 8e2434a to f9b57ba Compare June 12, 2025 18:46

jewettaij reviewed Jul 25, 2025

View reviewed changes

jewettaij reviewed Jul 27, 2025

View reviewed changes

jewettaij reviewed Jul 28, 2025

View reviewed changes

		# only then overlay the mesh plot
		field_data.plot(ax=ax, cmap=False, field=False, grid=True)

XY transposable plots V3 part 2: Updated all remaining plot functions (issue1072) #2544

Are you sure you want to change the base?

XY transposable plots V3 part 2: Updated all remaining plot functions (issue1072) #2544

Uh oh!

Conversation

jewettaijfc commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer instructions

Automatic Tests

Manual Tests

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

Uh oh!

Uh oh!

Uh oh!

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

greptile-apps bot left a comment

Choose a reason for hiding this comment

PR Summary

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment was marked as outdated.

tylerflex left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jewettaijfc commented Jul 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jewettaij Jul 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jewettaij Jul 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Of all the functions I modified for this PR, plot_mesh() is the function I have the most concerns about.

Uh oh!

jewettaij commented Jul 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

SUMMARY

Uh oh!

jewettaij Jul 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jewettaij Jul 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jewettaij Jul 27, 2025

Choose a reason for hiding this comment

Uh oh!

jewettaij Jul 27, 2025

Choose a reason for hiding this comment

Uh oh!

jewettaij Jul 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

jewettaijfc commented Jun 5, 2025 •

edited

Loading

jewettaijfc commented Jul 23, 2025 •

edited

Loading

jewettaij Jul 25, 2025 •

edited

Loading

jewettaij Jul 25, 2025 •

edited

Loading

Of all the functions I modified for this PR, `plot_mesh()` is the function I have the most concerns about.

jewettaij commented Jul 25, 2025 •

edited

Loading

jewettaij Jul 27, 2025 •

edited

Loading

jewettaij Jul 27, 2025 •

edited

Loading

jewettaij Jul 28, 2025 •

edited

Loading

jewettaij Jul 28, 2025 •

edited

Loading

jewettaij Jul 28, 2025 •

edited

Loading

jewettaij Jul 28, 2025 •

edited

Loading

jewettaij Jul 28, 2025 •

edited

Loading

jewettaij Jul 28, 2025 •

edited

Loading

jewettaij Jul 28, 2025 •

edited

Loading

jewettaij Jul 28, 2025 •

edited

Loading

jewettaij Jul 28, 2025 •

edited

Loading

jewettaij Jul 28, 2025 •

edited

Loading

jewettaij Jul 28, 2025 •

edited

Loading

jewettaij Jul 28, 2025 •

edited

Loading

jewettaij Jul 28, 2025 •

edited

Loading

jewettaij Jul 28, 2025 •

edited

Loading